{anchor:acfgt}
h1. commadmin user modify
The {{commadmin user modify}} command modifies attributes of a single user's directory entry. To modify multiple user, use the {{-i}} option.
{anchor:acfgu}
h2. Syntax
{noformat}
commadmin user modify -D <login> -n <domain> -l <userid> -w <password>
[-A [+|-]<attributename>:<value>] [-d <domain>] [-h] [-?] [-i <inputfile>] [-p <AM port>]
[-s] [-v] [-V] [-X <AM host>]
[-S mail -H <mailhost> [-E <email>]]
[-S cal [-B <DWPHost>] [-E <email>] [-k <calid_type>] [-J <First Day of Week>] [-T <time zone>]]
[-S im]
{noformat}
{anchor:acfgv}
h2. Options
The following options are mandatory:
||Option ||Description ||
|{{-D}} _login_ |The user ID of the user with permission to execute this command. |
|{{-n}} _domain_ |Domain of the user specified with the {{-D}} option. |
|{{-w}} _password_ |The password of user specified with the {{-D}} option. |
|{{-l}} _userid_ |User’s login ID. |
The following options are non-mandatory:
||Option ||Description ||
|{{-A}} [+ _or_ -]_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. You can 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 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_ |Domain of the user or group. If {{-d}} is not specified, the domain specified by {{-n}} is used. |
|{{-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. |
|{{-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 localhost if no default was configured at install time. |
|{{-S}} _service_ |Adds the specified services to the user after validating whether the user has the service specified with {{-S}} option. If the user already has the service an error message is displayed.\\
_services_ can have the value of a single service or multiple services. The valid _service_ values are {{mail}}, {{cal}}, and {{im}}_._ These values are case-insensitive.\\
The list of services is separated by the comma (,) delimiter.\\
For example:\\
{{-S mail,cal,im}} |
|The following options are only allowed if the {{-S}} {{mail}} option is specified: | |
|{{-E}} _email_ |Specifies the email address of the user. |
|{{-H}} _mailhost_ |The mail host of the user.This option is mandatory if the {{-S mail}} option is specified. |
|The following options are only allowed if the {{-S cal}} option is specified: | |
|{{-B}} _DWPHost_ |Specifies the DNS name of the backend calendar server that hosts this user’s calendars.Note: This attribute can only be added and cannot be modified if it already exists. |
|{{-E}} _email_ |Specifies the email address for the calendar user. |
|{{-J}} _First Day of Week_ |The first day of the week shown when the calendar is displayed in the calendar server user interface. The valid values are 0-6 (0 is Sunday, 1 is Monday, and so on). |
|{{-k}} _calid_type_ |Specifies the type of calendar id that is created (when adding the calendar service). The accepted values are {{legacy}} and {{hosted}}. If {{-k legacy}} is specified, only the calendar id is used (for example, {{jsmith}}). If {{-k hosted}} is specified, the calendar id plus domain is used (for example, {{jsmith@sesta.com}}).\\
If the {{-k}} option is not specified, the default is to use the calendar id plus domain ({{hosted}}).\\
You can set the value of the calendar id type that is created if the {{-k}} option is not specified. To do so, add the following parameter to the {{resource.properties}} file: \\
{{switch-caltype=}}_value_ \\
where _value_ is “{{hosted}}” or “{{legacy}}”.\\
The {{resource.properties}} file is located in the following directory:\\
{{_da-base_/data/WEB-INF/classes/sun/comm/cli/server/servlet/resource.properties}} |
|{{-T}} _time zone_ |The time zone in which the user's calendar is displayed. See [Calendar Time Zone Strings|Attribute Values and Calendar Time Zones#ACFIB] for a list of the valid time zone strings. |
{anchor:acfgw}
h2. Examples
The following example adds a mail service for the user {{smith}}:
{code}
commadmin user modify -D chris -n sesta.com -w bolton -l smith \
-A description:"new description" -S mail -H mailhost.siroe.com
{code}
In this example, a mail forwarding address is added for user {{smith}}:
{code}
commadmin user modify -D chris -n sesta.com -w bolton -l smith \
-A +mailforwardingaddress:tsmith@siroe.com
{code}
h1. commadmin user modify
The {{commadmin user modify}} command modifies attributes of a single user's directory entry. To modify multiple user, use the {{-i}} option.
{anchor:acfgu}
h2. Syntax
{noformat}
commadmin user modify -D <login> -n <domain> -l <userid> -w <password>
[-A [+|-]<attributename>:<value>] [-d <domain>] [-h] [-?] [-i <inputfile>] [-p <AM port>]
[-s] [-v] [-V] [-X <AM host>]
[-S mail -H <mailhost> [-E <email>]]
[-S cal [-B <DWPHost>] [-E <email>] [-k <calid_type>] [-J <First Day of Week>] [-T <time zone>]]
[-S im]
{noformat}
{anchor:acfgv}
h2. Options
The following options are mandatory:
||Option ||Description ||
|{{-D}} _login_ |The user ID of the user with permission to execute this command. |
|{{-n}} _domain_ |Domain of the user specified with the {{-D}} option. |
|{{-w}} _password_ |The password of user specified with the {{-D}} option. |
|{{-l}} _userid_ |User’s login ID. |
The following options are non-mandatory:
||Option ||Description ||
|{{-A}} [+ _or_ -]_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. You can 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 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_ |Domain of the user or group. If {{-d}} is not specified, the domain specified by {{-n}} is used. |
|{{-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. |
|{{-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 localhost if no default was configured at install time. |
|{{-S}} _service_ |Adds the specified services to the user after validating whether the user has the service specified with {{-S}} option. If the user already has the service an error message is displayed.\\
_services_ can have the value of a single service or multiple services. The valid _service_ values are {{mail}}, {{cal}}, and {{im}}_._ These values are case-insensitive.\\
The list of services is separated by the comma (,) delimiter.\\
For example:\\
{{-S mail,cal,im}} |
|The following options are only allowed if the {{-S}} {{mail}} option is specified: | |
|{{-E}} _email_ |Specifies the email address of the user. |
|{{-H}} _mailhost_ |The mail host of the user.This option is mandatory if the {{-S mail}} option is specified. |
|The following options are only allowed if the {{-S cal}} option is specified: | |
|{{-B}} _DWPHost_ |Specifies the DNS name of the backend calendar server that hosts this user’s calendars.Note: This attribute can only be added and cannot be modified if it already exists. |
|{{-E}} _email_ |Specifies the email address for the calendar user. |
|{{-J}} _First Day of Week_ |The first day of the week shown when the calendar is displayed in the calendar server user interface. The valid values are 0-6 (0 is Sunday, 1 is Monday, and so on). |
|{{-k}} _calid_type_ |Specifies the type of calendar id that is created (when adding the calendar service). The accepted values are {{legacy}} and {{hosted}}. If {{-k legacy}} is specified, only the calendar id is used (for example, {{jsmith}}). If {{-k hosted}} is specified, the calendar id plus domain is used (for example, {{jsmith@sesta.com}}).\\
If the {{-k}} option is not specified, the default is to use the calendar id plus domain ({{hosted}}).\\
You can set the value of the calendar id type that is created if the {{-k}} option is not specified. To do so, add the following parameter to the {{resource.properties}} file: \\
{{switch-caltype=}}_value_ \\
where _value_ is “{{hosted}}” or “{{legacy}}”.\\
The {{resource.properties}} file is located in the following directory:\\
{{_da-base_/data/WEB-INF/classes/sun/comm/cli/server/servlet/resource.properties}} |
|{{-T}} _time zone_ |The time zone in which the user's calendar is displayed. See [Calendar Time Zone Strings|Attribute Values and Calendar Time Zones#ACFIB] for a list of the valid time zone strings. |
{anchor:acfgw}
h2. Examples
The following example adds a mail service for the user {{smith}}:
{code}
commadmin user modify -D chris -n sesta.com -w bolton -l smith \
-A description:"new description" -S mail -H mailhost.siroe.com
{code}
In this example, a mail forwarding address is added for user {{smith}}:
{code}
commadmin user modify -D chris -n sesta.com -w bolton -l smith \
-A +mailforwardingaddress:tsmith@siroe.com
{code}