h1. {anchor:ACFFM} commadmin group modify
The {{commadmin group modify}} command changes the attributes of a single group that already exists in the LDAP directory. To change the attributes of multiple groups, use the {{-i}} option.
A mailing list is one type of group. When a message is sent to the group address, Messaging Server sends the message to all members in the group.
h2. {anchor:ACFFN} Syntax
{panel}
{{commadmin group modify –D _login_ –G _groupname_ –n _domain_ –w _password_}}
{{ [–A [+|–]_attributename_:_value_] [–d _domain_] [–f [_action_]_ldap–filter_] [–h] [–?]}}
{{ [–i _inputfile_] [–m [+|–]_internal–member_] [–p _AM port_] [–s] [–v] [–V] [–X _AM host_]}}
{{ [–S mail [–o _owner_] [–E _email_] [–H _mailhost_] [–M _external–member_] [–r _moderator_]}}
{{ [–a true|false ] [–b true|false ] [–c _group id_]}}
{{ [–j _DWPHost_] [–q _secondary owner_] [–t _time zone_]}}
{panel}
h2. {anchor:ACFFO} Options
The following are mandatory options:
||Option ||Description ||
|{{-D}} _login_|The user ID of the user with permission to execute this command.|
|{{-G}} _groupname_|The name of the group to be modified. For example, {{mktg-list}}.|
|{{-n}} _domain_|The domain of the user specified by the {{-D}} option.|
|{{-w}} _password_|The password of the user specified by the {{-D}} option.|
The following are non-mandatory options:
||Option ||Description ||
|{{–A}} [+\|-]_attributename_:_value_|An attribute to modify. The _attributename_ is defined in the LDAP schema and value replaces any and all current values for this attribute in the directory. Repeat this option to modify multiple attributes at the same time, or to specify multiple values for the same attribute.\\
A “+” before the _attributename_ indicates adding the value to the current list of attributes.\\
A “-” indicates removing the value.\\
If the “-” is used, it must be preceded by two backslashes or enclosed in quotes if the command is specified on the command line.\\
If the option is provided within an input file, one backslash must precede the “-” sign.|
|{{-d}} _domain_|The domain of the group. If {{-d}} is not specified, the domain specified by the {{-n}} option is used.|
|{{-}} {{f}} \[_action_\] _ldap-filter_|Indicates whether a ldap filter is added to or removed from the group\\
\\A “+” before the _ldap-filter_ indicates that it is to be added to the existing filters.\\
A “-” indicates removing the existing filter.\\
Type {{–f–*}} to remove all the filters.\\
If the “-” is used, it must be preceded by two backslashes or enclosed in quotes if the command is specified on the command line.\\
If _action_ is not specified, by default the filter is added provided it is not already present. Otherwise an error message is displayed.\\
\\The LDAP filter should define members within the group's organization. Even if the LDAP filter specifies another organization, this value defaults to the group's organization. This constraint prevents members who belong to an outside organization from being added to the group.|
|{{-h}}, {{–?}}|Prints command usage syntax.|
|{{-i}} _inputfile_|Reads the command information from a file instead of the command line.\\
\\An option value specified in the input file overrides any value for the same option set in the command line.|
|{{-m}} \[_action_\] _internal-member_|Indicates whether to add or remove an internal member.\\
\\An _action_ value of:\\
\\+ adds the member to an existing list of internal members.\\
\\- removes the member from an existing list of internal members. If the “-” is used, it must be preceded by two backslashes or enclosed in quotes if the command is specified on the command line.\\
\\The value of _internal_–_member_ is either a mail: address or user ID.\\
\\ {{–m–*}} removes all the internal members.|
|{{-p}} _AM port_|Specifies an alternate TCP port where the Access Manager is listening. If not specified, the default _AM port_ is used, or Port 80 is used if no default was configured at install time.|
|{{-s}}|Use SSL (Secure Socket Layer) to connect to the Access Manager.|
|{{-v}}|Enable debugging output.|
|{{-V}}|Prints information about the utility and its version.|
|{{-X}} _AM host_|Specifies the host on which the Access Manager is running. If not specified, the default _AM host_ is used, or the local host if no default was configured at install time.|
|{{-S}} _service_|Specifies the services to be added to the group during modification. Before a service is added, Delegated Administrator validates whether the service already exists. If the service exists, an error message is displayed.\\
\\ _service_ can have the value of a single service or multiple services. The valid service values are mail and cal. These values are case-insensitive.\\
\\The list of services is separated by the comma (,) delimiter.\\
\\For Example:\\
\\ {{-S mail,cal}}|
If the {{-S mail}} option is specified, the following options are allowed:
||Option ||Description ||
|{{-o}} _owner_|The group owner's email address. An owner is the individual responsible for the distribution list.\\
\\(This option is also allowed, and is mandatory, when the {{-S cal}} option is specified.)|
|{{-E}} _email_|The email address of the group. (This option is also allowed when the {{-S cal}} option is specified.)|
|{{-H}} _mailhost_|The mail host to which this group responds (for example, {{mailhost.varrius.com}}). The default is the local mail host.|
|{{-M}} _external-member_|Adds an external member to this group. The value of _external-member_ is the user email address. To add more than one member, use multiple {{-M}} options.|
|{{-r}} _moderator_|The moderator’s email address.|
If the {{-S cal}} option is specified, the following option is mandatory:
||Option ||Description ||
|{{-o}} _owner_|The group owner's email address. An owner is the individual responsible for the Calendar group's distribution list.\\
\\The group owner must have Calendar service.\\
\\(This option is also allowed when the {{-S mail}} option is specified.)|
If the {{-S cal}} option is specified, the following non-mandatory options are allowed:
||Option ||Description ||
|{{-a true\|false}}|Allows or disallows calendar appointments to be accepted automatically.\\
\\ {{true}} enables automatic acceptance of appointments.\\
\\ {{false}} disables automatic acceptance of appointments. |
|{{-b true\|false}}|Allows or disallows calendar appointments to be double-booked, permitting more than one appointment at the same time.\\
\\ {{true}} enables double-booking of appointments.\\
\\ {{false}} disables double-booking of appointments. |
|{{-c}} _group id_|Specifies a group ID for the Calendar group. If this option is not specified, Delegated Administrator automatically supplies a group ID.|
|{{-E}} _email_|The email address of the group. This address is used to notify group members of Calendar events.\\
(This option is also allowed when the {{-S cal}} option is specified.)|
|{{-j}} _DWPHost_|The DNS name of the back-end calendar server which hosts this Calendar group's calendar. This host is the Database Wire Protocol (DWP) server that stores the calendar and its data.\\
\\If the DNS name of the back-end calendar server is not specified, the value stored in the {{ics.conf}}file of the server is used as the default value.|
|{{-q}} _secondary owner_|The secondary owner's email address. A secondary owner can manage the Calendar group's distribution list. \\
\\To add more than one secondary owner, use multiple {{-q}} _secondary owner_ options.\\
\\All secondary owners must have Calendar service.|
|{{-t}} _time zone_|The time zone used to display the Calendar group's calendar in the calendar’s user interface.\\
\\See [Calendar Time Zone Strings FIX|Calendar+Time+Zone+Strings#ACFIB] for a list of the valid time zone strings.|
h2. {anchor:ACFFP} Examples
To remove an internal member ({{jsmith}}) from the group {{testgroup}} within the domain {{varrius.com:}}
{panel}
{{commadmin group modify –D chris –d varrius.com –G testgroup –n sesta.com \}}
{{–w bolton –m \\–jsmith}}
{panel}
To add Calendar service to the group {{testgroup}} within the domain {{varrius.com:}}
{panel}
{{commadmin group modify –D chris –d varrius.com –G testgroup –n sesta.com \}}
{{–w bolton –S cal –o achiko@varrius.com –c calgroup1}}
{panel}
The {{commadmin group modify}} command changes the attributes of a single group that already exists in the LDAP directory. To change the attributes of multiple groups, use the {{-i}} option.
A mailing list is one type of group. When a message is sent to the group address, Messaging Server sends the message to all members in the group.
h2. {anchor:ACFFN} Syntax
{panel}
{{commadmin group modify –D _login_ –G _groupname_ –n _domain_ –w _password_}}
{{ [–A [+|–]_attributename_:_value_] [–d _domain_] [–f [_action_]_ldap–filter_] [–h] [–?]}}
{{ [–i _inputfile_] [–m [+|–]_internal–member_] [–p _AM port_] [–s] [–v] [–V] [–X _AM host_]}}
{{ [–S mail [–o _owner_] [–E _email_] [–H _mailhost_] [–M _external–member_] [–r _moderator_]}}
{{ [–a true|false ] [–b true|false ] [–c _group id_]}}
{{ [–j _DWPHost_] [–q _secondary owner_] [–t _time zone_]}}
{panel}
h2. {anchor:ACFFO} Options
The following are mandatory options:
||Option ||Description ||
|{{-D}} _login_|The user ID of the user with permission to execute this command.|
|{{-G}} _groupname_|The name of the group to be modified. For example, {{mktg-list}}.|
|{{-n}} _domain_|The domain of the user specified by the {{-D}} option.|
|{{-w}} _password_|The password of the user specified by the {{-D}} option.|
The following are non-mandatory options:
||Option ||Description ||
|{{–A}} [+\|-]_attributename_:_value_|An attribute to modify. The _attributename_ is defined in the LDAP schema and value replaces any and all current values for this attribute in the directory. Repeat this option to modify multiple attributes at the same time, or to specify multiple values for the same attribute.\\
A “+” before the _attributename_ indicates adding the value to the current list of attributes.\\
A “-” indicates removing the value.\\
If the “-” is used, it must be preceded by two backslashes or enclosed in quotes if the command is specified on the command line.\\
If the option is provided within an input file, one backslash must precede the “-” sign.|
|{{-d}} _domain_|The domain of the group. If {{-d}} is not specified, the domain specified by the {{-n}} option is used.|
|{{-}} {{f}} \[_action_\] _ldap-filter_|Indicates whether a ldap filter is added to or removed from the group\\
\\A “+” before the _ldap-filter_ indicates that it is to be added to the existing filters.\\
A “-” indicates removing the existing filter.\\
Type {{–f–*}} to remove all the filters.\\
If the “-” is used, it must be preceded by two backslashes or enclosed in quotes if the command is specified on the command line.\\
If _action_ is not specified, by default the filter is added provided it is not already present. Otherwise an error message is displayed.\\
\\The LDAP filter should define members within the group's organization. Even if the LDAP filter specifies another organization, this value defaults to the group's organization. This constraint prevents members who belong to an outside organization from being added to the group.|
|{{-h}}, {{–?}}|Prints command usage syntax.|
|{{-i}} _inputfile_|Reads the command information from a file instead of the command line.\\
\\An option value specified in the input file overrides any value for the same option set in the command line.|
|{{-m}} \[_action_\] _internal-member_|Indicates whether to add or remove an internal member.\\
\\An _action_ value of:\\
\\+ adds the member to an existing list of internal members.\\
\\- removes the member from an existing list of internal members. If the “-” is used, it must be preceded by two backslashes or enclosed in quotes if the command is specified on the command line.\\
\\The value of _internal_–_member_ is either a mail: address or user ID.\\
\\ {{–m–*}} removes all the internal members.|
|{{-p}} _AM port_|Specifies an alternate TCP port where the Access Manager is listening. If not specified, the default _AM port_ is used, or Port 80 is used if no default was configured at install time.|
|{{-s}}|Use SSL (Secure Socket Layer) to connect to the Access Manager.|
|{{-v}}|Enable debugging output.|
|{{-V}}|Prints information about the utility and its version.|
|{{-X}} _AM host_|Specifies the host on which the Access Manager is running. If not specified, the default _AM host_ is used, or the local host if no default was configured at install time.|
|{{-S}} _service_|Specifies the services to be added to the group during modification. Before a service is added, Delegated Administrator validates whether the service already exists. If the service exists, an error message is displayed.\\
\\ _service_ can have the value of a single service or multiple services. The valid service values are mail and cal. These values are case-insensitive.\\
\\The list of services is separated by the comma (,) delimiter.\\
\\For Example:\\
\\ {{-S mail,cal}}|
If the {{-S mail}} option is specified, the following options are allowed:
||Option ||Description ||
|{{-o}} _owner_|The group owner's email address. An owner is the individual responsible for the distribution list.\\
\\(This option is also allowed, and is mandatory, when the {{-S cal}} option is specified.)|
|{{-E}} _email_|The email address of the group. (This option is also allowed when the {{-S cal}} option is specified.)|
|{{-H}} _mailhost_|The mail host to which this group responds (for example, {{mailhost.varrius.com}}). The default is the local mail host.|
|{{-M}} _external-member_|Adds an external member to this group. The value of _external-member_ is the user email address. To add more than one member, use multiple {{-M}} options.|
|{{-r}} _moderator_|The moderator’s email address.|
If the {{-S cal}} option is specified, the following option is mandatory:
||Option ||Description ||
|{{-o}} _owner_|The group owner's email address. An owner is the individual responsible for the Calendar group's distribution list.\\
\\The group owner must have Calendar service.\\
\\(This option is also allowed when the {{-S mail}} option is specified.)|
If the {{-S cal}} option is specified, the following non-mandatory options are allowed:
||Option ||Description ||
|{{-a true\|false}}|Allows or disallows calendar appointments to be accepted automatically.\\
\\ {{true}} enables automatic acceptance of appointments.\\
\\ {{false}} disables automatic acceptance of appointments. |
|{{-b true\|false}}|Allows or disallows calendar appointments to be double-booked, permitting more than one appointment at the same time.\\
\\ {{true}} enables double-booking of appointments.\\
\\ {{false}} disables double-booking of appointments. |
|{{-c}} _group id_|Specifies a group ID for the Calendar group. If this option is not specified, Delegated Administrator automatically supplies a group ID.|
|{{-E}} _email_|The email address of the group. This address is used to notify group members of Calendar events.\\
(This option is also allowed when the {{-S cal}} option is specified.)|
|{{-j}} _DWPHost_|The DNS name of the back-end calendar server which hosts this Calendar group's calendar. This host is the Database Wire Protocol (DWP) server that stores the calendar and its data.\\
\\If the DNS name of the back-end calendar server is not specified, the value stored in the {{ics.conf}}file of the server is used as the default value.|
|{{-q}} _secondary owner_|The secondary owner's email address. A secondary owner can manage the Calendar group's distribution list. \\
\\To add more than one secondary owner, use multiple {{-q}} _secondary owner_ options.\\
\\All secondary owners must have Calendar service.|
|{{-t}} _time zone_|The time zone used to display the Calendar group's calendar in the calendar’s user interface.\\
\\See [Calendar Time Zone Strings FIX|Calendar+Time+Zone+Strings#ACFIB] for a list of the valid time zone strings.|
h2. {anchor:ACFFP} Examples
To remove an internal member ({{jsmith}}) from the group {{testgroup}} within the domain {{varrius.com:}}
{panel}
{{commadmin group modify –D chris –d varrius.com –G testgroup –n sesta.com \}}
{{–w bolton –m \\–jsmith}}
{panel}
To add Calendar service to the group {{testgroup}} within the domain {{varrius.com:}}
{panel}
{{commadmin group modify –D chris –d varrius.com –G testgroup –n sesta.com \}}
{{–w bolton –S cal –o achiko@varrius.com –c calgroup1}}
{panel}