ssonnmsetup

Organization of this page

Format
Function
Options
Usage example
Return values

Format

To add or change information for connecting to NNMi on the local host:

ssonnmsetup -add -user user-name -password password 
            -port port-number [-ssl]

To add or change information for connecting to NNMi on the event-destination host:

ssonnmsetup -add -dest IP-address -user user-name -password password
            -port port-number [-ssl]

To delete information for connecting to NNMi on the event-destination host:

ssonnmsetup -delete -dest IP-address

To add or change information for connecting to NNMi on other hosts in a distributed configuration:

ssonnmsetup -add -host management-manager-name 
            -user user-name
            -password password -port port-number [-ssl]

To output the command usage:

ssonnmsetup -h

To Page Top

Function

The ssonnmsetup command adds, changes, and deletes information for connecting to NNMi when linking to NNMi. Define information for connecting to NNMi in the NNM information definition file (ssonnminfo.conf). For details about the NNM information definition file, see 6.3.29 NNM information definition file (ssonnminfo.conf).

If you execute the ssonnmsetup command during execution of the following commands, the command terminates abnormally:

ssobackup, ssorestore, ssonnmsetup

To Page Top

Options

-add

Adds or changes a definition for connecting to NNMi.

If you do not specify the -dest option, information for connecting to NNMi on the local host is to be defined. In such a case, the definition target is the default definition in the NNM information definition file. If you specify the -dest option, information for connecting to NNMi on the event-destination host is to be defined. In such a case, the IP address specified for the -dest option is set as the node key name in the NNM information definition file. If the default definition has been set or the IP address specified for the -dest option has been defined as a node key name in the NNM information definition file, the corresponding definition information is updated with the specified information.

-host `management-manager-name`

Specifies the host name or IP address of the management manager in 255 bytes or less in a distributed configuration. The default definition in the NNM information definition file is to be executed. This option cannot be specified together with the -dest option. Also, the local host name and the local host IP address cannot be specified.

-user `user-name`

Specifies an NNMi user name for connecting to NNMi.

Specify a user name that consists of only ASCII characters and is 1 byte to 40 bytes long. Specifiable characters are spaces, single-byte alphanumeric characters, and underscores (_).

Note that you cannot use a tab, quotation mark ("), asterisk (*), vertical bar (|), less-than sign (<), more-than sign (>), question mark (?), comma (,), equal sign (=), and hash mark (#).

Although we recommend that you specify Web service client of NNMi as the role for the user, Administrator and System can also be specified as roles.

-password `password`

Specifies the password for the user name specified for the -user option.

Specify a password that consists of only ASCII characters and is 1 byte to 40 bytes long. Specifiable characters are spaces, single-byte alphanumeric characters, and underscores (_).

-port `port-number`

Specifies the port number of NNM Web server port of NNMi. Specify the port number by using an integer from 1 to 65,535.

If you specify -ssl, the option specifies the port number of NNM Web server port for HTTPS communication.

-delete

Deletes the definition that the IP address specified for the -dest option set as a node key name.

-dest `IP-address`

Specifies the destination IP address in the event destination definition file.

-ssl

Specify this option when you communicate with NNMi by using HTTPS. If you do not specify this option, communication is performed by using HTTP.

-h

Outputs the command usage. This option cannot be specified together with other options.

To Page Top

Usage example

To set a user name (jp1user), password (jp1sso), and port number (80) for a NNMi connection on the local host:
```
ssonnmsetup -add -user jp1user -password jp1sso -port 80
```
To change the password in the default definition set in step 1 to jp1cm2sso:
```
ssonnmsetup -add -user jp1user -password jp1cm2sso -port 80
```
To set a user name (jp1user), password (jp1sso), and port number (20080) for a NNMi connection on the event destination host (IP address = 133.108.120.14):
```
ssonnmsetup -add -dest 133.108.120.14 -user jp1user -password jp1sso -port 20080
```

To delete the definition set in step 3:

ssonnmsetup -delete -dest 133.108.120.14

To set a user name (jp1user), password (jp1sso), and port number (80) for a NNMi connection on another host (host name = nnmhost) in a distributed configuration:
```
ssonnmsetup -add -host nnmhost -user jp1user -password jp1sso -port 80
```
To set a user name (jp1user), password (jp1sso), and port number (443) for a NNMi connection on the local host and establish HTTPS communication:
```
ssonnmsetup -add -user jp1user -password jp1sso -port 443 -ssl
```
To set a user name and password that include a single-byte space:
```
ssonnmsetup -add -user "jp1 user" -password "jp1 sso" -port 80
```

To Page Top

Return values

0	Normal termination
-1	Execution error such as incorrect arguments
-2	Execution error during editing of the NNM information definition file or backup and restore processing

To Page Top