Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Managing servers

You can register servers in the storage system and configure port settings as well as Fibre Channel or iSCSI settings. Attach volumes to servers to make capacity available to users.

The options to manage servers and attach volumes to a server are only applicable in certain configurations. Contact your Hitachi representative for more details and to enable these options for your configuration.

Registering a server

Register servers in Storage Advisor Embedded so that you can assign storage resources to them. For cluster configurations, you need to register all of the servers (nodes) that make up the cluster as one server. In that case, for the WWNs or iSCSI initiator names that are used for connecting to storage system ports, add all of the WWNs or iSCSI initiator names of each server.

Before you begin

  • The server must be connected to the storage system via a Fibre Channel (FC) connection or an iSCSI connection.
  • If you are using an FC connection, obtain the following items:
    • Server name
    • OS type
    • WWN
  • If you are using an iSCSI connection, obtain the following items:
    • Server name

      The server name must not include any commas (,), slashes (/), or backslashes (\).

    • OS type
    • iSCSI initiator name

Procedure

  1. In the dashboard or in the navigation bar, click Servers.

  2. Click the plus sign (+).

  3. Specify the required information and register the server. If you want to continue to register additional servers, click + Add another server, and when you have finished registering all of the servers you want to register, click Submit.

    GUID-20833753-386D-4441-B638-F350D16C4A23-low.gif

Setting port connections for a server

You can set information for connecting the server port and storage system port.

Before you begin

  • The server must be registered in Storage Advisor Embedded.
  • Identify the following items:
    • Server name
    • WWN or iSCSI initiator name
    • Storage system port ID

Procedure

  1. In the dashboard or in the navigation bar, click Servers.

  2. Select one or more servers and click GUID-5F56D74E-E6FE-44BF-B1CC-36967A04CFEF-low.gif (Configure Port Connections).

  3. Click the WWN or iSCSI initiator name of the server and the storage system port ID to set a port connection.

    Note

    After you configure paths to a server to which volumes are already allocated, the following warning message might be temporarily displayed in the server details window. If this message does not disappear after a while, refresh the window.

    Port connections for volume allocation are partially configured. To expose volumes to the server, configure port connections.

Modifying server settings

You can modify the server settings, such as server name, OS type, and other information, registered in Storage Advisor Embedded.

Before you begin

  • If you are using a Fibre Channel connection, obtain the following items:

    • Server name
    • OS type
    • WWN
  • If you are using an iSCSI connection, obtain the following items:

    • Server name

      The server name must not include any commas (,), slashes (/), or backslashes (\).

    • OS type
    • iSCSI initiator name

Procedure

  1. In the dashboard or in the navigation bar, click Servers.

  2. Click GUID-AD1968EB-1936-404B-BECF-E261384BB0BD-low.gif (Edit Server) of the server that you want to edit.

  3. Modify the settings.

  4. Click the server name to open the details page, and then confirm that the settings are correct.

Adding a WWN or iSCSI initiator name to a server

You can add a WWN or iSCSI initiator name when you add HBAs or configure a cluster by adding servers. For cluster configurations, you need to register all of the servers (nodes) that make up the cluster as one server. In that case, for the WWNs or iSCSI initiator names that are used for connecting to storage system ports, add all of the WWNs or iSCSI initiator names of each server.

  1. In the dashboard or in the navigation bar, click Servers.

  2. Click GUID-AD1968EB-1936-404B-BECF-E261384BB0BD-low.gif (Edit Server) for the server for which you are adding a WWN or iSCSI initiator name .

  3. Add a WWN or an iSCSI initiator name.

  4. Click the server name to open the details page, and then verify that the WWN or iSCSI initiator name was added.

Deleting a WWN or iSCSI initiator name from a server

You can delete a WWN or iSCSI initiator name.

  1. In the dashboard or in the navigation bar, click Servers.

  2. Click GUID-AD1968EB-1936-404B-BECF-E261384BB0BD-low.gif (Edit Server) for the server for which you are deleting the WWN or iSCSI initiator name .

  3. Delete the WWN or iSCSI initiator name.

  4. Click the server name to open the details page, and then verify that the WWN or iSCSI initiator name was deleted.

Modifying iSCSI target names

If the server and the storage system are connected using iSCSI, you can modify the iSCSI target name (iSCSI name of the iSCSI target).

  1. In the dashboard or in the navigation bar, click Servers.

  2. Click the name of the server whose settings you want to modify.

  3. On the details page, click GUID-81A3E6C9-FD65-480C-B845-86B976D5311B-low.gif (Edit iSCSI Target Names).

  4. Check and modify the settings.

  5. Click the server name to open the details page, and then verify that the settings are correctly specified.

Deleting a server

When you no longer need to manage a server, you can delete it from Storage Advisor Embedded.

Before you begin

  • Confirm the name of the server that you want to delete.
  • Ensure that no volumes are attached to the server that you want to delete.

Procedure

  1. On the dashboard or in the navigation bar, click Servers.

  2. Select one or more servers and click GUID-F074FA1A-3F5C-4AD5-A29C-48E36520F7C7-low.gif (Delete Servers).

Modifying the storage system port settings

You can modify the storage port settings.

NoteTo apply the network segmentation by the VLAN tagging to a storage system, create virtual ports with CCI using the raidcom modify port command. Then manage volumes with Storage Advisor Embedded.

To set up the CHAP authentication by an iSCSI server, use the raidcom modify host_grp command or Device Manager - Storage Navigator

.

Procedure

  1. In the navigation bar, click Ports.

  2. Click GUID-AD1968EB-1936-404B-BECF-E261384BB0BD-low.gif (Edit Port) of the port that is to be edited.

  3. Modify the following settings:

    • Port ID
    • Port security
    • Port speed
    • FC information or iSCSI information
    Note

    For iSCSI (optical) ports, Port Speed is fixed at 10 Gbps. If a value other than 10 Gbps is specified, that value will be ignored.

  4. Click the port ID to open the details page, and then verify that the settings are correctly specified.

Creating volumes and attaching them to a server

Storage Advisor Embedded allows you to create volumes and attach them to servers in a single workflow or one at a time. By enabling the capacity saving (deduplication and compression) when creating volumes, you can reduce the amount of data to be stored, depending on the data type.

Before you begin

  • Ensure that a pool is available.

    If you want to enable the capacity saving for the volumes to be created, you cannot use a tiered pool.

  • Obtain the following items:
    • Server name
    • Pool name
    • Capacity
    • Number of volumes
    • Volume name
Note

If a host group (or iSCSI target) that was assigned to a virtual storage machine by using another management tool has been added to a server, you cannot attach volumes to the server.

Procedure

  1. In the dashboard or in the navigation bar, click Servers.

  2. Select one or more servers and click GUID-2DBD4518-ADEB-4DF3-A7CB-F9B4DD66A621-low.gif, and then select Create and Attach Volumes.

  3. Create volumes by specifying the required information, and then click Submit to attach those volumes to the server.

    GUID-545B3763-1D37-44E9-850C-96EDE1C2935B-low.gif

    For the name of a volume, specify a name that is a combination of Volume Name and a number beginning with Suffix Start Number (optional).

    For example, if you specify "volume" for Volume Name, "7" for Suffix Start Number, and "2" for Number of Digits, the volume name will be "volume07".

Attaching volumes to servers by selecting servers

You can attach an existing volume to a server by selecting a volume from the server page.

  1. On the dashboard or in the navigation bar, click Servers.

  2. Select one or more servers and click GUID-2DBD4518-ADEB-4DF3-A7CB-F9B4DD66A621-low.gif, and then select Attach Volumes.

    If a host group (or iSCSI target) that was assigned to a virtual storage machine by using another management tool has been added to a server, you cannot attach volumes to the server.

  3. Select the volume to be attached to the server.

    Volumes for which Attached Unmanaged is displayed for the volume type are volumes that were attached by using management software other than Storage Advisor Embedded.

Attaching volumes to servers by selecting volumes

You can attach an existing volume to a server by selecting a server from the volume page.

  1. In the dashboard or in the navigation bar, click Volumes.

  2. Select one or more volumes and click GUID-2DBD4518-ADEB-4DF3-A7CB-F9B4DD66A621-low.gif (Attach Volumes).

    Volumes for which Attached Unmanaged is displayed for the volume type are volumes that were attached by using management software other than Storage Advisor Embedded.

  3. Select one or more servers to which the volumes will be attached.

    If a host group (or iSCSI target) that was assigned to a virtual storage machine by using another management tool has been added to a server, you cannot attach volumes to the server.

Checking I/O from the server

You can check the status of I/O from the server to determine whether a volume is correctly attached.

  1. In the dashboard or in the navigation bar, click Servers.

  2. Click the server name to open the server details page.

  3. Click the volume name to open the volume details page.

  4. Check the IOPS graph on the Performance Monitor to confirm that I/O information is being displayed.

Detaching volumes from a server

If a server no longer needs to use a specific volume, you can detach that volume from the server.

  1. In the dashboard or in the navigation bar, click Servers.

  2. Select one or more servers and click GUID-198AE93D-687F-47EC-AB0E-E8435A0F01CB-low.gif (Detach Volumes).

    GUID-F82164A0-81F8-4EC6-8BA2-96C7D6003C43-low.gif

    Note that only those volumes that are attached to all of the selected servers can be detached.

  3. Select one or more volumes and detach them.

Getting information about a specific server

The following request gets information about the server corresponding to the specified server ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/servers/object-ID
Request message
  • Object ID

    Specify the id value obtained by getting information about the server.

    Attribute

    Type

    Description

    id

    int

    (Required) Server ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when getting information about a server (ID 10) that is connected by using Fibre Channel:

    {
      "id": 10,
      "nickname": "hostA",
      "protocol": "FC",
      "osType": "Linux",
      "osTypeOptions":[2,22,25,68],
      "totalCapacity": 1024,
      "usedCapacity": 42,
      "numberOfVolumes": 2,
      "numberOfPaths": 2,
      "paths": [
        {
          "hbaWwn": "000000102cceccc9",
          "portIds": [
            "CL1-A"
          ]
        },
        {
          "hbaWwn": "1111111111111111",
          "portIds": [
            "CL1-A"
            ]
        }
      ],
      "isInconsistent": false,
      "modificationInProgress": false,
      "compatibility": "DKCMAIN_8802010000",
      "isReserved": false,
      "hasNonFullmeshLuPaths": false,
      "hasUnalignedOsTypes": false,
      "hasUnalignedOsTypeOptions": false
    }

    The following is an example of the output when getting information about a server (server ID: 11) that is connected by using iSCSI:

    {
      "id": 11,
      "nickname": "hostB",
      "protocol": "iSCSI",
      "osType": "Linux",
      "osTypeOptions": [2,22,25,68],
      "totalCapacity": 1024,
      "usedCapacity": 42,
      "numberOfPaths": 2,
      "paths": [
        {
          "iscsiName": "iqn.1994-05.com.redhat:496799ba93",
          "portIds": [
            "CL1-B"
          ]
        },
        {
          "iscsiName": "iqn.1994-05.com.redhat:a7526e46aa",
          "portIds": [
            "CL1-B"
            ]
        }
      ],
      "isInconsistent": false,
      "modificationInProgress": false,
      "compatibility": "DKCMAIN_8802010000",
      "isReserved": false,
      "hasNonFullmeshLuPaths": false,
      "hasUnalignedOsTypes": false,
      "hasUnalignedOsTypeOptions": false
    }

    This operation obtains the values of attributes obtained as part of server information, as well as the values of the following attributes.

    Attribute

    Type

    Description

    osTypeOptions

    int[]

    Option for the OS type

    numberOfVolumes

    int

    Number of attached volumes

    paths

    object[]

    Path information defined in the WWN of the HBA:

    • hbaWwn (string)

      WWN of the HBA

      Appears when the protocol is FC.

    • iscsiName (string)

      iSCSI name

      Appears when the protocol is iSCSI.

    • portIds (string[])

      Port IDs of assigned ports

    hasNonFullmeshLuPaths

    boolean

    The following information appears: whether there are any volumes for which paths are not defined between all ports registered on the specified server and all volumes connected to the server:

    • true: There is at least one volume for which paths are not defined with all ports registered on the specified server.
    • false: All volume paths are defined with all ports registered on the specified server.

    hasUnalignedOsTypeOptions

    boolean

    The following information appears: whether inconsistencies exist in the information on the server if a host group (or an iSCSI target) is added to a server for which the OS type option is defined, and if the value of the host mode option defined for the host group differs from the value of the server's OS type option.

    • true: Inconsistencies exist
    • false: Inconsistencies do not exist
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/10

Getting server information

The following request obtains information about servers managed by Storage Advisor Embedded. You can specify filter conditions.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/servers
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Filter Condition

    nickname

    string

    (Optional) Server nickname

    Information is obtained about the server that has the nickname is a perfect match of the specified value.

    hbaWwn

    string

    (Optional) WWN of the HBA

    Information is obtained about the server that has the WWN of the HBA that is a perfect match to the specified value.

    iscsiName

    string

    (Optional) iSCSI name

    Information is obtained about the server that has the iSCSI name that is a perfect match to the specified value.

  • Body

    None.

Response message
  • Body

    The following is an example of output when getting information about the servers whose nicknames are hostA and hostB respectively (if hostA and hostB are specified for the query parameter nickname of the corresponding servers).

    {
      "data": [
        {
          "id": 10,
          "nickname": "hostA",
          "protocol": "FC",
          "osType": "Linux",
          "totalCapacity": 1024,
          "usedCapacity": 42,
          "numberOfPaths": 2,
          "isInconsistent": false,
          "modificationInProgress": false,
          "compatibility": "DKCMAIN_8802010000",
          "isReserved": false,
          "hasUnalignedOsTypes": false
        },
        {
          "id": 11,
          "nickname": "hostB",
          "protocol": "iSCSI",
          "osType": "Linux",
          "totalCapacity": 1024,
          "usedCapacity": 42,
          "numberOfPaths": 2,
          "isInconsistent": false,
          "modificationInProgress": false,
          "compatibility": "DKCMAIN_8802010000",
          "isReserved": false,
          "hasUnalignedOsTypes": false
        }
      ],
      "count": 2
    }

    The following is an example of output when getting information about the servers whose nicknames are hostC and hostD respectively, and to which host groups are added (if hostC and hostD are specified for the query parameter nickname of the corresponding servers).

    {
      "data": [
        {
          "id": 8,
          "nickname": "hostC",
          "protocol": "Undefined",
          "osType": "Undefined",
          "totalCapacity": 0,
          "usedCapacity": 0,
          "numberOfPaths": 0,
          "isInconsistent": false,
          "modificationInProgress": false,
          "compatibility": "DKCMAIN_8802010000",
          "isReserved": true,
          "hasUnalignedOsTypes": false
        },
        {
          "id": 9,
          "nickname": "hostD",
          "protocol": "Undefined",
          "osType": "Undefined",
          "totalCapacity": 0,
          "usedCapacity": 0,
          "numberOfPaths": 0,
          "isInconsistent": false,
          "modificationInProgress": false,
          "compatibility": "DKCMAIN_8802010000",
          "isReserved": true,
          "hasUnalignedOsTypes": false
        }
      ],
      "count": 2
    }

    Attribute

    Type

    Description

    id

    int

    Server ID

    nickname

    string

    Server nickname

    protocol

    string

    Protocol

    One of the following values appears:

    • FC
    • iSCSI
    • Undefined

      This value appears if host groups are added to the server.

    osType

    string

    OS type

    One of the following values appears:

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

      This value appears if this server is a server to which host groups are to be added.

    • Unknown

    totalCapacity

    long

    Total capacity of attached volumes (MiB)

    usedCapacity

    long

    Used capacity of attached volumes (MiB)

    numberOfPaths

    int

    Number of HBAs registered on the server

    isInconsistent

    boolean

    Whether the server configuration information is consistent or not:

    • true: Inconsistent
    • false: Consistent

    modificationInProgress

    boolean

    Not currently used

    compatibility

    string

    Not currently used

    isReserved

    boolean

    The following information appears: whether host groups are added to the server.

    • true: Indicates a server to which host groups are added
    • false: Indicates a server other than the above

    hasUnalignedOsTypes

    boolean

    The following information appears: whether inconsistencies exist in the information on the server if a host group (or an iSCSI target) is added to a server for which the OS type is defined, and if the value of the host mode defined for the host group differs from the value of the server's OS type.

    • true: Inconsistencies exist
    • false: Inconsistencies do not exist
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers

Registering a server

The following request registers, in a storage system, information about a server to be managed by Storage Advisor Embedded. You can also create a server to which host groups are to be 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 the Option for the OS type as an integer from 0 through 127.

    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
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

Attaching a volume to a server

The following request connects all paths between a server and a volume.

Note

You cannot connect a path between a volume and a server to which a host group (or iSCSI target) that is attached to a virtual storage machine has been added.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/simple/v1/objects/volume-server-connections
Request message
  • Object ID

    None.

  • Query parameters

    None.

  • Body

    The following is an example of setting up a connection for a path between the volume with ID 100 and the server with ID 10:

    {
      "volumeIds": [
        100
      ],
      "serverIds": [
        10
      ]
    }

    Parameter

    Type

    Description

    volumeIds

    int[]

    (Required) Specify the ID of the volume to be attached as a value in the range from 0 through 65279.

    serverIds

    int[]

    (Required) IDs of the servers to which the volume is to be attached

    Specify the server IDs of all servers to which the volume is to be attached, as values in the range from 0 through 4095.

Response message
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/volume-server-connections

Detaching a volume from a specific server

The following request disconnects all paths that are registered between a volume and server. The volume and server are specified by the volume ID and server ID, respectively.

Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/simple/v1/objects/volume-server-connections/object-ID
Request message
  • Object ID

    Specify the id value obtained by getting information about the connection between the volume and the server. The value of the obtained attribute id appears in the following format, in which the volume ID and the server ID are linked by a comma. You can specify these values (obtained by getting information about the connection between the volume and the server) in the command by using the same format: volumeId followed by serverId, linked by a comma.

    volumeId,serverId

    Attribute

    Type

    Description

    volumeId

    int

    (Required) Volume ID

    serverId

    int

    (Required) Server ID

  • Query parameters

    None.

  • Body

    None.

Response message
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X DELETE https://192.0.2.100/ConfigurationManager/simple/v1/objects/volume-server-connections/100,10

Changing server settings

The following request changes the settings of the server corresponding to the specified server ID.

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/simple/v1/objects/servers/object-ID
Request message
  • Object ID

    Specify the id value obtained by getting information about the server.

    Attribute

    Type Description

    id

    int

    (Required) Server ID

  • Query parameters

    None.

  • Body

    Only the specified attributes are changed.

    The following is an example of changing the OS type to Solaris for a Fibre Channel-connected server (ID 10):

    {
      "osType": "Solaris"
    }

    The following is an example of changing the nickname of an iSCSI-connected server (ID 11) to My_REST_API_HOST:

    {
      "nickname": "My_REST_API_HOST"
    }

    Attribute

    Type Description

    nickname

    string

    (Optional) 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 (-), period (.), forward slash (/), colon (:), at sign (@), back slash (\), underscore (_)

    This attribute is case-sensitive.

    You can use a space character between 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.

    This attribute cannot be specified together with the following attributes:

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

    • osType
    • osTypeOptions

    osType

    string

    (Optional) OS type

    You can specify the following values:

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

    This attribute cannot be specified together with the following attribute:

    • nickname

    osTypeOptions

    int[]

    (Optional) Specify the option for the OS type as an integer from 0 through 127.

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

    If you do not specify the OS type option, this value will be overwritten by the value that is currently set for the OS type. If a value is already set for the OS type option and you do not want to overwrite the value, specify the OS type option that is currently set.

    This attribute cannot be specified together with the following attribute:

    • nickname
Response message
Status codes

See HTTP status codes.

Coding example

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

Deleting a server

The following request deletes information registered in a storage system about the server corresponding to the specified server ID.

Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/simple/v1/objects/servers/object-ID
Request message
  • Object ID

    Specify the id value obtained by getting information about the server.

    Attribute

    Type Description

    id

    int

    (Required) Server ID

  • Query parameters

    None.

  • Body

    Attribute

    Type Description

    keepLunConfig

    boolean

    (Optional) Specify whether to maintain the resource attachment information when information about the server is deleted.

    • true: Maintain the resource attachment information.
    • false: Do not maintain the resource attachment information.

    If you mistakenly add the wrong host group to a server, specify true to delete information about the server. Then, re-create the server and add the correct host group.

    If you specify true, you will no longer be able to manage the resource attachment information. Normally, we recommend that you do not specify this attribute.

Response message
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X DELETE https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/10

Adding host groups (iSCSI target) to a server

The following request adds host groups (iSCSI target) to a specified server (specified by its server ID).

Important

You cannot add a host group (iSCSI target) if it meets any of the following conditions:

  • The security of the port associated with a host group (iSCSI target) is invalid.
  • The protocol of the host group (iSCSI target) differs from that of the server to which the host group is to be added.
  • The host group (iSCSI target) contains a volume that is not a virtual volume created from a pool.
  • The host group (iSCSI target) is already added to another server.
  • The host group (iSCSI target) is attached to a virtual storage machine.
Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/simple/v1/objects/servers/object-ID/actions/add-host-groups/invoke
Request message
  • Object ID

    Specify the id value obtained by getting information about the server.

    Attribute

    Type

    Description

    id

    int

    (Required) Server ID

  • Query parameters

    None.

  • Body

    The following is an example of adding a host group by specifying the host group ID:

    {
      "hostGroups": [
        {
          "portId": "CL1-C",
          "hostGroupId": 1
        }
      ]
    }

    The following is an example of adding an iSCSI target by specifying the host group name:

    {
      "hostGroups": [
        {
          "portId": "CL1-D",
          "hostGroupName": "My_REST_API_HOST"
        }
      ]
    }

    Attribute

    Type

    Description

    hostGroups

    object[]

    Information about the host group (iSCSI target) to be added

    • (Required) portId: (string)

      Specify the port ID by using five characters.

    • (Optional) hostGroupId: (int)

      Specify the host group (iSCSI target) ID by using an integer in the range from 1 through 254.

      Specify either hostGroupId or hostGroupName. Do not specify both of these parameters together.

    • (Optional) hostGroupName: (string)

      Specify the host group name (iSCSI target name) by using a character string consisting of 1 through 64 characters.

      Specify either hostGroupId or hostGroupName. Do not specify both of these parameters together.

Response message
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/8/actions/add-host-groups/invoke

Changing the settings of an iSCSI target

The following request changes the iSCSI name of the iSCSI target that corresponds to the specified server ID and port ID.

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/simple/v1/objects/servers/object-ID/target-iscsi-ports/object-ID
Request message
  • Object ID

    Combines multiple object IDs that are to be specified.

    Specify the id value and the portId value, obtained by using the API function for getting information about the server, in the following format:

    id/target-iscsi-ports/portId

    Attribute

    Type

    Description

    id

    int

    (Required) Server ID

    portId

    string

    (Required) Port ID

  • Query parameters

    None.

  • Body

    The following is an example of changing the iSCSI name to iqn.rest.example.of.iqn.hostB for an iSCSI target of an iSCSI-connected server (server ID: 11, port ID: CL1-B):

    {
      "targetIscsiName": "iqn.rest.example.of.iqn.hostB"
    }

    Attribute

    Type

    Description

    targetIscsiName

    string

    (Required) Specifies the iSCSI name of the iSCSI target.

    Specify this item in iqn or eui format:

    • iqn format

      Specify a value that begins with iqn.. Use no more than 223 characters.

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

      Hyphen (-), period (.), colon (:)

      Specification example: iqn.rest.example.of.iqn.form

    • eui format

      After "eui.", specify a hexadecimal number. Specify a value consisting of 20 characters.

      You can use alphanumeric characters (0 through 9, A through F, a through f).

      Specification example: eui.0900ABDC32598D26

Response message
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/11/target-iscsi-ports/CL1-B

Getting information about iSCSI targets

The following request obtains information about the iSCSI target that corresponds to the specified server ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/servers/object-ID/target-iscsi-ports
Request message
  • Object ID

    Specify the id value obtained by getting information about the server.

    Attribute

    Type

    Description

    id

    int

    (Required) Server ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when getting information about the iSCSI target of an iSCSI-connected server (ID 11):

    {
      "data": [
        {
          "portId": "CL1-B",
          "targetIscsiName": "iqn.rest.example.of.iqn.hostB"
        }
      ],
      "count": 1
    }

    Attribute

    Type

    Description

    portId

    string

    Port ID of the assigned port

    targetIscsiName

    string

    iSCSI name of the iSCSI target

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/11/target-iscsi-ports

Getting information about the WWN of an HBA (iSCSI name)

The following request obtains information about the WWN of an HBA (or the iSCSI name) of the server that corresponds to the specified server ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/servers/object-ID/hbas
Request message
  • Object ID

    Specify the id value obtained by getting information about the server.

    Attribute

    Type

    Description

    id

    int

    (Required) Server ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when getting information about the WWN of an HBA of a server (ID 10) that is connected by using Fibre Channel.

    {
      "data": [
        {
          "serverId": 10,
          "hbaWwn": "000000102cceccc9",
          "portIds": [
              "CL1-A"
          ]
        },
        {
          "serverId": 10,
          "hbaWwn": "1111111111111111",
          "portIds": [
              "CL1-A"
            ]
        }
      ],
      "count": 2
    }

    The following is an example of getting information about the iSCSI name of a server (ID 11) that is connected by using iSCSI.

    {
      "data": [
        {
          "serverId": 11,
          "iscsiName": "iqn.1994-05.com.redhat:496799ba93",
          "portIds": [
              "CL1-B"
          ]
        },
        {
          "serverId": 11,
          "iscsiName": "iqn.1994-05.com.redhat:a7526e46aa",
          "portIds": [
              "CL1-B"
            ]
        }
      ],
      "count": 2
    }

    Attribute

    Type

    Description

    serverId

    int

    Server ID

    hbaWwn

    string

    WWN of the HBA

    iscsiName

    string

    iSCSI name

    portIds

    string[]

    List of port IDs of assigned ports

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/10/hbas

Getting information about the WWN of an HBA (iSCSI name) of a specific server

The following request obtains information about the WWN of an HBA (or iSCSI name) of a specific server.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/servers/object-ID/hbas/object-ID
Request message
  • Object ID

    Combines multiple object IDs that are to be specified.

    • To specify the WWN of the HBA

      Specify the serverId value and the hbaWwn value, obtained by using the API function for getting information about the WWN of the HBA (iSCSI name), in the following format:

      serverId/hbas/hbaWwn

      Attribute

      Type

      Description

      serverId

      int

      (Required) Server ID

      hbaWwn

      string

      (Required) WWN of the HBA

    • To specify the iSCSI name

      Specify the serverId value and the iscsiName value, obtained by using the API function for getting information about the WWN of the HBA (iSCSI name), in the following format:

      serverId/hbas/iscsiName

      Attribute

      Type

      Description

      serverId

      int

      (Required) Server ID

      iscsiName

      string

      (Required) iSCSI name

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when getting information about a server (ID 10) that is connected using Fibre Channel, and the WWN of the HBA is 000000102cceccc9:

    {
      "serverId": 10,
      "hbaWwn": "000000102cceccc9",
      "portIds": [
        "CL1-A"
      ]
    }

    The following is an example of the output when getting information about a server (ID 11) that is connected using iSCSI, and that has the iSCSI name iqn.1994-05.com.redhat:496799ba93:

    {
      "serverId": 11,
      "iscsiName": "iqn.1994-05.com.redhat:496799ba93",
      "portIds": [
        "CL1-B"
      ]
    }

    Attribute

    Type

    Description

    serverId

    int

    Server ID

    hbaWwn

    string

    WWN of the HBA

    If you specified the WWN of the HBA, a valid value appears.

    iscsiName

    string

    iSCSI name

    If you specified the iSCSI name, a valid value appears.

    portIds

    string[]

    List of port IDs of the assigned ports

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/10/hbas/000000102cceccc9

Adding information about the WWN of an HBA (iSCSI name)

The following request adds information about the WWN of an HBA (or iSCSI name) to the server corresponding to the specified server ID.

For cluster configurations, add the WWNs (or iSCSI names) of all of the servers (nodes) that make up the cluster to the server with the same server ID.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/simple/v1/objects/servers/object-ID/hbas
Request message
  • Object ID

    Specify the id value obtained by getting information about the server.

    Attribute

    Type

    Description

    id

    int

    (Required) Server ID

  • Query parameters

    None.

  • Body

    The following is an example of adding the WWN 210003e08b0256f9 of an HBA to a Fibre Channel-connected server (ID 10):

    {
      "hbas": [
        {
          "hbaWwn": "210003e08b0256f9"
        }
      ]
    }

    The following is an example of adding the iSCSI name iqn.myrestapiiscsi20150907 in the iqn format to an iSCSI-connected server (ID 11):

    {
      "hbas": [
        {
          "iscsiName": "iqn.myrestapiiscsi20150907"
        }
      ]
    }

    Attribute

    Type

    Description

    hbas

    object[]

    Information about the WWN of an HBA or the iSCSI name:

    • (Optional) hbaWwn (string)

      Specifies the WWN of the HBA in 16 lowercase characters.

    • (Optional) iscsiName (string)

      Specifies the iSCSI name.

      Specify this item in the iqn or eui format:

      • iqn format

        Specify a value that begins with iqn.. Use no more than 223 characters.

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

        Hyphen (-), period (.), colon (:)

        Specification example: iqn.rest.example.of.iqn.form

      • eui format

        After eui., specify a hexadecimal number. Specify a value consisting of 20 characters.

        You can use alphanumeric characters (0 through 9, A through F, a through f).

        Specification example: eui.0900ABDC32598D26

    Specify either hbaWwn or iscsiName. Do not specify both of these attributes together.

Response message
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/10/hbas

Deleting information about the WWN of an HBA (iSCSI name) from a server

The following request deletes information about the WWN of an HBA (or the iSCSI name) from a specific server.

Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/simple/v1/objects/servers/object-ID/hbas/object-ID
Request message
  • Object ID

    Combines multiple object IDs that are to be specified.

    • To specify the WWN of the HBA

      Specify the serverId value and the hbaWwn value, obtained by using the API function for getting information about the WWN of the HBA (iSCSI name), in the following format:

      serverId/hbas/hbaWwn

      Attribute

      Type

      Description

      serverId

      int

      (Required) Server ID

      hbaWwn

      string

      (Required) WWN of the HBA

    • To specify the iSCSI name

      Specify the serverId value and the iscsiName value, obtained by using the API function for getting information about the WWN of the HBA (iSCSI name), in the following format:

      serverId/hbas/iscsiName

      Attribute

      Type

      Description

      serverId

      int

      (Required) Server ID

      iscsiName

      string

      (Required) iSCSI name

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    Attribute

    Type

    Description

    statusResource

    string

    URL used to obtain the execution results of the delete the information about the WWN of an HBA (or the iSCSI name) from the server request

    Note

    Execute 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 DELETE https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/10/hbas/210003e08b0256f9

Getting a list of server path information

The following request obtains the path information of the specific server that corresponds to the specified server ID. You can also specify filter conditions.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/servers/object-ID/paths
Request message
  • Object ID

    Specify the id value obtained by getting information about the server.

    Attribute

    Type

    Description

    id

    int

    (Required) Server ID

  • Query parameters

    Parameter

    Type

    Filter Condition

    hbaWwn

    string

    (Optional) WWN of the HBA

    Path information is obtained about the server that has the WWN of the HBA that is a perfect match to the specified value.

    iscsiName

    string

    (Optional) iSCSI name

    Path information is obtained about the server that has the iSCSI name that is a perfect match to the specified value.

    portId

    string

    (Optional) Port ID of the assigned port

    Path information is obtained about the server that has the port ID of the assigned port that is a perfect match to the specified value.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when getting the path information of a Fibre Channel-connected server (ID 10):

    {
      "data": [
        {
          "id": "000000102cceccc9,CL1-A",
          "serverId": 10,
          "hbaWwn": "000000102cceccc9",
          "portId": "CL1-A"
        },
        {
          "id": "1111111111111111,CL1-A",
          "serverId": 10,
          "hbaWwn": "1111111111111111",
          "portId": "CL1-A"
        }
      ],
      "count": 2
    }

    The following is an example of the output when getting the path information of an iSCSI-connected server (ID 11):

    {
      "data": [
        {
          "id": "iqn.1994-05.com.redhat:496799ba93,CL1-B",
          "serverId": 11,
          "iscsiName": "iqn.1994-05.com.redhat:496799ba93",
          "portIds": "CL1-B"
        },
        {
          "id": "iqn.1994-05.com.redhat:a7526e46aa,CL1-B",
          "serverId": 11,
          "iscsiName": "iqn.1994-05.com.redhat:a7526e46aa",
          "portIds": "CL1-B"
        }
      ],
      "count": 2
    }

    The following is an example of the output when getting the path information of server with no paths defined:

    {
      "data": [],
      "count": 0
    }

    Attribute

    Type

    Description

    id

    string

    The WWN of the HBA (or iSCSI name) and the port ID of the assigned port appear in a format in which they are linked by a comma.

    serverId

    int

    Server ID

    hbaWwn

    string

    WWN of the HBA

    iscsiName

    string

    iSCSI name

    portId

    string

    Port ID of the assigned port

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/10/paths

Getting information about the paths between a server and a specific port

The following request obtains information about the paths between the server and the specific port that corresponds to the specified server ID, WWN of an HBA (or iSCSI name), and port ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/servers/object-ID/paths/object-ID
Request message
  • Object ID

    Combine multiple object IDs to be specified.

    Specify the serverId value and the id value, obtained by using the API function for getting the path information of the server, in the following format.

    serverId/paths/id

    For the id value, you can specify whether to obtain the information in a format that is a combination of the hbaWwn (or iscsiName) value and the portId value.

    • To specify the WWN of the HBA:

      serverId/paths/hbaWwn,portId

      Attribute

      Type

      Description

      serverId

      int

      (Required) Server ID

      hbaWwn

      string

      (Required) WWN of the HBA

      portId

      string

      (Required) Port ID

    • To specify the iSCSI name:

      serverId/paths/iscsiName,portId

      Attribute

      Type

      Description

      serverId

      int

      (Required) Server ID

      iscsiName

      string

      (Required) iSCSI name

      portId

      string

      (Required) Port ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when getting information about paths between a server (ID 10, WWN of the HBA: 000000102cceccc9) that is connected using Fibre Channel, and a specific port (ID CL1-A):

    {
      "id": "000000102cceccc9,CL1-A",
      "serverId": 10,
      "hbaWwn": "000000102cceccc9",
      "portId": "CL1-A"
    }

    The following is an example of the output when getting information about paths between a server (ID 11, iSCSI name: iqn.1994-05.com.redhat:496799ba93) that is connected using iSCSI, and a specific port (ID CL1-B):

    {
      "id": "iqn.1994-05.com.redhat:496799ba93,CL1-B",
      "serverId": 11,
      "iscsiName": "iqn.1994-05.com.redhat:496799ba93",
      "portId": "CL1-B"
    }

    For details about the attributes to be obtained, see the description of the API function for getting server path information.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/10/paths/000000102cceccc9,CL1-A

Adding path information to a server

The following request adds path information to the specific server that corresponds to the specified server ID.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/simple/v1/objects/servers/object-ID/paths
Request message
  • Object ID

    Specify the id value obtained by getting information about the server.

    Attribute

    Type

    Description

    id

    int

    (Required) Server ID

  • Query parameters

    None.

  • Body

    The following is an example of adding path information for a server (ID 10) that is connected using Fibre Channel:

    {
      "hbaWwn": "210003e08b0256f9",
      "portIds": [
        "CL1-A"
      ]
    }

    The following is an example of adding path information for a server (ID 11) that is connected using iSCSI:

    {
      "iscsiName": "iqn.myrestapiiscsi20150907",
      "portIds": [
        "CL1-B"
      ]
    }

    Attribute

    Type

    Description

    hbaWwn

    string

    (Optional) The WWN of the HBA in 16 lowercase characters.

    Specify either hbaWwn or iscsiName. Do not specify both of these attributes together.

    iscsiName

    string

    (Optional) The iSCSI name.

    Specify this item in iqn or eui format:

    • iqn format

      Specify a value that begins with iqn.. Use no more than 223 characters.

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

      Hyphen (-), period (.), colon (:)

      Specification example: iqn.rest.example.of.iqn.form

    • eui format

      After "eui.", specify a hexadecimal number. Specify a value consisting of 20 characters.

      You can use alphanumeric characters (0 through 9, A through F, a through f).

      Specification example: eui.0900ABDC32598D26

    Specify either hbaWwn or iscsiName. Do not specify both of these attributes together.

    portIds

    string[]

    (Required) The port IDs of the assigned ports.

Response message
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/10/paths

Detaching volumes from a server

If a server no longer needs to use a specific volume, you can detach that volume from the server.

  1. In the dashboard or in the navigation bar, click Servers.

  2. Select one or more servers and click GUID-198AE93D-687F-47EC-AB0E-E8435A0F01CB-low.gif (Detach Volumes).

    GUID-F82164A0-81F8-4EC6-8BA2-96C7D6003C43-low.gif

    Note that only those volumes that are attached to all of the selected servers can be detached.

  3. Select one or more volumes and detach them.

Deleting path information from a server

The following request deletes path information from a specific server.

Execution permission

Storage Administrator (Provisioning)

Request line

DELETE base-URL/simple/v1/objects/servers/object-ID/paths/object-ID
Request message
  • Object ID

    Combines multiple object IDs that are to be specified.

    Specify the serverId value and the id value, obtained by using the API function for getting the path information of the server, in the following format.

    serverId/paths/id

    For the id value, you can specify whether to obtain the information in a format that is a combination of the hbaWwn (or iscsiName) value and the portId value.

    • To specify the WWN of the HBA:

      serverId/paths/hbaWwn,portId

      Attribute

      Type

      Description

      serverId

      int

      (Required) Server ID

      hbaWwn

      string

      (Required) WWN of the HBA

      portId

      string

      (Required) Port ID

    • To specify the iSCSI name:

      serverId/paths/iscsiName,portId

      Attribute

      Type

      Description

      serverId

      int

      (Required) Server ID

      iscsiName

      string

      (Required) iSCSI name

      portId

      string

      (Required) Port ID

  • Query parameters

    None.

  • Body

    None.

Response message
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X DELETE https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/10/paths/210003e08b0256f9,CL1-A

Getting information about iSCSI targets

The following request obtains information about the iSCSI target that corresponds to the specified server ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/servers/object-ID/target-iscsi-ports
Request message
  • Object ID

    Specify the id value obtained by getting information about the server.

    Attribute

    Type

    Description

    id

    int

    (Required) Server ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when getting information about the iSCSI target of an iSCSI-connected server (ID 11):

    {
      "data": [
        {
          "portId": "CL1-B",
          "targetIscsiName": "iqn.rest.example.of.iqn.hostB"
        }
      ],
      "count": 1
    }

    Attribute

    Type

    Description

    portId

    string

    Port ID of the assigned port

    targetIscsiName

    string

    iSCSI name of the iSCSI target

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/11/target-iscsi-ports

Getting information about a specific iSCSI target

The following request obtains information about the iSCSI target that corresponds to the specified server ID and port ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/servers/object-ID/target-iscsi-ports/object-ID
Request message
  • Object ID

    Specify the id value and the portId value, obtained by using the API function for getting information about the server, in the following format:

    id/target-iscsi-ports/portId

    Attribute

    Type

    Description

    id

    int

    (Required) Server ID

    portId

    string

    (Required) Port ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of the output when getting information about the iSCSI target of an iSCSI-connected server (server ID: 11, port ID: CL1-B):

    {
      "portId": "CL1-B",
      "targetIscsiName": "iqn.rest.example.of.iqn.hostB"
    }

    For details about the attributes to be obtained, see the description of the API function for getting information about iSCSI targets.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/11/target-iscsi-ports/CL1-B

Changing the settings of an iSCSI target

The following request changes the iSCSI name of the iSCSI target that corresponds to the specified server ID and port ID.

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/simple/v1/objects/servers/object-ID/target-iscsi-ports/object-ID
Request message
  • Object ID

    Combines multiple object IDs that are to be specified.

    Specify the id value and the portId value, obtained by using the API function for getting information about the server, in the following format:

    id/target-iscsi-ports/portId

    Attribute

    Type

    Description

    id

    int

    (Required) Server ID

    portId

    string

    (Required) Port ID

  • Query parameters

    None.

  • Body

    The following is an example of changing the iSCSI name to iqn.rest.example.of.iqn.hostB for an iSCSI target of an iSCSI-connected server (server ID: 11, port ID: CL1-B):

    {
      "targetIscsiName": "iqn.rest.example.of.iqn.hostB"
    }

    Attribute

    Type

    Description

    targetIscsiName

    string

    (Required) Specifies the iSCSI name of the iSCSI target.

    Specify this item in iqn or eui format:

    • iqn format

      Specify a value that begins with iqn.. Use no more than 223 characters.

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

      Hyphen (-), period (.), colon (:)

      Specification example: iqn.rest.example.of.iqn.form

    • eui format

      After "eui.", specify a hexadecimal number. Specify a value consisting of 20 characters.

      You can use alphanumeric characters (0 through 9, A through F, a through f).

      Specification example: eui.0900ABDC32598D26

Response message
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers/11/target-iscsi-ports/CL1-B

Getting port information

The following request obtains information about ports.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/ports
Request message
  • Object ID

    None.

  • Query parameters

    Parameter

    Type

    Filter Condition

    protocol

    string

    (Optional) Specify one of the following values as the protocol of the port:

    • FC
    • iSCSI
  • Body

    None.

Response message
  • Body

    The following in an example of the output when information is obtained about all ports.

    {
      "data": [
        {
          "id": "CL1-A",
          "protocol": "FC",
          "portWwn": "50060e80124e3b00",
          "portSpeed": "NUMBER_0",
          "portSecurity": true,
          "fcInformation": {
            "alPa": "EF",
            "fabricSwitchSetting": true,
            "connectionType": "Point_To_Point",
            "sfpDataTransferRate": "NUMBER_16"
          }
        },
        {
          "id": "CL2-B",
          "protocol": "iSCSI",
          "portIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8s.i.120160.2b",
          "portSpeed": "NUMBER_10",
          "portSecurity": true,
          "iscsiInformation": {
            "vlanUse": false,
            "ipMode": "ipv4v6",
            "ipv4Information": {
              "address": "10.1.1.52",
              "subnetMask": "255.255.0.0",
              "defaultGateway": "0.0.0.0"
          },
            "ipv6Information": {
              "linklocal": "Auto",
              "linklocalAddress": "fe80::21f:67ff:feaf:c278",
              "global": "Auto",
              "globalAddress": "::",
              "defaultGateway": "::"
          },
          "tcpPort": 3260,
          "selectiveAck": true,
          "delayedAck": true,
          "windowSize": "NUMBER_64K",
          "mtuSize": "NUMBER_9000",
          "keepAliveTimer": 60,
          "isnsServerMode": false,
          "isnsServerIpAddress": "0.0.0.0",
          "isnsServerPort": 3205,
          "virtualPortEnabled": false
        }
      ],
      "count": 2
    }

    The following output is an example of information obtained about ports whose protocol is iSCSI (when iSCSI is specified in the protocol query parameter):

    {
      "data": [
        {
          "id": "CL2-B",
          "protocol": "iSCSI",
          "portIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8s.i.120160.2b",
          "portSpeed": "NUMBER_10",
          "portSecurity": true,
          "iscsiInformation": {
            "vlanUse": false,
            "ipMode": "ipv4v6",
            "ipv4Information": {
              "address": "10.1.1.52",
              "subnetMask": "255.255.0.0",
              "defaultGateway": "0.0.0.0"
          },
            "ipv6Information": {
              "linklocal": "Auto",
              "linklocalAddress": "fe80::21f:67ff:feaf:c278",
              "global": "Auto",
              "globalAddress": "::",
              "defaultGateway": "::"
          },
          "tcpPort": 3260,
          "selectiveAck": true,
          "delayedAck": true,
          "windowSize": "NUMBER_64K",
          "mtuSize": "NUMBER_9000",
          "keepAliveTimer": 60,
          "isnsServerMode": false,
          "isnsServerIpAddress": "0.0.0.0",
          "isnsServerPort": 3205,
          "virtualPortEnabled": false
        }
      ],
      "count": 1
    }

    Attribute

    Type

    Description

    id

    string

    Port ID

    protocol

    string

    Protocol that can be any of the following values:

    • FC
    • iSCSI

    portWwn

    string

    WWN of the port

    This attribute appears if the protocol is FC.

    portIscsiName

    string

    iSCSI name of the port

    This attribute appears if the protocol is iSCSI.

    portSpeed

    string

    Data transfer speed of the port:

    • NUMBER_0: Auto
    • NUMBER_1: 1 Gbps
    • NUMBER_2: 2 Gbps
    • NUMBER_4: 4 Gbps
    • NUMBER_8: 8 Gbps
    • NUMBER_10: 10 Gbps
    • NUMBER_16: 16 Gbps
    • NUMBER_32: 32 Gbps

    portSecurity

    boolean

    Whether the port security setting is enabled:

    • true: Enabled
    • false: Disabled

    fcInformation

    object

    FC information when the protocol is Fibre Channel:

    • alPa (string)

      Address of the port used for Arbitrated Loop Physical Address (AL_PA).

    • fabricSwitchSetting (boolean)

      Whether the fabric switch setting is enabled:

      • true: Enabled
      • false: Disabled
    • connectionType (string)

      Topology setting:

      • Point_To_Point
      • FC_AL
    • sfpDataTransferRate (string)

      Transfer rate:

      • NUMBER_16: 16 Gbps
      • NUMBER_32: 32 Gbps

    iscsiInformation

    object

    iSCSI information when the protocol is iSCSI:

    • vlanUse (boolean)

      Whether the VLANs are enabled:

      • true: Enabled
      • false: Disabled
    • vlanId (int)

      VLAN ID

      Appears only if VLANs are enabled.

    • ipMode (string)

      IP address format:

      • ipv4
      • ipv4v6
    • ipv4Information (object)

      IPv4 information:

      • address (string)

        IP address

      • subnetMask (string)

        Subnet mask

      • defaultGateway (string)

        Default gateway address

    • ipv6Information (object)

      IPv6 information:

      • linklocal (string)

        Method for setting the link local address:

        - Auto

        - Manual

      • linklocalAddress (string)

        Link local address

      • global (string)

        Method for setting the global address:

        - Auto

        - Manual

      • globalAddress (string)

        Global address

      • defaultGateway (string)

        Gateway address

    • tcpPort (int)

      TCP port number for iSCSI communications.

    • selectiveAck (boolean)

      Whether selective ACK is enabled:

      • true: Enabled
      • false: Disabled
    • delayedAck (boolean)

      Whether delayed ACK is enabled:

      • true: Enabled
      • false: Disabled
    • windowSize (string)

      Window size

    • mtuSize (int)

      MTU size

    • linkMtuSize (int)

      Link MTU size

    • keepAliveTimer (int)

      Value (in seconds) of the Keep Alive timer for iSCSI communications.

    • isnsServerMode (boolean)

      Whether iSNS server mode is enabled:

      • true: Enabled
      • false: Disabled
    • isnsServerIpAddress (string)

      IP address of the iSNS server (IPv4 or IPv6)

      The IP address in use when the iSNS server mode setting is enabled.

      If virtual ports are enabled, this attribute is hidden.

    • isnsServerPort (int)

      TCP port number of the iSNS server

      The TCP port number in use when the iSNS server mode setting is enabled.

      If virtual ports are enabled, this attribute is hidden.

    • virtualPortEnabled (boolean)

      Whether the virtual ports are enabled:

      • true: Enabled

        If this value is true, indicating that virtual ports are enabled, the information for which the virtual port number is 0 appears for the iscsiInformation attribute.

      • false: Disabled
Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/ports

Getting information about a specific port

This request gets information about the port for a specified port ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/ports/object-ID
Request message
  • Object ID

    Specify the id value obtained by getting information about the port.

    Attribute

    Type

    Description

    id

    int

    (Required) Port ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following output is an example of information obtained about a Fibre Channel port (port ID: CL1-A):

    {
      "id": "CL1-A",
      "protocol": "FC",
      "portWwn": "50060e80124e3b00",
      "portSpeed": "NUMBER_0",
      "portSecurity": true,
      "fcInformation": {
        "alPa": "EF",
        "fabricSwitchSetting": true,
        "connectionType": "Point_To_Point",
        "sfpDataTransferRate": "NUMBER_16"
      }
    }

    The following output is an example of information obtained about an iSCSI port (port ID: CL2-B):

    {
      "id": "CL2-B",
      "protocol": "iSCSI",
      "portIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8s.i.120160.2b",
      "portSpeed": "NUMBER_10",
      "portSecurity": true,
      "iscsiInformation": {
        "vlanUse": false,
        "ipMode": "ipv4v6",
        "ipv4Information": {
          "address": "10.1.1.52",
          "subnetMask": "255.255.0.0",
          "defaultGateway": "0.0.0.0"
      },
        "ipv6Information": {
          "linklocal": "Auto",
          "linklocalAddress": "fe80::21f:67ff:feaf:c278",
          "global": "Auto",
          "globalAddress": "::",
          "defaultGateway": "::"
      },
      "tcpPort": 3260,
      "selectiveAck": true,
      "delayedAck": true,
      "windowSize": "NUMBER_64K",
      "mtuSize": "NUMBER_9000",
      "keepAliveTimer": 60,
      "isnsServerMode": false,
      "isnsServerIpAddress": "0.0.0.0",
      "isnsServerPort": 3205,
      "virtualPortEnabled": false
    }

    For details on the attributes that are obtained, see the description of the API function for getting port information.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/ports/CL1-A

Changing port settings

The following request changes the settings of the port for the specified port ID.

Execution permission

Storage Administrator (Provisioning)

Request line

PATCH base-URL/simple/v1/objects/ports/object-ID
Request message
  • Object ID

    Specify the id value obtained by getting information about the port.

    Attribute

    Type

    Description

    id

    int

    (Required) Port ID

  • Query parameters

    None.

  • Body

    Only the specified attributes are changed.

    The following is an example of changing the settings of a Fibre Channel port (port ID: CL1-A):

    • Change the fabric switch setting to true.
    • Change the connection type to Point_To_Point.
    {
      "fcInformation": {
        "fabricSwitchSetting": true,
        "connectionType": "Point_To_Point"
      }
    }

    The following is an example of changing the settings of an iSCSI port (port ID: CL1-B):

    • Change the IPv6 link local address setting to Auto.
    • Change the IPv6 global address setting to Auto.
    • Change the selective ACK setting to true.
    • Change the value for the MTU size to NUMBER_4500.
    {
      "iscsiInformation": {
        "ipv6Information": {
          "linklocal": "Auto",
          "global": "Auto"
        },
        "selectiveAck": true,
        "mtuSize": "NUMBER_4500"
      }
    }

    Attribute

    Type

    Description

    portSpeed

    string

    (Optional) Data transfer speed of the port

    You can specify the following values:

    • NUMBER_0: Auto
    • NUMBER_1: 1 Gbps
    • NUMBER_2: 2 Gbps
    • NUMBER_4: 4 Gbps
    • NUMBER_8: 8 Gbps
    • NUMBER_10: 10 Gbps
    • NUMBER_16: 16 Gbps
    • NUMBER_32: 32 Gbps

    For iSCSI (optical) ports, the data transfer speed is specified and fixed as NUMBER_10 (10 Gbps). If a value other than NUMBER_10 is specified, that value will be ignored.

    portSecurity

    boolean

    (Optional) Specify whether to enable the port security setting:

    • true: Enable the port security setting
    • false: Disable the port security setting

    fcInformation

    object

    Change the FC settings. You change these settings only if the protocol is Fibre Channel:

    • (Optional) alPa (string)

      Specify the port address (AL_PA) by using a two-digit hexadecimal number (01 through EF).

    • (Optional) fabricSwitchSetting (boolean)

      Specify whether to enable the fabric switch setting:

      • true: Enable the fabric switch setting
      • false: Disable the fabric switch setting
    • (Optional) connectionType (string)

      Specify the connection type setting:

      • Point_To_Point
      • FC_AL

    iscsiInformation

    object

    Change the iSCSI settings. You can change these settings only if the protocol is iSCSI:

    • (Optional) vlanUse (boolean)

      Enable or disable the VLANs:

      • true: Enable the VLANs
      • false: Disable the VLANs
    • (Optional) addVlanId (int)

      Specify the VLAN ID to be added, as an integer from 1 through 4094. If you will also specify a VLAN ID to be deleted, make sure the VLAN ID to be added is not the same as the VLAN ID to be deleted.

    • (Optional) deleteVlanId (int)

      Specify the VLAN ID to be deleted, as an integer from 1 through 4094.

    • (Optional) ipMode (string)

      Specify the format of the IP address:

      • ipv4: Use IPv4
      • ipv4v6: Use IPv4 and IPv6
    • ipv4Information (object)

      Set IPv4 information:

      • (Optional) address (string)1

        Specify an IP address in IPv4 format by using 7 through 15 characters.

      • (Optional) subnetMask (string)

        Specify the subnet mask by using 7 through 15 characters.

      • (Optional) defaultGateway (string)

        Specify the address of the default gateway by using 7 through 15 characters.

    • ipv6Information (object)

      Set IPv6 information:

      • (Optional) linklocal (string)2

        Specify Auto (automatic), or specify a link local address by using 2 through 45 characters.

      • (Optional) global (string)2

        Specify Auto (automatic), or specify a global address by using 2 through 45 characters.

      • (Optional) defaultGateway (string)2

        Specify the address of the default gateway by using 2 through 45 characters.

    • (Optional) tcpPort (int)

      Specify the TCP port number for iSCSI communication as an integer from 1 through 65535.

    • (Optional) selectiveAck (boolean)

      Enable or disable selective ACK:

      • true: Enable selective ACK
      • false: Disable selective ACK
    • (Optional) delayedAck (boolean)

      Enable or disable delayed ACK:

      • true: Enable selective ACK
      • false: Disable selective ACK
    • (Optional) windowSize (string)

      Specify the window size.

      You can specify NUMBER_64K, NUMBER_128K, NUMBER_256K, NUMBER_512K, or NUMBER_1024K.

    • (Optional) mtuSize (int)

      Specify the MTU size.

      You can specify NUMBER_1500, NUMBER_4500, or NUMBER_9000.

    • (Optional) keepAliveTimer (int)

      Specify the value (in seconds) of the Keep Alive timer for iSCSI communications as an integer from 30 through 64800.

    • (Optional) isnsServerMode (boolean)

      Enable or disable the iSNS server mode:

      • true: Enable the iSNS server mode
      • false: Disable the iSNS server mode
    • (Optional) isnsServerIpAddress (string)

      Specify the IP address of the iSNS server in IPv4 or IPv6 format by using 2 through 45 characters.

    • (Optional) isnsServerPort (int)

      Specify the TCP port number of the iSNS server as an integer from 1 through 65535.

    • (Optional) virtualPortEnabled (boolean)

      Enable or disable the virtual ports:

      • true: Enable the virtual ports
      • false: Disable the virtual ports

    1 If you specify this attribute, you cannot specify the following addresses:

    - Network address (Example: 192.168.10.0)

    - Broadcast address (Example: 255.255.255.255)

    - Loopback address (Example: 127.0.0.1)

    2 If you specify this attribute, you cannot specify the following addresses:

    - No address specified (Example: ::)

    - Multicast address (Example: ff00:1024:1215::01)

    - Loopback address (Example: ::1)

Response message
  • Body

    Attribute

    Type

    Description

    affectedResources

    string[]

    List of URLs for referencing information about the changed port

    operationDetails

    object[]

    Details about the changed port

    For details, see the description of the operationDetails attribute of the commandStatus object.

Status codes

See HTTP status codes.

Coding example

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

Getting information about the connections between volumes and servers

The following request gets information about the connections between volumes and servers by using the server IDs or server nicknames of the specified servers.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/volume-server-connections
Request message
  • Object ID

    None.

  • Query parameters

    With each request, you can obtain information about a maximum of 2,048 connections between volumes and the server. To obtain information about additional connections between volumes and the server, execute the API request multiple times by using a combination of the count and startVolumeId parameters. By specifying the count parameter, you can also filter the volume information you require.

    Parameter

    Type

    Filter Condition

    serverId int

    (Optional) Specify the server ID of the server connected to the volume.

    The connection information of the server with the specified ID will be obtained.

    Specify either serverId or serverNickname. Do not specify both of these parameters together.

    serverNickname

    string

    (Optional) Specify the server nickname of the server connected to the volume.

    The connection information of the server with the specified server nickname will be obtained.

    Specify either serverId or serverNickname. Do not specify both of these parameters together.

    startVolumeId

    int

    (Optional) Specify a value in the range from 0 through 65279 as the volume ID from which to start obtaining information about the connections between volumes and the server.

    count

    int

    (Optional) Specify a value in the range from 1 through 2048 as the number of connections for which to obtain information about connections between volumes and the server.

    If this parameter is omitted, 2048 is considered.

  • Body

    None.

Response message
  • Body

    The following is an example of getting information about volumes and connection of the server with ID 10 (specifying 10 for the serverId query parameter).

    {
      "data": [
        {
          "id": "100,10",
          "volumeId": 100,
          "serverId": 10,
          "luns": [
            {
              "lun": 1,
              "portId": "CL1-A"
            }
          ]
        },
        {
          "id": "101,10",
          "volumeId": 101,
          "serverId": 10,
          "luns": [
            {
              "lun": 2,
              "portId": "CL1-A"
            }
          ]
        }
      ],
      "count": 2,
      "totalCount": 2,
      "hasNext": false
    }

    Attribute

    Type

    Description

    id

    string

    The volume ID and the server ID appear in a format in which they are connected by a comma.

    volumeId

    int

    Volume ID

    serverId

    int

    Server ID

    luns

    object[]

    Information about the LUN appears:

    • lun (int)

      LU number

    • portId (string)

      ID of the port to which the LU number is assigned

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/volume-server-connections?serverId=10

Getting information about the connection between a volume and a specific server

The following request gets information about the connection between a volume and a specific server by using a specified volume ID and server ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/volume-server-connections/object-ID
Request message
  • Object ID

    Specify the id value obtained by getting information about the connection between the volume and the server. The value of the obtained attribute id appears in the following format, in which the volume ID and the server ID are linked by a comma. You can specify these values (obtained by getting information about the connection between the volume and the server) in the command by using the same format: volumeId followed by serverId, linked by a comma.

    volumeId,serverId

    Attribute

    Type

    Description

    volumeId

    int

    (Required) Volume ID

    serverId

    int

    (Required) Server ID

  • Query parameters

    None.

  • Body

    None.

Response message
  • Body

    The following is an example of getting information about the connection between the volume with ID 100 and the server with ID 10:

    {
      "id": "100,10",
      "volumeId": 100,
      "serverId": 10,
      "luns": [
        {
          "lun": 1,
          "portId": "CL1-A"
        }
      ]
    }

    For details on the attributes that are obtained, see the description of the API function for getting information about the connections between volumes and servers.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/volume-server-connections/100,10

raidcom get server

Supported storage systems:

  • VSP G130, G/F350, G/F370, G/F700, G/F900

Displays a server managed by Storage Advisor Embedded. To execute this command, you need to log in to the storage system with the user account belonging to the user group to which "all resource groups" are set. In addition, you need to perform operations with all implemented resource groups. Therefore, this command cannot be executed if any of the following conditions is met:

  • The command device belonging to a resource group other than meta_resource is used in the in-band management.
  • The virtual storage machine that contains only some of the implemented resource groups is specified as HORCM_VCMD in the configuration file.
Syntax
raidcom get server [-key <keyword> [-server_id <id>|-server_name <name>]]
Options and parameters
  • [-key <keyword> [-server_id <id>|-server_name <name>]]

    Specifies the server information to be displayed.

    • opt: Specifies the detailed information about the server. To specify this parameter, make sure to specify the server ID or nickname that displays the detailed information in -server_id <id> or -server_name <name>.

You need to specify the server ID (0 through 4095) in decimal or hexadecimal in -server_id <id>. To specify in hexadecimal, add "0x" at the beginning of the server ID.

For example:

  • -server_id 128
  • -server_id 0x80

To specify the server nickname, specify the server nickname in -server_name <name> with one character through 229 characters.

The following are the characters that can be used:

0 through 9, A through Z, a through z, -. /: @ \ _ single-byte space

Example

Displaying server information.

#raidcom get server
SRVID NAME
0 "server0"
1 "server1"
155 "server2
Description of each column in the output example:
  • SRVID

    Displays the server ID in decimal.

  • NAME

    Displays the server nickname. A double quotation (") is added at the beginning and end of the server nickname if the -key opt option is not specified.

Specifying the server information to be displayed.

#raidcom get server -key opt -server_id 0
SRVID : 0
NAME : server0
STS : RCV DGG1
PROTOCOL : FIBRE
OS : WIN
OS_OPT : 1 3
Description of each column in the output example:
  • STS

    Status of the server. The status of the server is not displayed if it is not in any of the following statuses:

    • RSV: Protocol, OS type, and OS type option are not set.

      When setting the host group/iSCSI target to the server with the raidcom modify server command, the OS type is set based on the host mode of the host group/iSCSI target.

    • ILU: No LU path is defined between any of the LDEV registered on the server and any of the host group/iSCSI target registered on the server.
    • IOT: The OS type of the server does not correspond to the host mode of any of the host group/iSCSI target registered on the server.
    • IOP: The OS type of the server does not correspond to the host mode option of any of the host group/iSCSI target registered on the server.
    • RCV: The host group/iSCSI target, LU path, or LDEV information on the server is being updated.
    • DGG1: For VSP G/F350, G/F370, G/F700, G/F900, the microcode version cannot be downgraded to 88-01-xx-xx/xx or earlier.
  • PROTOCOL

    Displays the protocol of the server.

    • FIBRE: The protocol is Fiber Channel.
    • ISCSI: The protocol is iSCSI.
    • - (hyphen): The protocol is not either Fiber Channel or iSCSI.
  • OS

    Displays the OS type of the server. If other OS types are displayed, the OS type that is not supported by Storage Advisor Embedded is set.

    • LINUX/IRIX: The OS type is "Linux".
    • VMWARE: The OS type is "(Deprecated) VMware".
    • HP-UX: The OS type is "HP-UX".
    • OVMS: The OS type is "OpenVMS".
    • TRU 64: The OS type is "Tru64".
    • SOLARIS: The OS type is "Solaris".
    • NETWARE: The OS type is "NetWare".
    • WIN: The OS type is "(Deprecated) Windows".
    • AIX: The OS type is "AIX".
    • VMWARE_EX: The OS type is "VMWare".
    • WIN_EX: The OS type is "Windows".
    • - (hyphen): No OS type is set.
  • OS_OPT

    OS type options that are set on the server. A hyphen (-) is displayed if the OS type is not set.

raidcom add server

Supported storage systems:

  • VSP G130, G/F350, G/F370, G/F700, G/F900

Creates a server managed by Storage Advisor Embedded. To execute this command, you need to log in to the storage system with the user account belonging to the user group to which "all resource groups" are set. In addition, you need to perform operations with all implemented resource groups. Therefore, this command cannot be executed if any of the following conditions is met:

  • The command device belonging to a resource group other than meta_resource is used in the in-band management.
  • The virtual storage machine that contains only some of the implemented resource groups is specified as HORCM_VCMD in the configuration file.
Syntax
raidcom add server -server_name <name> -request_id auto
Options and parameters
-server_name <name> -request_id auto

Specifies the server nickname with one character through 229 characters.

The following are the characters that can be used:

0 through 9, A through Z, a through z, -. /: @ \ _ single-byte space

This command creates a server with no OS type set. 255 servers are created in the storage system.

The server ID is automatically selected. You can check the selected server ID using the raidcom get command_status command.

The selected server ID is output after completion of the raidcom add server command.

The server ID is output in the following format:

  • REQID: <request#>

    Where <request#> is a request ID assigned each time the command is executed. The raidcom get command_status command uses the ID when waiting for completion of server creation. For details, see the description of the raidcom get command_status command.

The request ID might be output when the command execution fails. If the request ID is output, check the error information with raidcom get command_status command, and release the request ID by the raidcom reset command_status -request_id <request#> command or raidcom reset command_status -request_id all command. 65,280 request IDs can be used in a storage system.

If there are no request IDs you can use, the command fails with EX_IDEXHA. In this case, release the unused request IDs by the following procedure, and then execute the command again. Alternatively, ask another user who uses a request ID to release it, and then execute the command.

Procedure for releasing request IDs:

  1. Use the raidcom get command_status command to check the error information of the request ID for which error information you did not check.
  2. Release the request ID by using the raidcom reset command_status -request_id <request#> command or the raidcom reset command_status -request_id all command.

Example

Creating a server with the server name: server0.

#raidcom add server -server_name server0 -request_id auto
 REQID:0

raidcom delete server

Supported storage systems:

  • VSP G130, G/F350, G/F370, G/F700, G/F900

Deletes a server managed by Storage Advisor Embedded. To execute this command, you need to log in to the storage system with the user account belonging to the user group to which "all resource groups" are set. In addition, you need to perform operations with all implemented resource groups. Therefore, this command cannot be executed if any of the following conditions is met:

  • The command device belonging to a resource group other than meta_resource is used in the in-band management.
  • The virtual storage machine that contains only some of the implemented resource groups is specified as HORCM_VCMD in the configuration file.
Syntax
raidcom delete server {-server_id <id>|-server_name <name>} -request_id auto
Options and parameters
{-server_id <id>|-server_name <name>} -request_id auto

Specifies the ID or nickname of the server to be deleted.

You need to specify the server ID (0 through 4095) in decimal or hexadecimal in -server_id <id>. To specify in hexadecimal, add "0x" at the beginning of the server ID.

For example:

  • -server_id 128
  • -server_id 0x80

To specify the server nickname, specify the server nickname in -server_name <name> with one character through 229 characters.

The following are the characters that can be used:

0 through 9, A through Z, a through z, -. /: @ \ _ single-byte space

The specified server is deleted by executing this command. The registered host groups or iSCSI targets are not deleted. The deleted server ID is output after completion of the raidcom delete server command.

The server ID is output in the following format:

  • REQID: <request#>

    Where <request#> is a request ID assigned each time the command is executed. The raidcom get command_status command uses the ID when waiting for completion of server creation. For details, see the description of the raidcom get command_status command.

The request ID might be output when the command execution fails. If the request ID is output, check the error information with raidcom get command_status command, and release the request ID by the raidcom reset command_status -request_id <request#> command or raidcom reset command_status -request_id all command. 65,280 request IDs can be used in a storage system.

If there are no request IDs you can use, the command fails with EX_IDEXHA. In this case, release the unused request IDs by the following procedure, and then execute the command again. Alternatively, ask another user who uses a request ID to release it, and then execute the command.

Procedure for releasing request IDs:

  1. Use the raidcom get command_status command to check the error information of the request ID for which error information you did not check.
  2. Release the request ID by using the raidcom reset command_status -request_id <request#> command or the raidcom reset command_status -request_id all command.

Example

Deleting a server with the server ID: 0.

#raidcom delete server -server_id 0 -request_id auto
REQID:0

raidcom modify server

Supported storage systems:

  • VSP G130, G/F350, G/F370, G/F700, G/F900

Modifies a server managed by Storage Advisor Embedded. To execute this command, you need to log in to the storage system with the user account belonging to the user group to which "all resource groups" are set. In addition, you need to perform operations with all implemented resource groups. Therefore, this command cannot be executed if any of the following conditions is met:

  • The command device belonging to a resource group other than meta_resource is used in the in-band management.
  • The virtual storage machine that contains only some of the implemented resource groups is specified as HORCM_VCMD in the configuration file.
Syntax
raidcom modify server {-server_id <id>|-server_name <name>} -request_id auto {-server_operation {add_host_grp|delete_host_grp} -port <port> [<host group name>]}
Options and parameters
  • {-server_id <id>|-server_name <name>} -request_id auto

    Specifies the ID or nickname of the server to be modified.

    You need to specify the server ID (0 through 4095) in decimal or hexadecimal in -server_id <id>. To specify in hexadecimal, add "0x" at the beginning of the server ID. For example:

    • -server_id 128
    • -server_id 0x80

    To specify the server nickname, specify the server nickname in -server_name <name> with one character through 229 characters.

    The following are the characters that can be used:

    0 through 9, A through Z, a through z, -. /: @ \ _ single-byte space

    The specified server is deleted by executing this command. The registered host groups or iSCSI targets are not deleted. The deleted server ID is output after completion of the raidcom modify server command.

    The server ID is output in the following format:

    • REQID: <request#>

    Where <request#> is a request ID assigned each time the command is executed. The raidcom get command_status command uses the ID when waiting for completion of server creation. For details, see the description of the raidcom get command_status command.

    The request ID might be output when the command execution fails. If the request ID is output, check the error information with raidcom get command_status command, and release the request ID by the raidcom reset command_status -request_id <request#> command or raidcom reset command_status -request_id all command. 65,280 request IDs can be used in a storage system.

    If there are no request IDs you can use, the command fails with EX_IDEXHA. In this case, release the unused request IDs by the following procedure, and then execute the command again. Alternatively, ask another user who uses a request ID to release it, and then execute the command.

    Procedure for releasing request IDs:

    1. Use the raidcom get command_status command to check the error information of the request ID for error information you did not check.

    2. Release the request ID by the raidcom reset command_status -request_id <request#>

      command or the raidcom reset command_status -request_id all

      command.

  • -server_operation add_host_grp -port <port> [<host group name>]

    Registers the host groups or the iSCSI targets specified with the -port <port> [<host group name>] on the server specified for the -server_id <id> or the -server_name <name>.

    If the WWN or iSCSI name of the host is registered in the specified host groups or iSCSI targets, the WWN or iSCSI name of the host is registered on the server. In addition, if an LU path is defined for a specified host groups or iSCSI targets, the LDEV associated with the LU path is registered on the server.

    For -port <port> [<host group name>], specify the port number and host groups (iSCSI target ID for iSCSI), or host group name (target alias for iSCSI).

    If the host group name or the target alias is more than 64 characters, the host group name or the target alias cannot be specified. Use the host group ID or the target ID. For example:

    • CL1-A -g (g is from 1 to 254)
    • CL1-A Linux_X86
    • CL1-A Target00

    To check if host groups or iSCSI targets are registered on the server, execute the raidcom get host_grp command with the -key server option specified.

    If any of the following conditions is met, the command execution fails:

    • The specified server and host group/iSCSI target are not installed.
    • The IDs of the specified host groups or iSCSI targets are 0.
    • The host group/iSCSI target, LU path, or LDEV information on the specified server is being updated.
    • The iSCSI target is specified even if the specified server protocol is Fibre. Alternatively, a host group is specified even if the specified server protocol is iSCSI.
    • The host group/iSCSI target which has already been registered on other servers is specified.
    • Another host group/iSCSI target on the same port as the one used for the specified host group/iSCSI target has already been registered on the specified server.
    • If 32 WWNs or iSCSI names of the host have been registered on the specified server, the host group/iSCSI target including WWNs or iSCSI names that are not registered on the server is specified.
    • The specified host group/iSCSI target, the port to which the host group/iSCSI target belongs, or the resource group to which the LDEV associated with the LU path of the host group/iSCSI target belongs is locked by another user.
    • The LU path to an LDEV other than that for Dynamic Provisioning, Dynamic Tiering, or active flash exists in the specified host group/iSCSI target.
    • The LDEV for a Volume Migration pair including LDEV other than that for Dynamic Provisioning, Dynamic Tiering, or active flash is specified.
    • The host group/iSCSI target on the port with the LU security set to OFF is specified.
  • -server_operation delete_host_grp -port <port> [<host group name>]

    Specifies the iSCSI virtual port ID when the specified port is iSCSI and the iSCSI virtual port mode is enabled. If this option is omitted, 0 is assumed.

    From the server specified for -server_id <id> or -server_name <name>, delete the host groups or iSCSI targets specified with -port <port> [<host group name>].

    The LDEV is deleted from the server if an LU path is defined for the specified host groups or iSCSI targets, and if the LU path is the last one of the LDEV associated with the LU path on the specified server.

    For -port <port> [<host group name>], specify the port number and host groups (iSCSI target ID for iSCSI), or the host group name (target alias for iSCSI). If the host group name or the target alias is more than 64 characters, the host group name or the target alias cannot be specified. Use the host group ID or the target ID.

    For example:

    • CL1-A -g (g is from 1 to 254)
    • CL1-A Linux_X86
    • CL1-A Target00

    To check if host groups or an iSCSI targets are registered on the server, execute the raidcom get host_grp command with the -key server option specified.

    If any of the following conditions is met, the command execution fails:

    • The specified server and host group/iSCSI target are not installed.
    • The IDs of the specified host groups or iSCSI targets are 0.
    • The host group/iSCSI target, LU path, or LDEV information on the specified server is being updated.
Examples

Adding CL1-A-1 to server ID: 0.

#raidcom modify server -server_id 0 -request_id auto -server_operation add_host_grp -port CL1-A-1
REQID:0

Deleting CL1-A-1 from server ID: 0.

#raidcom modify server -server_id 0 -request_id auto -server_operation delete_host_grp -port CL1-A-1
REQID:0

raidcom get host_grp

Displays the information about all host groups or an iSCSI target that are defined on the specified port.

Syntax
raidcom get host_grp {-port <port#> [<host group name>]| -allports} [-key <keyword>]
Options and parameters
  • -port <port#> [<host group name>]

    Specifies the port number, host group ID, and host group name (iSCSI target name for iSCSI). If the host group name or the iSCSI target name is more than 64 characters, use the host group ID or the iSCSI target ID.

    For example:

    • CLI-A
    • CL1-A-g (g is from 0 to 254)
    • CL1-A Linux_X86
    • CL1-A Target00

    If you specified the above settings, the information about all host groups that are defined on the specified port is displayed regardless of the examples.

  • -allports

    Displays the information about the host groups or the iSCSI target that is set to all ports.

  • [-key <keyword>]

    Specifies either one of the following:

    • host_grp: Specifies the host group IDs that are not installed.
    • server: Specifies the information about the server managed by Storage Advisor Embedded on which the host group or the iSCSI target is registered.

      This parameter can be specified only for VSP G/F350, G/F370, G/F700, G/F900.

Example

Displaying the host group information set for the port: CL4-E (in case of other than iSCSI).

# raidcom get host_grp -port CL4-E
PORT   GID  GROUP_NAME      Serial#    HMD          HMO_BITs
CL4-E    0  Linux_x86       63528      LINUX/IRIX    2 13
CL4-E    1  Solaris         63528      SOLARIS       2 22
CL4-E    2  HP-UX           63528      HP-UX         40
CL4-E    3  Win_export      63528      WIN_EX        7
CL4-E    5  DEC             63528      TRU64         14
CL4-E    6  OpenVMS         63528      OVMS
CL4-E  254  RMTEST          63528      LINUX         7
# raidcom get host_grp -port CL4-E -key host_grp
PORT   GID  GROUP_NAME      Serial#    HMD          HMO_BITs
CL4-E  0    Linux_x86       63528      LINUX/IRIX   2 13
CL4-E  1    Solaris         63528      SOLARIS      2 22
CL4-E  2    HP-UX           63528      HP-UX        40
CL4-E  3    Win_export      63528      WIN_EX       7
CL4-E  5    DEC             63528      TRU64        14
CL4-E  6    OpenVMS         63528      OVMS
CL4-E  10   -               63528      -
CL4-E  11   -               63528      -
CL4-E  12   -               63528      -
CL4-E  13   -               63528      -
CL4-E  254  RMTEST          63528      LINUX         7
Displaying the iSCSI target information set for the port: CL4-E (in case of iSCSI)
# raidcom get host_grp -port CL4-E
PORT  GID  GROUP_NAME IQN      AMD  D Serial# HMD        HMO_BITs
CL4-E   0  Linux_x86  iqn.z1… CHAP S 63528   LINUX/IRIX 2 13
CL4-E   1  Solaris    iqn.z2… CHAP S 63528   SOLARIS    2 22
CL4-E   2  HP-UX      iqn.z3… CHAP S 63528   HP-UX      40
Displaying the information about the host groups or the iSCSI targets that are set for the port: CL4-E (in case of iSCSI and Fibre Channel)
# raidcom get host_grp -port CL4-E -key server

PORT	 GID 	GROUP_NAME  Serial# 	SRVID 	     SRV_NAME
CL4-E	 0 	 Linux_x86  	63528    	N 	           -
CL4-E 	1  	Solaris 	  	63528 	   1 	        "server01"
CL4-E	 2 	 HP-UX 	    	63528    	N 	           -
CL4-E 	3  	Win_export 	63528	    N            	- 
CL4-E 	5 	 DEC 		      63528    	N 	           -
CL4-E 	6 	 OpenVMS    	63528    	N 	           -
CL4-E 	254 RMTEST 	    63528    	N            	-
Displaying the information about the host groups or the iSCSI targets that are set to all ports
# raidcom get host_grp -allports
PORT   GID   GROUP_NAME     Serial# HMD
CL1-A  0     Linux_x86        63528 LINUX/IRIX
CL1-A  1     Solaris          63528 SOLARIS
CL1-A  2     HP-UX            63528 HP-UX
CL1-A  3     Win_export       63528 WIN_EX
CL1-A  5     DEC              63528 TRU64
CL1-A  6     OpenVMS          63528 OVMS
CL1-A  254   RMTEST           63528 LINUX
CL1-B  0     Linux_x86        63528 LINUX/IRIX
CL1-B  1     Solaris          63528 SOLARIS
CL1-B  2     HP-UX            63528 HP-UX
CL1-B  3     Win_export       63528 WIN_EX
CL1-B  5     DEC              63528 TRU64
CL1-B  6     OpenVMS          63528 OVMS
CL1-B  254   RMTEST           63528 LINUX
# raidcom get host_grp -allports -key host_grp
PORT   GID   GROUP_NAME     Serial#   HMD
CL1-A  0     Linux_x86        63528   LINUX/IRIX
CL1-A  1     Solaris          63528   SOLARIS
CL1-A  2     HP-UX            63528   HP-UX
CL1-A  3     Win_export       63528   WIN_EX
CL1-A  5     DEC              63528   TRU64
CL1-A  6     OpenVMS          63528   OVMS
CL1-A  10    -                63528   -
CL1-A  11    -                63528   -
CL1-A  12    -                63528   -
CL1-A  13    -                63528   - 
CL1-A  254   RMTEST           63528   LINUX
CL1-B  0     Linux_x86        63528   LINUX/IRIX
CL1-B  1     Solaris          63528   SOLARIS
CL1-B  2     HP-UX            63528   HP-UX
CL1-B  3     Win_export       63528   WIN_EX
CL1-B  5     DEC              63528   TRU64
CL1-B  6     OpenVMS          63528   OVMS
CL1-B  10    -                63528   -
CL1-B  11    -                63528   -
CL1-B  12    -                63528   -
CL1-B  13    -                63528   -
CL1-B  254   RMTEST           63528   LINUX
# raidcom get host_grp -allports -key server
PORT   	GID  	GROUP_NAME   Serial# 	SRVID 	SRV_NAME
CL1-A   	0    Linux_x86   	63528 	   N 		   	-
CL1-A 	  1 	  Solaris 		   63528 	   1    	"server01"
CL1-A   	2 	  HP-UX 		     63528    	N 	-
CL1-A   	3 	  Win_export 	 63528    	N 	-
CL1-A   	5 	  DEC 	       	63528 	   N 	-
CL1-A 	  6 	  OpenVMS 	    63528 	   N 	-
CL1-A    254 	RMTEST 	     63528    	N 	-
CL1-B    0 	  Linux_x86 	  63528    	N 	-
CL1-B   	1 	  Solaris 		   63528 	   N 	-
CL1-B   	2 	  HP-UX 		     63528    	N 	-
CL1-B   	3  	 Win_export 	 63528     N 	-
CL1-B   	5 	  DEC 		       63528 	   N 	-                                                                        

Displaying only the host group IDs that are allocated to available resource groups for users.

Description of each column in output example:
  • PORT

    Displays the port number.

  • GID

    Displays the host group ID of a port.

  • GROUP_NAME

    Displays the host group name of a port.

  • IQN

    Displays the iSCSI Qualified Name of the port.

  • AMD

    Displays the authentication mode of the iSCSI target.

    • CHAP: CHAP authentication is enabled.
    • NONE: Authentication is disabled.
    • BOTH: Both CHAP authentication and connection by no-authentication are enabled.
  • D

    Displays the direction of the authentication mode of the iSCSI target.

    • S: Unidirectional (An initiator is recognized from the target side)
    • D: Bidirectional (An initiator is recognized from the target side, and a target is recognized from the initiator)
  • Serial#

    Product serial number. For VSP G1x00 and VSP F1500 the serial number is displayed with a “3” added to the beginning (for example, “312345” = serial number 12345).

  • HMD

    Displays the following HOST MODE for the host adapter setting on host group.

    • HP-UX, SOLARIS, AIX, WIN, LINUX/IRIX, TRU64, DYNIX, OVMS, NETWARE, HI-UX
    • VMWARE, HP-XP, VMWARE_EX, WIN_EX, UVM
  • HMO_BITs

    Displays the host mode options of the host group. For details, see the Provisioning Guide for the storage system.

  • SRVID

    Displays the server ID for the Storage Advisor Embedded on which the host groups or the iSCSI targets are registered in decimal. Displays ”N” if they are not registered on the server. Displays a hyphen (-) if the microcode version does not support the server ID indication.

  • SRV_NAME

    Displays the nickname of the server identified by SRVID. A double quotation (") is added at the beginning and end of the server nickname. A hyphen (-) is displayed if SRVID is" N "or hyphen (-).

raidcom modify port

Sets the attribute of the specified port.

When you set a port attribute by options other than a -port_attribute option, the port type of the specified port must be one of the following:

  • FIBRE
  • FCoE
  • iSCSI

If these conditions are not satisfied, this command is rejected with EX_ENOOBJ.

When using an FCoE package, specify Port speed: 10G, Port topology: f_port. In this case, the port attribute cannot be changed.

When you set the T10 PI mode, this command is executed asynchronously with the command input. Check the completion of this process using the raidcom get command_status command.

The syntax is separated into 6 groups as follows. Syntaxes 2 through 6 can be used only for iSCSI ports. If you execute a command that includes options in syntax 3 with options in syntax 2, 4, 5, or 6, an error occurs.

Syntax

Syntax 1

raidcom modify port -port <port#>{[-port_speed <value>]
   [-loop_id <value>][-topology <topology>][-security_switch 
   {y | n}] | -port_attribute <port attribute> | -t10pi {enable|disable}
    | -iscsi_virtual_port_mode {enable|disable}}

Syntax 2

raidcom modify port -port <port#> [-mtu <value>]
   [-vlan_tagging_mode {enable|disable}] [-add_vlan_id <value>]
   [-delete_vlan_id <value>] [-modify_vlan_id <new value>]
   [-ipv4_address <address>] [-ipv4_subnetmask <subnet mask>]
   [-ipv4_gateway_address <address>] [-ipv6_mode {enable|disable}]
   [-ipv6_local_address {auto|<address>}] 
   [-ipv6_global_address {auto|<address>}]
   [-ipv6_gateway_address <address>] [-tcp_port <value>]
   [-selective_ack_mode {enable|disable}] 
   [-delayed_ack_mode {enable|disable}]
   [-window_size <size>] [-keep_alive_timer <value>]
   [-ipv6_global_address2 <address>]

Syntax 3

raidcom modify port -port <port#> [-isns_mode {enable|disable}]
   [-isns_server_address <IPv4 address|IPv6 address>]
   [-isns_port <iSNS TCP Port number>]

Syntax 4

raidcom modify port -port <port> -add_iscsi_virtual_port <value>
   -ipv6_mode {enable|disable} [-mtu <value>] 
   [-vlan_tagging_mode {enable|disable}] [-add_vlan_id <value>] 
   [-ipv4_address <address>] [-ipv4_subnetmask <subnet mask>]
   [-ipv4_gateway_address <address>] 
   [-ipv6_local_address {auto|<address>}] 
   [-ipv6_global_address {auto|<address>}]
   [-ipv6_gateway_address <address>] [-tcp_port <value>]
   [-selective_ack_mode {enable|disable}] 
   [-delayed_ack_mode {enable|disable}]
   [-window_size <size>] [-keep_alive_timer <value>]

Syntax 5

raidcom modify port -port <port> -modify_iscsi_virtual_port <value>
   [-mtu <value>] [-vlan_tagging_mode {enable|disable}]
   [-add_vlan_id <value>] [-delete_vlan_id <value>]
   [-modify_vlan_id <new value>]
   [-ipv4_address <address>] [-ipv4_subnetmask <subnet mask>]
   [-ipv4_gateway_address <address>] [-ipv6_mode {enable|disable}]
   [-ipv6_local_address {auto|<address>}] [-ipv6_global_address {auto|<address>}]
   [-ipv6_gateway_address <address>] [-tcp_port <value>]
   [-selective_ack_mode {enable|disable}] [-delayed_ack_mode {enable|disable}]
   [-window_size <size>] [-keep_alive_timer <value>]
   [-ipv6_global_address2 <address>]

Syntax 6

raidcom modify port -port <port> -delete_iscsi_virtual_port <value>
Options and parameters
  • -port <port#>

    Specifies the port number. For example:

    • CL1-A
  • [-port_speed <value> ]

    Specifies the HOST speed (0, 1, 2, 4, 8, 10, 16, 32) as follows.

    • 0: AUTO
    • 1: 1G
    • 2: 2G
    • 4: 4G
    • 8: 8G
    • 10: 10G
    • 16: 16G
    • 32: 32G
  • [-loop_id <alpa value> ]

    Specifies the Loop ID (0x01-0xEF) of the Port.

  • [-topology <topology> ]

    Specifies the topology of the Port as follows:

    • fl_port: fabric on and fcal
    • f_port: fabric on and PtoP
    • nl_port: fabric off and fcal
    • n_port: fabric off and PtoP
  • [-security _switch {y | n} ]

    Specifies whether to use the security switch or not.

  • -port_attribute <port attribute>

    Specifies the Port attribute as follows:

    • TAR: Fibre target port (target port)
    • MCU: MCU initiator port (initiator port)
    • RCU: RCU target port (RCU target port)
    • ELUN: External initiator port (External port)

    If the port is a bidirectional port, a user cannot change the port attribute. The storage system detects the appropriate attribute of the port, and then operates the port with the detected attribute.

    If this port attribute is changed from Target or RCU Target to Initiator or External, the host group belonging to this port belongs to meta_resource.

  • -t10pi {enable|disable}

    Specifies the T10 PI mode as follows:

    • enable: T10 PI mode is enable
    • disable: T10 PI mode is disable

    When you change the T10 PI mode, the T10 PI mode of the ports which share the settings with the port are also changed. The user who executes the command must have authority of the specified port and the ports which share the settings with the port. Details about the ports which share the settings with the specified port, see the Provisioning Guide for the storage system.

  • -iscsi_virtual_port_mode {enable|disable}

    Specifies the iSCSI virtual port mode as follows:

    • enable: iSCSI virtual port mode is enabled
    • disable: iSCSI virtual port mode is disabled

    The setting of the iSCSI virtual port mode is shared among all ports on the channel board adapter (CHA) or channel board (CHB) to which ports specified for -port <port> belong.

    When you change the iSCSI virtual port mode, the iSCSI virtual port mode of the ports that share the settings with the port is also changed. The user who executes the command must have authority of the specified port and the ports that share the settings with the port. For details about the ports that share the settings with the specified port, see the Provisioning Guide for the storage system.

    If you specify this option when the device does not support the iSCSI virtual port, an error occurs.

  • [-mtu <value>]

    Specifies the MTU value (1500/4500/9000) used during iSCSI communication. When you omit the specification, the MTU value is not changed.

    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-vlan_tagging_mode {enable|disable}]

    Specifies the availability of Tag VLAN. When you omit the specification, the settings for the availability of Tag VLAN is not changed.

    • enable: enable Tag VLAN
    • disable: disable Tag VLAN
    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-add_vlan_id <value>]

    Specifies the adding VLAN ID (1-4094). When you omit the specification, the VLAN ID is not added.

    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

    If you specify a virtual port, Tag VLAN is enabled.

  • [-delete_vlan_id <value>]

    Specifies the deleting VLAN ID (1-4094). Also, Tag VLAN is disabled. When you omit the specification, the VLAN ID is not deleted.

    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-modify_vlan_id <new value>]

    Specifies the VLAN ID (1 to 4094). The VLAN ID is changed to the specified ID. When you omit this specification, the VLAN ID is not changed.

    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

    If you specify this option for a port or virtual port for which VLAN ID is not set, an error occurs.

  • [-ipv4_address <address>]

    Specifies the IPv4 address. When you omit the specification, the IPv4 address is not changed.

    This option is required if you specify both -add_iscsi_virtual_port and -ipv6_mode disable.

    You cannot specify following IPv4 addresses:

    • Network address (For example 192.168.10.0 or 0.120.10.1)
    • Broadcast address (For example 255.255.255.255 or 10.1.255.255)
    • Loopback address (For example 127.0.0.1)
    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-ipv4_subnetmask <subnet mask>]

    Specifies the IPv4 subnet mask. When you omit the specification, the IPv4 subnet mask is not changed.

    This option is required if you specify both -add_iscsi_virtual_port and -ipv6_mode disable.

    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-ipv4_gateway_address <address>]

    Specifies the IPv4 default gateway address. When you omit the specification, the IPv4 default gateway address is not changed.

    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-ipv6_mode {enable|disable}]

    Specifies the availability of IPv6 mode. When you omit the specification, the settings for the availability of IPv6 mode is not changed.

    • enable: enable IPv6 mode
    • disable: disable IPv6 mode
    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

    This option is required if you specify -add_iscsi_virtual_port. The operation modes for iSCSI virtual ports are as follows:

    • enable: IPv6 address is enabled.
    • disable: IPv4 address is enabled. In this case, specify both -ipv4_address <address> and -ipv4_subnetmask <subnet mask>.
  • [-ipv6_local_address {auto|<address>}]

    Specifies the IPv6 link local address. When you omit the specification, the IPv6 link local address is not changed.

    When you specify "auto", the address is set automatically. When you set the address manually, enter the IPv6 address for <address>.

    You cannot specify following IPv6 addresses:

    • Not set (For example ::)
    • Multicast address (For example ff00:1024:1215::01)
    • Loopback address (For example ::1)
    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-ipv6_global_address {auto|<address>}]

    Specifies the IPv6 global address. When you omit the specification, the IPv6 global address is not changed.

    When you specify "auto", the address is set automatically. When you set the address manually, enter the IPv6 address for <address>.

    You cannot specify following IPv6 addresses:

    • Multicast address (For example ff00:1024:1215::01)
    • Loopback address (For example ::1)
    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-ipv6_gateway_address <address>]

    Specifies the IPv6 gateway address. When you omit the specification, the IPv6 gateway address is not changed.

    You cannot specify following IPv6 addresses:

    • Multicast address (For example ff00:1024:1215::01)
    • Loopback address (For example ::1)
    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-tcp_port <value>]

    Specifies the TCP port number (1 - 65535) during iSCSI communication. When you omit the specification, the TCP port number is not changed.

    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-selective_ack_mode {enable|disable}]

    Specifies the availability of selective ACK. When you omit the specification, the settings of the selective ACK is not changed.

    • enable: enable selective ACK
    • disable: disable selective ACK
    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-delayed_ack_mode {enable|disable}]

    Specifies the availability of delayed ACK. When you omit the specification, the settings of the delayed ACK is not changed.

    • enable: enable delayed ACK
    • disable: disable delayed ACK
    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-window_size <size>]

    Specifies the size of window. You can specify 64KB, 128KB, 256KB, 512KB, or 1024KB. The specifiable unit is m or M for mega byte, and k or K for kilo byte. When you omit the unit, Block (512 byte) is used. For example:

    • When you specify 1,024KB:

      -window_size 1M, -window_size 1m, -window_size 1024K, -window_size 1024k, or -window_size 2048

    • When you specify 256KB:

      -window_size 256K, -window_size 256k, -window_size 512

    Note

    If this option is specified, the communications through the port are interrupted.

    When you set the attribute value related to iSCSI, the communications through the specified port are interrupted, and an I/O error is reported to the iSCSI command which is being executed. Therefore, if the attribute value related to iSCSI is set more than once continuously, troubles on I/O, for example the decreasing I/O throughput, and the failure in reading and writing, might occur. We recommend that you set the attribute value for iSCSI only when the I/O from the hosts does not exist.

  • [-keep_alive_timer <value>]

    Specifies the value of the Keep Alive Timer (30 - 64800 seconds) during iSCSI communication.

    When you omit the specification, the value of the Keep Alive Timer is not changed.

  • [-ipv6_global_address2 <address>]

    Specifies the IPv6 global address2. You can specify this option for virtual ports for which the physical port ID or iSCSI virtual port ID is 0. If a value from 1 to 15 is specified as the iSCSI virtual port ID, an error occurs. When you omit this option, the IPv6 global address2 is not changed.

    If you specify the IPv6 address automatically, specify auto for -ipv6_global_address. An error occurs if you specify auto again when it is already specified.

    If you want to specify IPv6 global address2 manually, you must also specify the IPv6 global address manually. When the IPv6 global address is already set manually, you do not need to change it. Type the IPv6 address for <address>.

    The following IPv6 addresses cannot be set:

    • Multicast Address (Example: ff00:1024:1215::01)
    • Loopback Address (Example: ::1)
  • [-isns_mode {enable|disable}]

    Specifies the availability of iSNS service.

    • enable: enable iSNS service
    • disable: disable iSNS service

    When you omit the specification, the settings of the iSNS service is not changed.

  • [-isns_server_address <IPv4 address|IPv6 address>]

    Specifies the IP address of the iSNS server. You can specify both IPv4 and IPv6 address.

    You cannot specify following IPv4 addresses:

    • Broadcast address (For example 255.255.255.255 or 10.1.255.255)
    • Loopback address (For example 127.0.0.1)

    You cannot specify following IPv6 addresses:

    • Not set (For example ::)
    • Multicast address (For example ff00:1024:1215::01)
    • Loopback address (For example ::1)

    When you omit the specification, the IP address of the iSNS server is not changed.

  • [-isns_port <iSNS TCP Port number>]

    Specifies the value of the TCP port in the iSNS server (1 - 65535).

    When you omit the specification, the value of the TCP port in the iSNS server is not changed.

  • -add_iscsi_virtual_port <value>

    Adds the virtual port to the port for which iSCSI virtual port mode is enabled. Specify the iSCSI virtual port ID (1 to 15) for <value>. Either IPv4 or IPv6 must be set. When you specify IPv4, select disable for -ipv6_mode, and specify both -ipv4_address <address> and -ipv4_subnetmask <subnet mask>. For IPv6, select enable for -ipv6_mode.

    An error occurs if you specify this option in any of the following cases:

    • The specified iSCSI virtual port is already registered.
    • The iSCSI virtual port mode is disabled.
    • The device does not support the iSCSI virtual port mode.
  • -modify_iscsi_virtual_port <value>

    Edits virtual port information of the port for which iSCSI virtual port mode is enabled.

    Specify the iSCSI virtual port ID (0 to 15) for <value>.

    When you change settings from IPv6 to IPv4 for iSCSI virtual ports whose IDs are from 1 to 15, select disable for -ipv6_mode, then set both -ipv4_address <address> and -ipv4_subnetmask <subnet mask>.

    An error occurs if you specify this option in any of the following cases:

    • The virtual port of the specified iSCSI virtual port ID is not found.
    • The iSCSI virtual port mode is disabled.
    • The device does not support the iSCSI virtual port mode.
  • -delete_iscsi_virtual_port <value>

    Deletes the virtual port from the port for which iSCSI virtual port mode is enabled.

    Specify the iSCSI virtual port ID (1 to 15) for <value>.

    An error occurs if you specify this option in any of the following cases:

    • The virtual port of the specified iSCSI virtual port ID is not found.
    • The iSCSI virtual port mode is disabled.
    • The device does not support the iSCSI virtual port mode.
Returned values

One of the values shown below is returned to exit() so that you can check the execution results using a user program or a script.

  • 0 Normal termination
  • EX_ENOSUP The host does not support IPv6. For details, see the Command Control Interface Installation and Configuration Guide.
  • Other than 0 and EX_ENOSUP Abnormal termination. For details, see the Command Control Interface User and Reference Guide.
Examples

Changing the port attributes (the Loop ID and the topology of the port) of a port CL3-E.

# raidcom modify port -port CL3-E -loop_id 0xAB -topology fl_port

Changing the port attributes of the port CL3-E to the External initiator port (ELUN).

# raidcom modify port -port CL3-E -port_attribute ELUN

When you enable the IPv6 of the port CL3-E, and automate the settings of the Global address.

# raidcom modify port -port CL3-E -ipv6_mode enable 
-ipv6_global_address auto

When you enable the iSNS service of the port CL3-E, and set the IP address to the iSNS server:

# raidcom modify port -port CL3-E -isns_mode enable 
-isns_server_address fe80::209:6bff:febe:3c17

When you enable the T10 PI mode of the port CL3-E:

# raidcom modify port -port CL3-E -t10pi enable

When you enable the virtual port mode of the port CL3-E:

# raidcom modify port -port CL3-E -iscsi_virtual_port_mode enable

When you add virtual port 1 to the port CL3-E using IPv4 to set IP address:10.213.46.63, subnet mask: 255.255.254.0:

#raidcom modify port -port CL3-E -add_iscsi_virtual_port 1 -ipv6_mode disable -ipv4_address 10.213.46.63 -ipv4_subnetmask 255.255.254.0

 

  • Was this article helpful?