Registering a storage system

Important:

The user information registered on the REST API server is used by the REST API server when the storage system configuration information is refreshed or when information is obtained to update the information stored on the REST API server.
After a storage system is registered on the REST API server, if the password of a registered user is changed by using the REST API or Storage Navigator, the change is not applied to the storage system information registered on the REST API server. To register the new password on the REST API server, use the API function for changing information about storage systems.

Execution permission

Security Administrator (View Only) or Security Administrator (View & Modify)

Request line

POST base-URL/v1/objects/storages

Request message

Object ID: None.

Query parameters: None.

Body

For VSP One B20 series:

The following shows an example of coding when VSP One B28 is registered.

{
  "ip": "192.0.2.20",
  "model" : "VSP One B28",
  "serialNumber" : 800556,
  "changeNotificationSetting" : {
    "isNotifiable" : true
  },
  "isSecure" : true
}

Attribute	Type	Description
serialNumber	int	(Required) Serial number of the storage system to be registered
model	string	(Required) Model name of the storage system to be registered Specify one of the following values: VSP One B24 VSP One B26 VSP One B28
ip	string	(Required) IP address (service IP) used to communicate with the storage system You can specify an IPv4 or an IPv6 IP address. If both an IPv4 address and an IPv6 address are set on the storage system side, specify an IPv4 address.
changeNotificationSetting	object	(Optional) Settings for receiving configuration-change notifications from the storage system If the `changeNotificationSetting` attribute is omitted, the system operates in the same way as when the `isNotifiable` attribute is omitted. (Optional) isNotifiable (boolean) Specify whether to receive configuration-change notifications from the storage system. We strongly recommend that you specify `true` for this attribute. `true`: Receive notifications `false`: Do not receive notifications If `true` is specified for the `isNotifiable` attribute, an error occurs if the internal configuration-change notification test cannot be performed. If the attribute is omitted, the system assumes that `true` is specified for the `isNotifiable` attribute, and the internal processing continues even if the test cannot be performed. If the configuration-change notification test cannot be performed, change the value of the `isNotifiable` attribute to `false`. This will allow processing of the API request to end normally. To verify that the settings to receive configuration-change notifications are configured as intended, run the API request that gets a list of the destinations of configuration-change notifications from the storage system. If the Configuration Manager REST API server is registered as a destination for configuration-change notifications, this indicates that settings have been configured with `true` specified for the attribute.
isSecure	boolean	(Optional) Settings for SSL communication between the REST API server and the storage system `true`: SSL communication is enabled. If this attribute is omitted, `true` is set. If you want to ensure communication security, you can enable SSL communication only.

For VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900:

The following shows an example of coding when VSP G900 is registered.

{
  "ctl1Ip" : "192.0.10.10",
  "ctl2Ip" : "192.0.10.11",
  "model" : "VSP G900", 
  "serialNumber" : 123456,
  "changeNotificationSetting" : {
    "isNotifiable" : true
  },
  "usesSvp" : true,
  "svpIp" : "192.0.2.100"
}

Attribute	Type	Description
serialNumber	int	(Required) Serial number of the storage system to be registered
model	string	(Required) Model name of the storage system to be registered Specify one of the following values: `VSP E590` `VSP E790` `VSP E990` `VSP E1090` `VSP E590H` `VSP E790H` `VSP E1090H` `VSP G350` `VSP G370` `VSP G700` `VSP G900` `VSP F350` `VSP F370` `VSP F700` `VSP F900`
targetCtl	string	(Optional) Controller operated by the REST API Specify one of the following values: `CTL1`: Controller 1 `CTL2`: Controller 2 If this attribute is omitted, `CTL1` is set.
ctl1Ip	string	(Optional) IP address of controller 1 of the storage system You can specify an IPv4 or IPv6 IP address. If both an IPv4 and IPv6 IP addresses are specified on the storage system side as the IP address of the controller 1, specify an IPv4 address. If this attribute is omitted, the value is automatically set. If you specified `CTL1` for the `targetCtl` attribute or omitted the `targetCtl` attribute, be sure to specify this attribute.
ctl2Ip	string	(Optional) IP address of controller 2 of the storage system You can specify an IPv4 or IPv6 IP address. If both an IPv4 and IPv6 IP addresses are specified on the storage system side as the IP address of the controller 2, specify an IPv4 address. If this attribute is omitted, the value is automatically set. This attribute must be specified if `CTL2` is specified for `targetCtl`.
usesSvp	boolean	(Optional) Whether to link with an SVP `true`: Link with an SVP `false`: Do not link with an SVP If this attribute is omitted, `false` is set. If you use an SVP to manage the storage system, we recommend linking the storage system with the SVP.
svpIp	string	(Optional) IP address of the SVP that will manage the storage system to be registered You can specify an IPv4 or IPv6 IP address. If both an IPv4 and IPv6 IP addresses are specified on the storage system side as the IP address of the SVP, specify an IPv4 address. This attribute must be specified if `true` is specified for `usesSvp`. If you specified `false` for the `usesSvp` attribute or omitted the `usesSvp` attribute, this attribute will be ignored even if it is specified. Even if the attribute is specified, it will not be registered. In addition, the value is not output by API requests to get storage system information.
mappWebServerHttpsPort	int	(Optional) Port number used by the SVP for HTTPS communication If you specify `true` for the `usesSvp` attribute, and if the port number has been changed to anything other than the default value (`443`), be sure to specify this attribute. If this attribute is omitted, `443` is set. If you specified `false` for the `usesSvp` attribute or omitted the `usesSvp` attribute, this attribute will be ignored even if it is specified. Even if the attribute is specified, it will not be registered. In addition, the value is not output by API requests to get storage system information.
rmiPort	int	(Optional) The port number to be used for RMI communication between the Configuration Manager REST API server and the storage system If you specify `true` for the `usesSvp` attribute, and if the port number has been changed to anything other than the default value (`1099`), be sure to specify this attribute. If this attribute is omitted, `1099` is set. If you specified `false` for the `usesSvp` attribute or omitted the `usesSvp` attribute, this attribute will be ignored even if it is specified. Even if the attribute is specified, it will not be registered. In addition, the value is not output by API requests to get storage system information.
isSecure	boolean	(Optional) Settings for SSL communication between the REST API server and the storage system `true`: SSL communication is enabled. If this attribute is omitted, `true` is set. If you want to ensure communication security, you can enable SSL communication only.
lanConnectionProtocol	string	(Optional) Specifies the encrypted communication mode used for SSL communication between the REST API server and the storage system `DTLS SVP` `SSL TLS` If this attribute is omitted, `DTLS SVP` is set. If `false` is specified for the `usesSvp` attribute, this attribute cannot be specified.
changeNotificationSetting	object	(Optional) Settings for receiving configuration-change notifications from the storage system If the `changeNotificationSetting` attribute is omitted, the system operates in the same way as when the `isNotifiable` attribute is omitted. (Optional) isNotifiable (boolean) Specify whether to receive configuration-change notifications from the storage system. We strongly recommend that you specify `true` for this attribute. `true`: Receive notifications `false`: Do not receive notifications If `true` is specified for the `isNotifiable` attribute, an error occurs if the internal configuration-change notification test cannot be performed. If the attribute is omitted, the system assumes that `true` is specified for the `isNotifiable` attribute, and the internal processing continues even if the test cannot be performed. If the configuration-change notification test cannot be performed, change the value of the `isNotifiable` attribute to `false`. This will allow processing of the API request to end normally. To verify that the settings to receive configuration-change notifications are configured as intended, run the API request that gets a list of the destinations of configuration-change notifications from the storage system. If the Configuration Manager REST API server is registered as a destination for configuration-change notifications, this indicates that settings have been configured with `true` specified for the attribute.

For storage systems VSP 5000 series, VSP G200, G400, G600, G800, VSP G1000, VSP G1500, VSP F400, F600, F800, VSP F1500:

The following shows an example of coding when VSP G400 is registered.

{
  "svpIp": "192.0.2.100",
  "serialNumber": 123456,
  "model": "VSP G400",
  "changeNotificationSetting": {
    "isNotifiable": true,
    "mappWebServerHttpsPort": 443
  }
}

Attribute	Type	Description
svpIp	string	(Required) IP address of the SVP that will manage the storage system to be registered You can specify an IPv4 or IPv6 IP address. If both an IPv4 and IPv6 IP addresses are specified on the storage system side as the IP address of the SVP, specify an IPv4 address.
rmiPort	int	(Optional) The port number to be used for RMI communication between the Configuration Manager REST API server and the storage system For VSP 5000 series, only `11099` can be specified. If this attribute is omitted, `11099` is set. For other series, if this attribute is omitted, `1099` is set.
mappWebServerHttpsPort	int	(Optional) Port number used by the SVP for HTTPS communication Use this attribute when SSL communication is used between the REST API server and the storage system. You can use this attribute for VSP G200, G400, G600, G800, VSP F400, F600, F800 for which the microcode version is 83-04-44-`XX`/`XX` or later. If the port number is changed from the default value `443`, specify the new value. If this attribute is omitted, `443` will be set. If this value has been changed, be sure to specify the same value as the `mappWebServerHttpsPort` attribute that is set when a notification about changes made to the storage system is received.
serialNumber	int	(Required) Serial number of the storage system to be registered
model	string	(Required) Model name of the storage system to be registered Specify one of the following values: `VSP 5100` `VSP 5200` `VSP 5500` `VSP 5600` `VSP 5100H` `VSP 5200H` `VSP 5500H` `VSP 5600H` `VSP G200` `VSP G400` `VSP G600` `VSP G800` `VSP G1000` `VSP G1500` `VSP F400` `VSP F600` `VSP F800` `VSP F1500` `VSP N400` `VSP N600` `VSP N800`
isSecure^#	boolean	(Optional) Settings for SSL communication between the REST API server and the storage system `true`: SSL communication is enabled. `false`: SSL communication is disabled. For VSP 5000 series, only `true` can be specified. If this attribute is omitted, `true` is set. For other series, if this attribute is omitted, `false` is set. For VSP G1000, VSP G1500, and VSP F1500 storage systems, we recommend using microcode version 80-05-2`X`-`XX`/`XX` or later.
lanConnectionProtocol^#	string	(Optional) Specifies the encrypted communication mode used for SSL communication between the REST API server and the storage system You can use this attribute for VSP G200, G400, G600, G800, VSP F400, F600, F800 for which the microcode version is 83-04-44-`XX`/`XX` or later. You can set any of these values when `true` is set for the `isSecure` attribute. `DTLS` `DTLS SVP` `SSL TLS` If this attribute is omitted, `DTLS` is set.
changeNotificationSetting	object	(Optional) Settings for receiving configuration-change notifications from the storage system You can specify this attribute for VSP G200, G400, G600, G800, VSP F400, F600, F800 for which the microcode version is 83-04-`XX`-`XX`/`XX` or later, VSP G1000 storage systems for which the microcode version is 80-05-`XX`-`XX`/`XX` or later, VSP 5000 series, VSP G1500, or VSP F1500. If the `changeNotificationSetting` attribute is omitted, the system operates in the same way as when the `isNotifiable` attribute is omitted. (Optional) isNotifiable (boolean) Specify whether to receive configuration-change notifications from the storage system. We strongly recommend that you specify `true` for this attribute. `true`: Receive notifications `false`: Do not receive notifications If `true` is specified for the `isNotifiable` attribute, an error occurs if the internal configuration-change notification test cannot be performed. If the attribute is omitted, the system assumes that `true` is specified for the `isNotifiable` attribute, and the internal processing continues even if the test cannot be performed. If the configuration-change notification test cannot be performed, change the value of the `isNotifiable` attribute to `false`. This will allow processing of the API request to end normally. To verify that the settings to receive configuration-change notifications are configured as intended, run the API request that gets a list of the destinations for configuration-change notifications from the storage system. If the Configuration Manager REST API server is registered as a destination for configuration-change notifications, this indicates that settings have been configured with `true` specified for the attribute. (Optional) mappWebServerHttpsPort (int) Port number used by the SVP for HTTPS communication For VSP G200, G400, G600, G800, VSP F400, F600, F800, if the port number has been changed from the default value `443`, specify the new value. You can set this value when `true` is set for the `isNotifiable` attribute. If this attribute is omitted, `443` will be set. If the microcode version of VSP G200, G400, G600, G800, VSP F400, F600, F800 is 83-04-44-`XX`/`XX` or later, and this value is changed, make sure that you specify the same value for the `mappWebServerHttpsPort` attribute that is set when SSL communication is used between the REST API server and the storage system.

#: If the management server is running a Linux OS and the REST API is installed by a non-root user, the values that can be specified will be restricted. For details, see the description of operation in an environment where the REST API is installed by a non-root user.

Response message

Body

{
  "storageDeviceId": "834000123456",
  "model": "VSP G400",
  "serialNumber": 123456
}

Attribute	Type	Description
storageDeviceId	string	Storage device ID of the registered storage system
model	string	Model name of the registered storage system
serialNumber	int	Serial number of the registered storage system

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the section explaining HTTP status codes.

Status codes	Message	Description
409	Conflict	The storage system is already registered with the specified storage device ID.
412	Precondition Failed	The specified action cannot be executed because the number of storage systems that can be registered exceeded the maximum.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -u rest-test:rest-api -X POST --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages