Setting remote connections

Storage Administrator (View Only)

GET base-URL/v1/objects/storages/storage-device-ID/remotepath-groups

• Object ID

  None.

• Query parameters

  None.

• Body

  None.

• Body

  The following is an example of the output when information about the remote storage system is not registered on the REST API server:

  {
    "data": [
      {
        "remotepathGroupId": "492015,M8,0",
        "remoteSerialNumber": "492015",
        "remoteStorageTypeId": "M8",
        "pathGroupId": 0,
        "cuType": "REMOTE",
        "portType": "FIBRE",
        "cuStatus": "NML",
        "minNumOfPaths": 1,
        "numOfPaths": 1,
        "timeoutValueForRemoteIOInSeconds": 15,
        "roundTripTimeInMilliSeconds": 1
      }
    ]
  }

  The following is an example of the output when information about the remote storage system is registered on the REST API server:

  {
    "data": [
      {
        "remotepathGroupId": "492015,M8,0",
        "remoteStorageDeviceId": "834000492015",
        "remoteSerialNumber": "492015",
        "remoteStorageModel": "VSP G400",
        "remoteStorageTypeId": "M8",
        "pathGroupId": 0,
        "cuType": "REMOTE",
        "portType": "FIBRE",
        "cuStatus": "NML",
        "minNumOfPaths": 1,
        "numOfPaths": 1,
        "timeoutValueForRemoteIOInSeconds": 15,
        "roundTripTimeInMilliSeconds": 1
      }
    ]
  }

  Attribute	Type	Description
  remotepathGroupId	string	Object ID for the remote connection
  remoteStorageDeviceId	string	Storage device ID of the remote storage system This attribute is output when information about the remote storage system is registered on the REST API server.
  remoteSerialNumber	string	Serial number of the remote storage system
  remoteStorageModel	string	Model type of the remote storage system This attribute is output when information about the remote storage system is registered on the REST API server.
  remoteStorageTypeId	string	ID that indicates the model of the remote storage system R7: Virtual Storage Platform R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M7: HUS VM M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  pathGroupId	int	Path group ID If the connection setting for the remote path is CU specific, this information is not output.
  localCuNumber	string	CU number of the local storage system (MCU) This item is hidden when the value of the connection setting of the remote path is CU Free or when the value of the cuType attribute is LOCAL.
  remoteCuNumber	string	CU number of the remote storage system (RCU) This item is hidden when the value of the connection setting of the remote path is CU Free or when the value of the cuType attribute is LOCAL.
  portType	string	Port type of the remote path FIBRE: All the ports are Fibre Channel ports ESCON: All the ports are ESCON ports ISCSI: All the ports are iSCSI ports MIXED: Multiple port types from among these three types This item is hidden when the value of the cuType attribute is LOCAL.
  cuType	string	CU type REMOTE: If a remote path is set from the local storage system to the remote storage system LOCAL: If a remote path is set from the remote storage system to the local storage system
  cuStatus	string	CU status NML: Normal WAR: Warning ERR: Failing Unknown: Unknown. This is output if the cuType attribute is LOCAL.
  minNumOfPaths	int	Minimum number of paths If the cuType attribute is LOCAL, this information is not output.
  numOfPaths	int	Number of set remote paths If the cuType attribute is LOCAL, this information is not output.
  incidentMode	string	Incident mode for sending incidents to the RCU host MR: Incidents are sent to the MCU host and the RCU host. RO: Incidents are sent to the RCU host only. This item is hidden when the value of the connection setting of the remote path is CU Free or when the value of the cuType attribute is LOCAL.
  isFreezeOptionEnabled	boolean	Value of the FREEZE option false: The FREEZE option is disabled. true: The FREEZE option is enabled. This item is hidden when the value of the connection setting of the remote path is CU Free or when the value of the cuType attribute is LOCAL.
  timeoutValueForRemoteIOInSeconds	int	RIO timeout value (in seconds) for RIO (Remote IO) setting between the local storage system and the remote storage system If the cuType attribute is LOCAL, this information is not output.
  roundTripTimeInMilliSeconds	int	The round-trip time value (in milliseconds) between the local storage system and the remote storage system If the cuType attribute is LOCAL, this information is not output.

For details on the status codes of the request for this operation, see the description on HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remotepath-groups

Storage Administrator (View Only)

GET base-URL/v1/objects/storages/storage-device-ID/remotepath-groups/object-ID

• Object ID

  Specify the value of remotepathGroupId that was obtained by the processing to get information about the remote connection. You can also specify the attributes and connect them with commas as follows:

  remoteSerialNumber,remoteStorageTypeId,pathGroupId

  Attribute	Type	Description
  remoteSerialNumber	string	(Required) Serial number of the remote storage system
  remoteStorageTypeId	string	(Required) ID that indicates the model of the remote storage system You can specify the following values: R7: Virtual Storage Platform R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M7: HUS VM M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  pathGroupId	int	(Required) Path group ID

• Query parameters

  None.

• Body

  None.

• Body

  The following is an example of the output when information about the remote storage system is not registered on the REST API server:

  {
    "remotepathGroupId": "492015,M8,255",
    "remoteSerialNumber": "492015",
    "remoteStorageTypeId": "M8",
    "pathGroupId": 255,
    "remotePaths": [
      {
        "cuType": "REMOTE",
        "portType": "ISCSI",
        "pathNumber": 0,
        "localPortId": "CL3-B",
        "remotePortId": "CL2-C",
        "pathStatus": "ERR_03"
      }
    ]
  }

  The following is an example of the output when information about the remote storage system is registered on the REST API server:

  {
    "remotepathGroupId": "492015,M8,255",
    "remoteStorageDeviceId": "834000492015",
    "remoteSerialNumber": "492015",
    "remoteStorageModel": "VSP G400",
    "remoteStorageTypeId": "M8",
    "pathGroupId": 255,
    "remotePaths": [
      {
        "cuType": "REMOTE",
        "portType": "ISCSI",
        "pathNumber": 0,
        "localPortId": "CL3-B",
        "remotePortId": "CL2-C",
        "pathStatus": "ERR_03"
      }
    ]
  }

  Attribute	Type	Description
  remotepathGroupId	string	Object ID for the remote connection
  remoteStorageDeviceId	string	Storage device ID of the remote storage system This attribute is output when information about the remote storage system is registered on the REST API server.
  remoteSerialNumber	string	Serial number of the remote storage system
  remoteStorageModel	string	Model type of the remote storage system This attribute is output when information about the remote storage system is registered on the REST API server.
  remoteStorageTypeId	string	ID that indicates the model of the remote storage system R7: Virtual Storage Platform R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M7: HUS VM M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  pathGroupId	int	Path group ID
  remotePaths	objects[]	The following attributes are output for each remote path: cuType (string) CU type REMOTE: If a remote path is set from the local storage system to the remote storage system LOCAL: If a remote path is set from the remote storage system to the local storage system portType (string) Port type of the remote path FIBRE: Fibre Channel port ESCON: ESCON port ISCSI: iSCSI port pathNumber (int) Path number localPortId (string) Port number of the local storage system (MCU) remotePortId (string) Port number of the remote storage system (RCU) pathStatus (string) The path status NML_01: Normal ERR_02: Initialization failed ERR_03: Communication timeout ERR_04: Logical blockade ERR_05: Resource Shortage ERR_06: Serial Number Mismatch ERR_10: Invalid Port ERR_80: RCU Port Number Mismatch ERR_81: RCU Port Type Mismatch ERR_82: Communication Failed IN_PRG: The path is being created or deleted.

For details on the status codes of the request for this operation, see the description on HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remotepath-groups/492015,M8,255

Storage Administrator (Remote Copy)

POST base-URL/v1/objects/storages/storage-device-ID/remotepath-groups

• Object ID

  None.

• Query parameters

  None.

• Body

  The following is a coding example for creating a remote connection by specifying the serial number and the series name of the remote storage system:

  {
    "remoteSerialNumber": "492015",
    "remoteStorageTypeId": "M8",
    "pathGroupId": 255,
    "localPortId": "CL3-B",
    "remotePortId": "CL2-C"
  }

  Attribute	Type	Description
  remoteSerialNumber	string	(Required) Serial number of the remote storage system
  remoteStorageTypeId	string	(Required) ID that indicates the model of the remote storage system You can specify the following values: R7: Virtual Storage Platform R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M7: HUS VM M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  pathGroupId	int	(Required) Path group ID Specify a decimal (base 10) number in the range from 0 to 255.
  localPortId	string	(Required) Port number of the local storage system
  remotePortId	string	(Required) Port number of the remote storage system

  The following is a coding example for creating a remote connection by specifying the storage device ID of the remote storage system:

  {
    "remoteStorageDeviceId": "836000410011",
    "pathGroupId": 255,
    "localPortId": "CL3-B",
    "remotePortId": "CL2-C"
  }

  Attribute	Type	Description
  remoteStorageDeviceId	string	(Required) Storage device ID of the remote storage system
  pathGroupId	int	(Required) Path group ID Specify a decimal (base 10) number in the range from 0 to 255.
  localPortId	string	(Required) Port number of the local storage system
  remotePortId	string	(Required) Port number of the remote storage system

• Body

  A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

  Attribute	Description
  affectedResources	URL of the registered remote connection

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

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X POST --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remotepath-groups

Storage Administrator (Remote Copy)

PUT base-URL/v1/objects/storages/storage-device-ID/remotepath-groups/object-ID

You can run this API request in a PATCH method.

• Object ID

  Specify the value of remotepathGroupId that was obtained by the processing to get information about the remote connection. You can also specify the attributes and connect them with commas as follows:

  remoteSerialNumber,remoteStorageTypeId,pathGroupId

  Attribute	Type	Description
  remoteSerialNumber	string	(Required) Serial number of the remote storage system
  remoteStorageTypeId	string	(Required) ID that indicates the model of the remote storage system You can specify the following values: R7: Virtual Storage Platform R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M7: HUS VM M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  pathGroupId	int	(Required) Path group ID

• Query parameters

  None.

• Body

  {
    "minNumOfPaths": 1,
    "timeoutValueForRemoteIOInSeconds": 15,
    "roundTripTimeInMilliSeconds": 1
  }

  Attribute	Type	Description
  minNumOfPaths	int	Minimum number of remote paths Specify a value in the range from 1 to 8. This value is set to 1 by default when a remote connection is created. Specify a value that is no more than the number of remote paths registered in the remote connection.
  timeoutValueForRemoteIOInSeconds	int	RIO timeout value (in seconds) for RIO (Remote IO) setting between the local storage system and the remote storage system Specify a value in the range from 10 to 100. This value is set to 15 by default when a remote connection is created.
  roundTripTimeInMilliSeconds	int	The round-trip time value (in milliseconds) between the local storage system and the remote storage system Specify a value in the range from 1 to 500. Default: 1 This value is set to 1 by default when a remote connection is created.

• Body

  A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

  Attribute	Description
  affectedResources	URL of the changed remote connection

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

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PUT --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remotepath-groups/492015,M8,255

Storage Administrator (Remote Copy)

PUT base-URL/v1/objects/storages/storage-device-ID/remotepath-groups/object-ID/actions/add-remotepath/invoke

You can run this API request in a POST method.

• Object ID

  Specify the value of remotepathGroupId that was obtained by the processing to get information about the remote connection. You can also specify the attributes and connect them with commas as follows:

  remoteSerialNumber,remoteStorageTypeId,pathGroupId

  Attribute	Type	Description
  remoteSerialNumber	string	(Required) Serial number of the remote storage system
  remoteStorageTypeId	string	(Required) ID that indicates the model of the remote storage system You can specify the following values: R7: Virtual Storage Platform R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M7: HUS VM M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  pathGroupId	int	(Required) Path group ID

• Query parameters

  None.

• Body

  {
    "parameters": {
      "localPortId": "CL1-A",
      "remotePortId": "CL2-B"
    }
  }

  Attribute	Type	Description
  localPortId	string	(Required) Port number of the local storage system
  remotePortId	string	(Required) Port number of the remote storage system

• Body

  A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

  Attribute	Description
  affectedResources	URL of the remote path that was added to the remote connection

GET base-URL/v1/objects/storages/storage-device-ID/remotepath-groups/object-ID/actions/add-remotepath

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

To get an action template:

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remotepath-groups/492015,M8,255/actions/add-remotepath

To run the request after getting an action template:

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PUT --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remotepath-groups/492015,M8,255/actions/add-remotepath/invoke

Storage Administrator (Remote Copy)

PUT base-URL/v1/objects/storages/storage-device-ID/remotepath-groups/object-ID/actions/remove-remotepath/invoke

You can run this API request in a POST method.

• Object ID

  Specify the value of remotepathGroupId that was obtained by the processing to get information about the remote connection. You can also specify the attributes and connect them with commas as follows:

  remoteSerialNumber,remoteStorageTypeId,pathGroupId

  Attribute	Type	Description
  remoteSerialNumber	string	(Required) Serial number of the remote storage system
  remoteStorageTypeId	string	(Required) ID that indicates the model of the remote storage system You can specify the following values: R7: Virtual Storage Platform R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M7: HUS VM M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  pathGroupId	int	(Required) Path group ID

• Query parameters

  None.

• Body

  {
    "parameters": {
      "localPortId": "CL1-A",
      "remotePortId": "CL2-B"
    }
  }

  Attribute	Type	Description
  localPortId	string	(Required) Port number of the local storage system
  remotePortId	string	(Required) Port number of the remote storage system

• Body

  A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

  Attribute	Description
  affectedResources	URL of the remote path removed from the remote connection

GET base-URL/v1/objects/storages/storage-device-ID/remotepath-groups/object-ID/actions/remove-remotepath

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

To get an action template

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remotepath-groups/492015,M8,255/actions/remove-remotepath

To run the request after getting an action template:

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PUT --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remotepath-groups/492015,M8,255/actions/remove-remotepath/invoke

Storage Administrator (Remote Copy)

DELETE base-URL/v1/objects/storages/storage-device-ID/remotepath-groups/object-ID

• Object ID

  Specify the value of remotepathGroupId that was obtained by the processing to get information about the remote connection. You can also specify the attributes and connect them with commas as follows:

  remoteSerialNumber,remoteStorageTypeId,pathGroupId

  Attribute	Type	Description
  remoteSerialNumber	string	(Required) Serial number of the remote storage system
  remoteStorageTypeId	string	(Required) ID that indicates the model of the remote storage system You can specify the following values: R7: Virtual Storage Platform R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M7: HUS VM M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  pathGroupId	int	(Required) Path group ID

• Query parameters

  None.

• Body

  None.

• Body

  A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

  Attribute	Description
  affectedResources	URL of the deleted remote connection

For details on the status codes of the request for this operation, see the description on HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X DELETE https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remotepath-groups/492015,M8,255

Storage Administrator (View Only)

GET base-URL/v1/objects/storages/storage-device-ID/remote-iscsi-ports

• Object ID

  None.

• Query parameters

  None.

• Body

  None.

• Body

  The following is an example of the output when information about the remote storage system is not registered on the REST API server:

  {
    "data": [
      {
        "remoteIscsiPortId": "CL1-B,410012,M8,CL2-D",
        "localPortId": "CL1-B",
        "remoteSerialNumber": "410012",
        "remoteStorageTypeId": "M8",
        "remotePortId": "CL2-D",
        "remoteIpAddress": "192.168.116.29",
        "remoteTcpPort": 3260
      },
      {
        "remoteIscsiPortId": "CL3-B,410012,M8,CL2-D",
        "localPortId": "CL3-B",
        "remoteSerialNumber": "410012",
        "remoteStorageTypeId": "M8",
        "remotePortId": "CL2-D",
        "remoteIpAddress": "192.168.116.29",
        "remoteTcpPort": 3260
      }
    ]
  }

  The following is an example of the output when information about the remote storage system is registered on the REST API server:

  {
    "data": [
      {
        "remoteIscsiPortId": "CL1-B,410012,M8,CL2-D",
        "localPortId": "CL1-B",
        "remoteStorageDeviceId": "834000410012",
        "remoteSerialNumber": "410012",
        "remoteStorageModel": "VSP G400",
        "remoteStorageTypeId": "M8",
        "remotePortId": "CL2-D",
        "remoteIpAddress": "192.168.116.29",
        "remoteTcpPort": 3260
      },
      {
        "remoteIscsiPortId": "CL3-B,410012,M8,CL2-D",
        "localPortId": "CL3-B",
        "remoteStorageDeviceId": "834000410012",
        "remoteSerialNumber": "410012",
        "remoteStorageModel": "VSP G400",
        "remoteStorageTypeId": "M8",
        "remotePortId": "CL2-D",
        "remoteIpAddress": "192.168.116.29",
        "remoteTcpPort": 3260
      }
    ]
  }

  Attribute	Type	Description
  remoteIscsiPortId	string	Object ID for the iSCSI port
  localPortId	string	Port number of the local storage system
  remoteStorageDeviceId	string	Storage device ID of the remote storage system This attribute is output when information about the remote storage system is registered on the REST API server.
  remoteSerialNumber	string	Serial number of the remote storage system
  remoteStorageModel	string	Model type of the remote storage system This attribute is output when information about the remote storage system is registered on the REST API server.
  remoteStorageTypeId	string	ID that indicates the model of the remote storage system R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  remotePortId	string	Port number of the remote storage system
  remoteIpAddress	string	IP address of the remote storage system
  remoteTcpPort	int	TCP port number of the remote storage system

For details on the status codes of the request for this operation, see the description on HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remote-iscsi-ports

Storage Administrator (View Only)

GET base-URL/v1/objects/storages/storage-device-ID/remote-iscsi-ports/object-ID

• Object ID

  Specify the value of remoteIscsiPortId that was obtained by the processing to get information about the port. You can also specify the attributes and connect them with commas as follows:

  localPortId,remoteSerialNumber,remoteStorageTypeId,remotePortId

  Attribute	Type	Description
  localPortId	string	(Required) Port number of the local storage system
  remoteSerialNumber	string	(Required) Serial number of the remote storage system
  remoteStorageTypeId	string	(Required) ID that indicates the model of the remote storage system You can specify the following values: R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  remotePortId	string	(Required) Port number of the remote storage system

• Query parameters

  None.

• Body

  None.

• Body

  The following is an example of the output when information about the remote storage system is not registered on the REST API server:

  {
    "remoteIscsiPortId": "CL1-B,410012,M8,CL2-D",
    "localPortId": "CL1-B",
    "remoteSerialNumber": "410012",
    "remoteStorageTypeId": "M8",
    "remotePortId": "CL2-D",
    "remoteIpAddress": "192.168.116.29",
    "remoteTcpPort": 3260
  }

  The following is an example of the output when information about the remote storage system is registered on the REST API server:

  {
    "remoteIscsiPortId": "CL1-B,410012,M8,CL2-D",
    "localPortId": "CL1-B",
    "remoteStorageDeviceId": "834000410012",
    "remoteSerialNumber": "410012",
    "remoteStorageModel": "VSP G400",
    "remoteStorageTypeId": "M8",
    "remotePortId": "CL2-D",
    "remoteIpAddress": "192.168.116.29",
    "remoteTcpPort": 3260
  }

  Attribute	Type	Description
  remoteIscsiPortId	string	Object ID for the iSCSI port
  localPortId	string	Port number of the local storage system
  remoteStorageDeviceId	string	Storage device ID of the remote storage system This attribute is output when information about the remote storage system is registered on the REST API server.
  remoteSerialNumber	string	Serial number of the remote storage system
  remoteStorageModel	string	Model type of the remote storage system This attribute is output when information about the remote storage system is registered on the REST API server.
  remoteStorageTypeId	string	ID that indicates the model of the remote storage system R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  remotePortId	string	Port number of the remote storage system
  remoteIpAddress	string	IP address of the remote storage system
  remoteTcpPort	int	TCP port number of the remote storage system

For details on the status codes of the request for this operation, see the description on HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/834000123456/remote-iscsi-ports/CL1-B,410012,M8,CL2-D

Storage Administrator (Remote Copy)

POST base-URL/v1/objects/storages/storage-device-ID/remote-iscsi-ports

• Object ID

  None.

• Query parameters

  None.

• Body

  The following is a coding example for registering an iSCSI port by specifying the serial number, series name, and the TCP port number of the remote storage system:

  {
    "localPortId": "CL1-B",
    "remoteSerialNumber": "492015",
    "remoteStorageTypeId": "M8",
    "remotePortId": "CL2-D",
    "remoteIpAddress": "192.168.116.29",
    "remoteTcpPort": 3260
  }
  

  The following is a coding example for registering an iSCSI port by specifying the serial number and the series name of the remote storage system, without specifying the TCP port number:

  {
    "localPortId": "CL1-B",
    "remoteSerialNumber": "492015",
    "remoteStorageTypeId": "M8",
    "remotePortId": "CL2-D",
    "remoteIpAddress": "192.168.116.29"
  }

  When registering an iSCSI port by specifying the serial number and the series name of the remote storage system:

  Attribute	Type	Description
  localPortId	string	(Required) Port number of the local storage system
  remoteSerialNumber	string	(Required) Serial number of the remote storage system
  remoteStorageTypeId	string	(Required) ID that indicates the model of the remote storage system You can specify the following values: R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  remotePortId	string	(Required) Port number of the remote storage system
  remoteIpAddress	string	(Required) IP address of the remote storage system You can specify an IPv4 or IPv6 address.
  remoteTcpPort	int	(Optional) TCP port number If this attribute is not specified, the TCP port number for the iSCSI target of the local storage system will be set to the TCP port number of the remote storage system.

  The following is a coding example for registering an iSCSI port by specifying the storage device ID and the TCP port number of the remote storage system:

  {
    "localPortId": "CL1-B",
    "remoteStorageDeviceId": "834000492015",
    "remotePortId": "CL2-D",
    "remoteIpAddress": "192.168.116.29"
  }

  When registering the iSCSI port by specifying the storage device ID of the remote storage system:

  Attribute	Type	Description
  localPortId	string	(Required) Port number of the local storage system
  remoteStorageDeviceId	string	(Required) Storage device ID of the remote storage system
  remotePortId	string	(Required) Port number of the remote storage system
  remoteIpAddress	string	(Required) IP address of the remote storage system You can specify an IPv4 or IPv6 address.
  remoteTcpPort	int	(Optional) TCP port number If this attribute is not specified, the TCP port number for the iSCSI target of the local storage system will be set to the TCP port number of the remote storage system.

• Body

  A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

  Attribute	Description
  affectedResources	URL of the iSCSI port of the remote storage system that was registered to the iSCSI port of the local storage system

For details on the status codes of the request for this operation, see the description on HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X POST --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remote-iscsi-ports

Storage Administrator (Remote Copy)

DELETE base-URL/v1/objects/storages/storage-device-ID/remote-iscsi-ports/object-ID

• Object ID

  Specify the value of remoteIscsiPortId that was obtained by the processing to get information about the port. You can also specify the attributes and connect them with commas as follows:

  localPortId,remoteSerialNumber,remoteStorageTypeId,remotePortId

  Attribute	Type	Description
  localPortId	string	(Required) Port number of the local storage system
  remoteSerialNumber	string	(Required) Serial number of the remote storage system
  remoteStorageTypeId	string	(Required) ID that indicates the model of the remote storage system You can specify the following values: R8: VSP G1000, VSP G1500, or VSP F1500 R9: VSP 5000 series M8: VSP E series, VSP Gx00 models or VSP Fx00 models
  remotePortId	string	(Required) Port number of the remote storage system

• Query parameters

  None.

• Body

  None.

• Body

  A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

  Attribute	Description
  affectedResources	URL of the deleted iSCSI port

For details on the status codes of the request for this operation, see the description on HTTP status codes.

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X DELETE https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/remote-iscsi-ports/CL1-B,410012,M8,CL2-D