Compute node connection management

Obtains a list of CHAP user information.

hsds [master command option] chap_user_list 
--target_chap_user_name <str> (optional)
--chap_user_id_target_chap_user_name <str> (optional)

• --target_chap_user_name <CHAP user name>

  Specify CHAP user name used for CHAP authentication on the compute port (i.e., target side) (exact match).

  --target_chap_user_name and --chap_user_id_target_chap_user_name cannot be specified simultaneously.

• --chap_user_id_target_chap_user_name <CHAP user name>

  The alias of --target_chap_user_name.

  --target_chap_user_name and --chap_user_id_target_chap_user_name cannot be specified simultaneously.

• Normal termination

  Description A list of CHAP user summary information. Properties data:object[] Items chapUserSummary: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Creates a CHAP user.

hsds [master command option] chap_user_create 
--target_chap_user_name <str> (required)
--target_chap_secret <str> (required)
--initiator_chap_user_name <str> (optional)
--initiator_chap_secret <str> (optional)

• --target_chap_user_name <CHAP user name>

  Specify CHAP user name (1 to 223 characters) used for CHAP authentication on the compute port (i.e., target side).

  Specify a name different from other --target_chap_user_name.

  must match /^[a-zA-Z0-9\.:@_\-\+=\[\]~ ]{1,223}$/

• --target_chap_secret <CHAP secret>

  Specify CHAP secret (12 to 32 characters) used for CHAP authentication on the compute port (i.e., target side).

  must match /^[a-zA-Z0-9\.:@_\-\+=\/\[\]~ ]{12,32}$/

  Caution

  If --target_chap_secret is not specified, a prompt will appear. In such a case, enter a CHAP secret using standard input.

  target_chap_secret:

  The contents of a CHAP secret specified by the option remain in the command history. Enter the CHAP secret using standard input without the option.

• --initiator_chap_user_name <CHAP user name>

  Specify CHAP user name (1 to 223 characters) used for CHAP authentication on the initiator port of the compute node in mutual CHAP authentication.

  must match /^[a-zA-Z0-9\.:@_\-\+=\[\]~ ]{1,223}$/

• --initiator_chap_secret <CHAP secret>

  Specify CHAP secret (12 to 32 characters) used for CHAP authentication on the initiator port of the compute node in mutual CHAP authentication.

  must match /^[a-zA-Z0-9\.:@_\-\+=\/\[\]~ ]{12,32}$/

  Caution

  If --initiator_chap_secret is not specified, a prompt will appear. If specified, enter a CHAP secret using standard input. Otherwise, press Enter without entering a value.

  initiator_chap_secret (if omitted, press the [Enter] key) []:

  The contents of a CHAP secret specified by the option remain in the command history. Enter the CHAP secret using standard input without the option.

• Normal termination

  job: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Deletes a CHAP user.

hsds [master command option] chap_user_delete
--chap_user_id <str>  (required *1)
--chap_user_id_target_chap_user_name <str>  (required *1)

• --chap_user_id <CHAP user ID>

  Specify the ID of the CHAP user (uuid).

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

• --chap_user_id_target_chap_user_name <CHAP user name>

  Specify the name of the CHAP user who is allowed to access on the target side.

  Specify a value instead of --chap_user_id.¹

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

  must match /^[a-zA-Z0-9\.:@_\-\+=\[\]~ ]{1,223}$/

• Normal termination

  job: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the information about a CHAP user.

hsds [master command option] chap_user_show
--chap_user_id <str>  (required *1)
--chap_user_id_target_chap_user_name <str>  (required *1)

• --chap_user_id < CHAP user ID>

  Specify the ID (uuid) of the CHAP user.

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

• --chap_user_id_target_chap_user_name < CHAP user name>

  Specify the name of the CHAP user who is allowed to access on the target side.

  Specify a value instead of --chap_user_id.¹

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

  must match /^[a-zA-Z0-9\.:@_\-\+=\[\]~ ]{1,223}$/

• Normal termination

  chapUser: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Edits the information about a CHAP user.

hsds [master command option] chap_user_set
--chap_user_id <str>  (required *1)
--chap_user_id_target_chap_user_name <str>  (required *1)
--target_chap_user_name <str>  (optional *2)
--target_chap_secret <str>  (optional *2)
--initiator_chap_user_name <str>  (optional *2)
--initiator_chap_secret <str>  (optional *2)

• --chap_user_id <CHAP user ID>

  Specify the ID (uuid) of the CHAP user.

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

• --chap_user_id_target_chap_user_name <CHAP user name>

  Specify the name of the CHAP user who is allowed to access on the target side.

  Specify a value instead of --chap_user_id.¹

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

  must match /^[a-zA-Z0-9\.:@_\-\+=\[\]~ ]{1,223}$/

• --target_chap_user_name <CHAP user name>

  Specify CHAP user name (1 to 223 characters) used for CHAP authentication on the compute port (i.e., target side).

  must match /^[a-zA-Z0-9\.:@_\-\+=\[\]~ ]{1,223}$/

• --target_chap_secret <CHAP secret>

  Specify CHAP secret (12 to 32 characters) used for CHAP authentication on the compute port (i.e., target side).

  must match /^[a-zA-Z0-9\.:@_\-\+=\/\[\]~ ]{12,32}$/

  Caution

  If --target_chap_secret is not specified, a prompt will appear. If specified, enter a CHAP secret using standard input. Otherwise, press Enter without entering a value.

  target_chap_secret (if omitted, press the [Enter] key) []:

  The contents of a CHAP secret specified by the option remain in the command history. Enter the CHAP secret using standard input without the option.

• --initiator_chap_user_name <CHAP user name>

  Specify CHAP user name (1 to 223 characters) used for CHAP authentication on the initiator port of the compute node in mutual CHAP authentication.

  must match /^$|^[a-zA-Z0-9\.:@_\-\+=\[\]~ ]{1,223}$/

• --initiator_chap_secret <CHAP secret

  Specify CHAP secret (12 to 32 characters) used for CHAP authentication on the initiator port of the compute node in mutual CHAP authentication.

  must match /^$|^[a-zA-Z0-9\.:@_\-\+=\/\[\]~ ]{12,32}$/

  Caution

  If --initiator_chap_secret is not specified, a prompt will appear. If specified, enter a CHAP secret using standard input. Otherwise, press Enter without entering a value.

  initiator_chap_secret (if omitted, press the [Enter] key) []:

  The contents of a CHAP secret specified by the option remain in the command history. Enter the CHAP secret using standard input without the option.

• Normal termination

  job: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the authentication settings for the compute port for the target operation.

hsds [master command option] port_auth_setting_show 
--id <str> (required *1) 
--id_name <str>  (required *1)

• --id <compute port ID>

  Specify the ID (uuid) of the compute port.

  Either --id or --id_name must be specified.

• --id_name <iSCSI name>

  Specify the iSCSI name for iSCSI connections of the compute port.¹

  Specify a value instead of --id.²

  Either --id or --id_name must be specified.

  must match /^[a-f0-9]{16}$|^[A-F0-9]{16}$|^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• Normal termination

  portAuthSetting: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Edits the authentication settings for the compute port for the target operation.

hsds [master command option] port_auth_setting_set 
--id <str>  (required *1)
--id_name <str>  (required *1)
--auth_mode <str>  (optional *2) 
--is_discovery_chap_auth <boolean>  (optional *2)  
--is_mutual_chap_auth <boolean>  (optional *2) 

• --id <compute port ID>

  Specify the ID (uuid) of the compute port.

  Either --id or --id_name must be specified.

• --id_name <iSCSI name>

  Specify the iSCSI name for iSCSI connections of the compute port.¹

  Specify a value instead of --id.²

  Either --id or --id_name must be specified.

  must match /^[a-f0-9]{16}$|^[A-F0-9]{16}$|^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• --auth_mode { CHAP | CHAPComplyingWithInitiatorSetting | None }

  Specify Authentication scheme of the compute port.

  • CHAP: CHAP authentication.

  • CHAPComplyingWithInitiatorSetting: Complies with the setting of the compute node. If the setting is "CHAP", CHAP authentication is performed. If the setting is "None", no authentication is required.

  • None: No authentication is performed.

• --is_discovery_chap_auth {true | false}

  Enables or disables CHAP authentication at the time of discovery in iSCSI connection. Enables CHAP authentication at the time of discovery when true is specified.

• --is_mutual_chap_auth {true | false}

  Enables or disables mutual CHAP authentication. Enables mutual CHAP authentication when true is specified.

• Normal termination

  job: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains a list of information about a CHAP user who is allowed to access the compute port.

hsds [master command option] port_auth_setting_chap_user_list 
--id <str>  (required *1)
--id_name <str>  (required *1)

• --id <compute port ID>

  Specify the ID (uuid) of the compute port.

  Either --id or --id_name must be specified.

• --id_name <iSCSI name>

  Specify the iSCSI name for iSCSI connections of the compute port.¹

  Specify a value instead of --id.¹

  Either --id or --id_name must be specified.

  must match /^[a-f0-9]{16}$|^[A-F0-9]{16}$|^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• Normal termination

  Description A list of CHAP users who are allowed to access the compute port for the target operation in CHAP authentication. Properties data:object[] Items approvedChapUser: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Allows a CHAP user to access the compute port.

hsds [master command option] port_auth_setting_chap_user_create 
--id <str>  (required *1) 
--id_name <str>  (required *1) 
--chap_user_id <str>  (required *2) 
--chap_user_id_target_chap_user_name <str>  (required *2) 

• --id <compute port ID>

  Specify the ID (uuid) of the compute port.

  Either --id or --id_name must be specified.

• --id_name <iSCSI name>

  Specify the iSCSI name for iSCSI connections of the compute port.¹

  Specify a value instead of --id.²

  Either --id or --id_name must be specified.

  must match /^[a-f0-9]{16}$|^[A-F0-9]{16}$|^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• --chap_user_id <CHAP user ID>

  Specify the ID (uuid) of the CHAP user who is allowed to access the compute port in CHAP authentication.

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

• --chap_user_id_target_chap_user_name <CHAP user name>

  Specify the name of the CHAP user who is allowed to access on the target side.

  Specify a value instead of --chap_user_id.²

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

  must match /^[a-zA-Z0-9\.:@_\-\+=\[\]~ ]{1,223}$/

• Normal termination

  job: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Cancels compute port access permission for a CHAP user.

hsds [master command option] port_auth_setting_chap_user_delete 
--id <str>  (required *1)
--id_name <str>  (required *1)
--chap_user_id <str>  (required *2)
--chap_user_id_target_chap_user_name <str>  (required *2)

• --id <compute port ID>

  Specify the ID (uuid) of the compute port.

  Either --id or --id_name must be specified.

• --id_name <iSCSI name>

  Specify the iSCSI name for iSCSI connections of the compute port.¹

  Specify a value instead of --id.²

  Either --id or --id_name must be specified.

  must match /^[a-f0-9]{16}$|^[A-F0-9]{16}$|^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• --chap_user_id <CHAP user ID>

  Specify the ID (uuid) of the CHAP user.

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

• --chap_user_id_target_chap_user_name <CHAP user name>

  Specify the name of the CHAP user who is allowed to access on the target side.

  Specify a value instead of --chap_user_id.²

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

  must match /^[a-zA-Z0-9\.:@_\-\+=\[\]~ ]{1,223}$/

• Normal termination

  job: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the information about a CHAP user who is allowed to access the compute port.

hsds [master command option] port_auth_setting_chap_user_show 
--id <str>  (required *1)
--id_name <str>  (required *1)
--chap_user_id <str>  (required *2)
--chap_user_id_target_chap_user_name <str>  (required *2)

• --id <compute port ID>

  Specify the ID (uuid) of the compute port.

  Either --id or --id_name must be specified.

• --id_name <iSCSI name>

  Specify the iSCSI name for iSCSI connections of the compute port.¹

  Specify a value instead of --id.²

  Either --id or --id_name must be specified.

  must match /^[a-f0-9]{16}$|^[A-F0-9]{16}$|^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• --chap_user_id <CHAP user ID>

  Specify the ID (uuid) of the CHAP user.

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

• --chap_user_id_target_chap_user_name <CHAP user name>

  Specify the name of the CHAP user who is allowed to access on the target side.

  Specify a value instead of --chap_user_id.²

  Either --chap_user_id or --chap_user_id_target_chap_user_name be specified.

  must match /^[a-zA-Z0-9\.:@_\-\+=\[\]~ ]{1,223}$/

• Normal termination

  approvedChapUser: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains a list of compute port information.

hsds [master command option] port_list 
--protocol <str>  (optional)
--storage_node_id <str>  (optional)
--name <str>  (optional)
--id_name <str>  (optional)
--names <str[]>  (optional)
--id_names <str[]>  (optional)

• --protocol {FC | iSCSI}

  Specify the protocol for connecting compute ports.

• --storage_node_id <storage node ID>

  Specify storage node ID (uuid).

• --name {<WWN> | <iSCSI name>}

  Specify the WWN for FC connection or iSCSI name for iSCSI connection of the compute port.¹

  --name and --id_name cannot be specified simultaneously.

• --id_name {<WWN> | <iSCSI name>}

  The alias of --name. ¹

  --name and --id_name cannot be specified simultaneously.

• --names {<WWN> | <iSCSI name>}

  Specify the WWN for FC connection or iSCSI name for iSCSI connection of the compute port.

  You can specify plural names up to 32 with comma (,) delimiter.¹

  Example: --names <name1>,<name2>,<name3>…

  If you enter a space character after a comma, the space character is recognized as a part of the name specified after the comma.

  Also, if you specify 33 or more names, An error is returned.

  --names and --id_names cannot be specified simultaneously.

  Each item must match /^[a-f0-9]{16}$|^[A-F0-9]{16}$|^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• --id_names {<WWN> | <iSCSI name>}

  The alias of --names.

  You can specify maximum of 32 WWNs for FC connection or iSCSI names for iSCSI connections (up to 223 characters) with comma (,) delimiter.¹

  --names and --id_names cannot be specified simultaneously.

  Each item must match /^[a-f0-9]{16}$|^[A-F0-9]{16}$|^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• Normal termination

  Description A list of summary information about the compute port. Properties data: object[] Items portSummary: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Obtains the compute port information.

hsds [master command option] port_show 
--id <str>  (required *1)
--id_name <str>  (required *1)

• --id <port ID>

  Specify the ID (uuid) of the compute port.

  Either --id or --id_name must be specified.

• --id_name {<WWN> | <iSCSI name>}

  Specify WWN of the compute port for FC connection or the iSCSI name for iSCSI connections.¹

  Specify a value instead of --id.²

  Either --id or --id_name must be specified.

  must match /^[a-f0-9]{16}$|^[A-F0-9]{16}$|^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• Normal termination

  port: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication

Edits the compute port settings.

hsds [master command option] port_set 
--id <str>  (required *1) 
--id_name <str>  (required *1) 
--nickname <str>  (optional *2)
--name <str>  (optional *2)
--connection_type <str>  (optional *2)
--is_isns_client_enabled <boolean>  (optional *2)
--isns_servers <array>  (optional *2)
  index=<int32>
  server_name=<str>
  port=<int32>

• --id <port ID>

  Specify the ID (uuid) of the compute port.

  Either --id or --id_name must be specified.

• --id_name {<WWN> | <iSCSI name>}

  Specify WWN of the compute port for FC connection or the iSCSI name for iSCSI connections.¹

  Specify a value instead of --id.²

  Either --id or --id_name must be specified.

  must match /^[a-f0-9]{16}$|^[A-F0-9]{16}$|^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• --nickname <port nickname>

  Specify the compute port nickname. Each compute port must have its own unique nickname.

  must match /^[a-zA-Z0-9!#\$%&'\+\-\.=@\^_\{\}~\(\)\[\]:]{1,32}$/

• --name <port iSCSI name>

  Specify the iSCSI name of the compute port. For FC connection, this property cannot be specified.

  The same name cannot be used for multiple compute ports.

  must match /^((iqn\.[0-9]{4}\-[0-9]{2}\.[a-zA-Z0-9\-:\.]{0,211})|(eui\.[0-9a-fA-F]{16}))$/

• --connection_type PointToPoint

  Specify Network topology for FC connection.

  The value remains as is if nothing is specified for it.

  FC settings are disabled if iSCSI connection is used.

• --is_isns_client_enabled {false | true}

  Specify iSNS client function for iSCSI connection. Specifying "true" enables the iSNS client function.

• --isns_servers index=<ID>,server_name=<IP address>,port=<port number >

  Specify iSNS server as the connection destination in the iSNS client function. (1 item)³

  • Parameters

    index

    The ID ( 1 default: "1") of the iSNS server.

    server_name

    IP address (IPv4, 2 to 45 characters) setting of the iSNS server.

    The value remains as is if nothing is specified for it.

    However, either server_name or port must be specified. If neither of them is specified, an error is returned.

    must match /^(([1-9]?[0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([1-9]?[0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(((([0-9a-fA-F]{1,4}:){7}([0-9a-fA-F]{1,4}|:))|(([0-9a-fA-F]{1,4}:){6}(:[0-9a-fA-F]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])(\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])){3})|:))|(([0-9a-fA-F]{1,4}:){5}(((:[0-9a-fA-F]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])(\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])){3})|:))|(([0-9a-fA-F]{1,4}:){4}(((:[0-9a-fA-F]{1,4}){1,3})|((:[0-9a-fA-F]{1,4})?:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])(\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])){3}))|:))|(([0-9a-fA-F]{1,4}:){3}(((:[0-9a-fA-F]{1,4}){1,4})|((:[0-9a-fA-F]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])(\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])){3}))|:))|(([0-9a-fA-F]{1,4}:){2}(((:[0-9a-fA-F]{1,4}){1,5})|((:[0-9a-fA-F]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])(\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])){3}))|:))|(([0-9a-fA-F]{1,4}:){1}(((:[0-9a-fA-F]{1,4}){1,6})|((:[0-9a-fA-F]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])(\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])){3}))|:))|(:(((:[0-9a-fA-F]{1,4}){1,7})|((:[0-9a-fA-F]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])(\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])){3}))|:)))(\%.+)?\s*)$/

    port

    TCP port number ( 1 to 65536 ) of the iSNS server.

    The value remains as is if nothing is specified for it.

    However, either server_name or port must be specified. If neither of them is specified, an error is returned.

• Normal termination

  job: object

• Abnormal termination

  errorResponse: object

• basic authentication

• session authentication