Changing port settings

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 add, as an integer from 1 through 4094. If you will also specify a VLAN ID to delete, make sure the VLAN ID to add is not the same as the VLAN ID to delete. (Optional) deleteVlanId (int) Specify the VLAN ID to delete, 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 (string) 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