Registering a server

Storage Advisor Embedded User Guide

Version
93-07-2x
88-08-12
Audience
anonymous
Part Number
MK-97HM85022-25

The following request registers, in a storage system, information about a server to manage with Storage Advisor Embedded. You can also create a server to which host groups are added by specifying only the nickname of that server.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/simple/v1/objects/servers

Request message

Object ID
None.
Query parameters
None.
Body
In the example shown below, the following information is specified to register, to a storage system, a server that is connected by using Fibre Channel:
  • Server nickname: hostA
  • Protocol: FC
  • OS type: Linux
{
  "serverNickname": "hostA",
  "protocol": "FC",
  "osType": "Linux"
}

In the example shown below, the following information is specified to register, to a storage system, a server that is connected by using iSCSI:

  • Nickname: hostB
  • Protocol: iSCSI
  • OS type: Linux
{
  "serverNickname": "hostB",
  "protocol": "iSCSI",
  "osType": "Linux"
}

In the following example, a server to which host groups are to be added is created:

{
  "serverNickname": "hostC",
  "isReserved": true
}

Attribute

Type

Description

serverNickname

string

(Required) Specify a server nickname consisting of 1 through 229 characters.

You can use alphanumeric characters (0 through 9, A through Z, a through z), space characters, and the following symbols:

Comma (,), Hyphen (-), periods (.), forward slash (/), colon (:), at sign (@), back slash (\), underscore (_)

This attribute is case-sensitive.

You can use a space character between usable characters, but cannot use it at the beginning or end of the server nickname.

You cannot use a hyphen (-) at the beginning of the server nickname.

If you are using an iSCSI connection, the server nickname must not include any commas (,), slashes (/), or backslashes (\).

protocol

string

(Optional) Protocol

You can specify the following values:

  • FC
  • iSCSI

If you did not specify true for the isReserved attribute, you must specify this attribute.

If you specified true for the isReserved attribute, any value specified for this attribute will be ignored.

osType

string

(Optional) OS type

You can specify the following values:

  • Linux
  • HP-UX
  • OpenVMS
  • Tru64
  • Solaris
  • NetWare
  • AIX
  • VMware
  • Windows

If you did not specify true for the isReserved attribute, you must specify this attribute.

If you specified true for the isReserved attribute, any value specified for this attribute will be ignored.

osTypeOptions

int[]

(Optional) Specify an option for the OS type as an integer.

  • For VSP G130, G/F350, G/F370, G/F700, G/F900: 0 through 127
  • For VSP E series storage systems: 0 through 255

For the valid values, see the Provisioning Guide. This attribute corresponds to the host mode option in Command Control Interface and in Device Manager - Storage Navigator.

If you omit this attribute but specify the OS type, the value for the specified OS type will be automatically set.

If you specified true for the isReserved attribute, any value specified for this attribute will be ignored.

isReserved

boolean

(Optional) Specify whether to create, in the storage system, a server to which host groups are to be added.

  • true: Create a server to which host groups are to be added.
  • false: Do not create a server to which host groups are to be added.

If this attribute is omitted, false is assumed.

Response message

Body

Attribute

Type

Description

statusResource

string

URL used to obtain the results of the register server information request

Note:

Run the API function for obtaining information about the status of the API function that performs asynchronous processing. For details, see Getting status information about an API function that performs asynchronous processing.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers