Update

PUT v1/network_configs/id

Description

Modify attributes of a network configuration.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Detail Codes

SM_array_missing_subnet

SM_at_least_one_group_subnet

SM_at_least_one_iscsi_cluster

SM_backup_netconfig_readonly

SM_connection_rebalancing_without_automatic_method

SM_data_ip_missing_subnet

SM_data_ip_not_on_subnet

SM_default_gateway_not_in_mgmt_subnet

SM_default_route_missing

SM_duplicate_ip

SM_duplicate_subnet_label

SM_duplicate_subnet_vlan_id

SM_extraneous_array_netconfig

SM_gateway_not_in_subnets

SM_info_config_sync_inprogress

SM_initiatorgrp_subnet_does_not_exist

SM_invalid_arg_value

SM_invalid_array_name

SM_invalid_data_ip

SM_invalid_data_subnet

SM_invalid_discovery_ip

SM_invalid_netconfig_name

SM_invalid_netmask

SM_invalid_netzone_type

SM_invalid_non_iscsi_data_subnet

SM_invalid_non_iscsi_data_subnet_type

SM_invalid_path_variable

SM_invalid_query_param

SM_invalid_route

SM_invalid_subnet

SM_invalid_subnet_label

SM_invalid_vlan_id

SM_ip_update_no_force

SM_malformed_url

SM_mgmt_ip_invalid

SM_mgmt_ip_not_on_mgmt

SM_mismatching_duplicate_subnet

SM_missing_array_netconfig

SM_missing_discovery_ip

SM_multi_array_without_automatic_connection_method

SM_netconfig_already_active

SM_netconfig_does_not_exist

SM_netconfig_update_mismatch

SM_no_data_ip_on_mgmt_plus_data

SM_no_data_ip_specified

SM_no_discovery_ip_in_manual_mode

SM_no_method_for_URL_pattern

SM_no_mgmt_subnet_specified

SM_no_operation_found

SM_no_path_found

SM_no_subnet_with_label

SM_overlapping_subnets

SM_partner_subnet_does_not_exist

SM_route_exists

SM_second_mgmt_subnet

SM_second_untagged_assignment

SM_subnet_already_assigned_on_nic

SM_support_ip_invalid

SM_support_ip_not_on_mgmt

SM_unexpected_arg

SM_unexpected_query_param

SM_untagged_mtu_not_largest

SM_version_name

SM_vlan_subnet_in_manual

SM_zero_vlan_id_for_tagged_assignment

Request

Parameter	Type	JSON Type	Description	Mandatory	Deprecated
id	NsObjectID	string	Identifier for network configuration. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.	true
name	NsNetConfigName	string enum	Name of the network configuration. Use the name 'draft' when creating a draft configuration. Possible values: 'active', 'backup', 'draft'.	true
mgmt_ip	NsIPAddress	string	Management IP for the Group. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'.	true
iscsi_automatic_connection_method	NsBoolean	boolean	Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP to the best data IP based on connection counts. Possible values: 'true', 'false'.	true
iscsi_connection_rebalancing	NsBoolean	boolean	Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP. Possible values: 'true', 'false'.	true
route_list	NsRouteConfigs	Array of NsRoute	List of static routes. List of route configs.	true
subnet_list	NsSubnetConfigs	Array of NsSubnet	List of subnet configs. List of subnet configs.	true
array_list	NsArrayNetConfigs	Array of NsArrayNet	List of array network configs. List of array network configs.	true

JSON Request

Response

Parameter	Type	JSON Type	Description	Deprecated
id	NsObjectID	string	Identifier for network configuration. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
name	NsNetConfigName	string enum	Name of the network configuration. Use the name 'draft' when creating a draft configuration. Possible values: 'active', 'backup', 'draft'.
mgmt_ip	NsIPAddress	string	Management IP for the Group. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'.
role	NsNetConfigRole	string enum	Role of network configuration. Possible values: 'active', 'backup', 'draft'.
iscsi_automatic_connection_method	NsBoolean	boolean	Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP to the best data IP based on connection counts. Possible values: 'true', 'false'.
iscsi_connection_rebalancing	NsBoolean	boolean	Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP. Possible values: 'true', 'false'.
route_list	NsRouteConfigs	Array of NsRoute	List of static routes. List of route configs.
subnet_list	NsSubnetConfigs	Array of NsSubnet	List of subnet configs. List of subnet configs.
array_list	NsArrayNetConfigs	Array of NsArrayNet	List of array network configs. List of array network configs.
group_leader_array	NsObjectName	string	Name of the group leader array. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
creation_time	NsTime	number	Time when this net configuration was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
last_modified	NsTime	number	Time when this network configuration was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
active_since	NsTime	number	Start time of activity. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
last_active	NsTime	number	Time of last activity. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.

JSON Response