Network:Update Network

Search (SHIFT+S)



Update Network

PUT /vdc/networks/{id}

Update a network's name, endpoints or varrays.

When endpoints are changed, added or removed, and the endpoints match some storage ports, the storage ports associations to the network are updated accordingly. If the endpoints added exist is another network, they are first removed from their current network. Discovered endpoints cannot be removed from their current networks or added to another one.

When the storage ports networks are changed, their corresponding storage pools are also update to reflect any change in varray connectivity that may have resulted from the change.

For backward compatibility, this function still allows the varray changes to be done using {@link NetworkUpdate#getVarrays()}. The value specified in the parameter will override the existing varrays to maintain the same behavior. Further, only zero or one varray may be specified using this input field.

idthe URN of a ViPR network

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • RESTRICTED_SYSTEM_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<network_update>
<name> Name of the network; must be unique. String Valid Values:
  •  Must be unique within all existing networks.
  •  example: network1
  •  Length: 2..128
<varrays> List containing 0 or 1 virtual arrays. Empty list will unassign the network from its existing virtual array. List with one element will assign the network to the virtual array. This field is maintained for backward compatibility and {@link #getVarrayChanges()} should be used instead. When used it will override the existing virtual arrays of a network.
<varray> URI 0-* Elements
Valid Values:
  •  example: [ urn:storageos:VirtualArray:0de17e53-f657-4354-a547-0a47049013cb: ]
  •  example: [ ]
</varrays>
<varray_assignment_changes>     Valid Values:
  •  lists of valid URIs for active virtual arrays
<add>    
<varray> String 0-* Elements
</add>      
<remove>    
<varray> String 0-* Elements
</remove>      
</varray_assignment_changes>      
<endpoint_changes>     Valid Values:
  •  valid endpoints for the network type (FC, IP or Ethernet)
<add> List of endpoints to be added
<endpoint> String 0-* Elements
</add>
<remove> List of endpoints to be removed
<endpoint> String 0-* Elements
</remove>
</endpoint_changes>      
</network_update>

Response Body

The details of the updated network

Field Description Type Notes
<network>
<discovered> Indicates whether the network was discovered by a network system or manually created. Boolean Valid Values:
  •  true = network was discovered by a network system
  •  false = network was manually created
<endpoints> List of endpoints associated with the network.
<endpoint> String 0-* Elements
</endpoints>
<endpoints_discovered> List of endpoints associated with the network. Each endpoint is indexed to "true" indicating it was discovered or "false" indicating it was manually added into the network.
<endpoint_discovered>     0-* Elements
<alias> String
<name> String
<value> String
</endpoint_discovered>      
</endpoints_discovered>
<fabric_id> Fabric name or VSAN (Virtual Storage Area Network) ID for the network if discovered by a network system. String
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<network_systems> List of network systems that manage the network. These are the network systems where the network was discovered. Empty list for manually created network.
<network_system> String 0-* Elements
</network_systems>
<assigned_varrays> List of virtual arrays to which the network is assigned.
<assigned_varray> String 0-* Elements
</assigned_varrays>
<connected_varrays> List of virtual arrays to which the network is implicitly connected because a storage port in the network has been assigned to the virtual array.
<connected_varray> String 0-* Elements
</connected_varrays>
<registration_status> Indicates whether the network and its endpoints can be used for provisioning operation. Only registered networks can be used for provisioning operations. String Valid Values:
  •  UNREGISTERED
  •  REGISTERED
<transport_type> Transport type for the network. Valid values are IP, FC, and Ethernet. String Valid Values:
  •  IP for IP and iSCSI endpoints
  •  FC = Fibre Channel
  •  Ethernet
<routed_networks> A list of networks that are routed to this network
<routed_network> String 0-* Elements
Valid Values:
  •  FC = None
</routed_networks>
<native_guid> The native unique identifier for this resource

Network Transport Types:

  • FC = Fibre-Channel

Network System Types:

  • BROCADE
  • MDS

Storage System Types:

  • CELERRA = VNX File
  • CLARIION = VNX Block
  • ISILON
  • NETAPP
  • SYMMETRIX
String Valid Values:
  •  Network : transport-type+network-system-type+fabric-WWN
  •  NetworkSystem: network-system-type+management-IP-address+management-port
  •  StoragePool : storage-system-type+storage-system-serial-number+POOL+pool-native-id
  •  StoragePort : storage-system-type+storage-system-serial-number+PORT+port-network-id
  •  StorageSystem: storage-system-type+serial-number
  •  StorageTier, Auto-Tiering: storage-system-type+storage-system-serial-number+FASTPOLICY+policy-name
  •  StorageTier, VMAX: storage-system-type+storage-system-serial-number+TIER+tier-name
  •  StorageTier, VNX: storage-system-type+storage-system-serial-number+TIER+pool-name+tier-name
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI Valid Values:
  •  urn:storageos:resource-type:UUID:
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean Valid Values:
  •  true
  •  false
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean Valid Values:
  •  true
  •  false
</network>
Notes: