Storage controller ports REST API

Use this REST API to manage storage controller ports.

Get all storage controller ports

Returns a list of storage controller ports.

Table 1. Get all storage controller ports
URI /admin/resources/storage_controller_ports
Method GET
Returns 200 Returns a list of all storage controller ports
404 The storage controller port list was not found
500 Platform System Manager encountered an internal error while processing the request.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

created_time
The time at which the object is created
id
The unique ID of the object in the system.
label_key
Key for retrieving label for the storage controller port
lable_text
Default label for the storage controller port
name
The name of the storage controller port
parent
The parent that the the storage controller port belongs to
parent_type
The type of the parent that the storage controller port belongs to
portnum
Storage controller port number
speed
The speed of the storage controller port
state
The general availability of the object. If "pending" the object has been created but not activated. If "available" the object is active in the system.
updated_time
The time at which the object was last updated
wwpn
World Wide Port Name
parent_type
The type of the generic parent

Parents:

storage_controllers, storage_expansions

Children:

storage_port_statistics, events

Get a specific storage controller port

Returns a single storage controller port identified by {id}.

Table 2. Get a specific storage controller port
URI /admin/resources/storage_controller_ports/{id}
Method GET
Returns 200 The storage controller port was returned.
404 The storage controller port was not found
500 Platform System Manager encountered an internal error while processing the request.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Enable IP-based replication

Enables configuration for IP-based replication.

Table 3. Enable IP-based replication
URI /admin/resources/storage_controller_ports
Method PUT
Returns 202 Jobs were successfully queued to configure the ports.
500 Platform System Manager encountered an internal error while processing the request.

Request body

[
{
"gateway": "172.17.0.1", 
"name": "Management_Port_2", 
"vlan": 621, 
"mask": "255.255.248.0", 
"iscsi": "172.17.0.200"
},
{
"gateway": "172.17.0.1", 
"name": "IP_Repl_Port_1_1", 
"vlan": 621, 
"mask": "255.255.248.0", 
"iscsi": "172.17.0.201"
},
{
"gateway": "172.17.0.1", 
"name": "IP_Repl_Port_1_2", 
"vlan": 621, 
"mask": "255.255.248.0", 
"iscsi": "172.17.0.202"
}
]

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.