NSX-T Data Center REST API

Update the VPC Subnet

Update the VPC Subnet.

Request:

Method:

PUT

URI Path(s):

/policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

VpcSubnet+

VpcSubnet (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
access_mode	The access type for an VPC Subnet. There are four kinds of Access Types supported for an Application. Private - VPC Subnet is accessible only within the application and its IPs are allocated from private IP address pool from VPC configuration unless specified explicitly by user. Public - VPC Subnet is accessible from external networks and its IPs are allocated from public IP address pool from VPC configuration unless specified explicitly by user. Isolated - VPC Subnet is not accessible from other VPC Subnets within the same VPC. Please make use of Private, Private_TGW or Public Subnets with connectivity_state as DISCONNECTED to have a disconnected Subnet. Private_TGW - VPC Subnet is accessible from using connected TGW.	string	Enum: Private, Public, Isolated, Private_TGW Default: "Private"
advanced_config	VPC Subnet advanced configuration VPC Subnet advanced configuration. This field is supported only for VPC Subnets on NSX local manager.	SubnetAdvancedConfig
children	Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildDhcpStaticBindingConfig ChildIpAddressPool ChildSubnetConnectionBindingMap ChildVpcSubnetBridgeProfile ChildVpcSubnetPort
description	Description of this resource	string	Maximum length: 1024 Sortable
dhcp_config	DHCP config DHCP configuration for IPv4 subnets. VPC DHCP configuration is applied if this configuration is missing. This configuration when provided always takes precedence over VPC DHCP configuration.	VpcSubnetDhcpConfig
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ip_addresses	CIDR VPC Subnet IP addresses. If not provided, IP assignment will be done based on VPC CIDRs This represents the VPC Subnet that is associated with tier. If IPv4 CIDR is given, ipv4_subnet_size property is ignored. For IPv6 CIDR, supported prefix length is /64.	array of string	Maximum items: 2
ip_blocks	VPC IP Blocks For Subnet IP Allocation IP block path for subnet IP allocation. IP block is supported for only one IP address family, either IPv4 or IPv6. IP block should be part of: 1) VPC's Private IP block path or 2) VPC Connectivity Profile's attachment's External IP block path or 3) VPC Connectivity Profile's attachment's Project IP block path.	array of string	Maximum items: 1
ipv4_subnet_size	Size of the VPC Subnet based upon estimated workload count. If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64. If ip_addresses field is provided then ipv4_subnet_size field is ignored. This field cannot be modified after creating a VPC Subnet.	int	Minimum: 16 Maximum: 65536
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object get deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
origin_site_id	A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified locally by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
owner_id	A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing who owns this object. This is used in NSX+.	string	Readonly
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_path	Path of the object on the remote end. This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM.	string	Readonly
resource_type	Must be set to the value VpcSubnet	string
subnet_dhcp_config	DHCP configuration for subnet DHCP configurations for a specific subnet, including DHCP mode, DHCP server options, and reserved IPs.	SubnetDhcpConfig
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Example Request:

VPC subnet using DHCP configuration from VPC PUT https://<policy-mgr>/policy/api/v1/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1 { "id": "subnet-1", "resource_type": "VpcSubnet", "display_name": "Subnet 1", "description": "This is test VpcSubnet", "access_mode": "Private", "ip_addresses": ["10.112.2.0/24"], #IPv4, IPv6 -- could be empty which means "AUTO" "ipv4_subnet_size": 64, "dhcp_config": { "enable_dhcp": true }, "_revision": 0 } VPC subnet using DHCP configuration from VPC Service Profile { "id": "subnet-1", "resource_type": "VpcSubnet", "display_name": "Subnet 1", "description": "This is test VpcSubnet", "access_mode": "Private", "ip_addresses": ["10.112.2.0/24"], #IPv4, IPv6 -- could be empty which means "AUTO" "ipv4_subnet_size": 64, "subnet_dhcp_config": { "mode": "DHCP_SERVER", "dhcp_server_additional_config": { "options": { "others": [ { "code": 2, "values": [ "43200" ] } ]}, "reserved_ip_ranges": ["21.20.20.73"] } }, "_revision": 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

VpcSubnet+

VpcSubnet (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
access_mode	The access type for an VPC Subnet. There are four kinds of Access Types supported for an Application. Private - VPC Subnet is accessible only within the application and its IPs are allocated from private IP address pool from VPC configuration unless specified explicitly by user. Public - VPC Subnet is accessible from external networks and its IPs are allocated from public IP address pool from VPC configuration unless specified explicitly by user. Isolated - VPC Subnet is not accessible from other VPC Subnets within the same VPC. Please make use of Private, Private_TGW or Public Subnets with connectivity_state as DISCONNECTED to have a disconnected Subnet. Private_TGW - VPC Subnet is accessible from using connected TGW.	string	Enum: Private, Public, Isolated, Private_TGW Default: "Private"
advanced_config	VPC Subnet advanced configuration VPC Subnet advanced configuration. This field is supported only for VPC Subnets on NSX local manager.	SubnetAdvancedConfig
children	Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.	array of ChildPolicyConfigResource (Abstract type: pass one of the following concrete types) ChildDhcpStaticBindingConfig ChildIpAddressPool ChildSubnetConnectionBindingMap ChildVpcSubnetBridgeProfile ChildVpcSubnetPort
description	Description of this resource	string	Maximum length: 1024 Sortable
dhcp_config	DHCP config DHCP configuration for IPv4 subnets. VPC DHCP configuration is applied if this configuration is missing. This configuration when provided always takes precedence over VPC DHCP configuration.	VpcSubnetDhcpConfig
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ip_addresses	CIDR VPC Subnet IP addresses. If not provided, IP assignment will be done based on VPC CIDRs This represents the VPC Subnet that is associated with tier. If IPv4 CIDR is given, ipv4_subnet_size property is ignored. For IPv6 CIDR, supported prefix length is /64.	array of string	Maximum items: 2
ip_blocks	VPC IP Blocks For Subnet IP Allocation IP block path for subnet IP allocation. IP block is supported for only one IP address family, either IPv4 or IPv6. IP block should be part of: 1) VPC's Private IP block path or 2) VPC Connectivity Profile's attachment's External IP block path or 3) VPC Connectivity Profile's attachment's Project IP block path.	array of string	Maximum items: 1
ipv4_subnet_size	Size of the VPC Subnet based upon estimated workload count. If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64. If ip_addresses field is provided then ipv4_subnet_size field is ignored. This field cannot be modified after creating a VPC Subnet.	int	Minimum: 16 Maximum: 65536
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object get deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
origin_site_id	A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified locally by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
owner_id	A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing who owns this object. This is used in NSX+.	string	Readonly
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_path	Path of the object on the remote end. This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM.	string	Readonly
resource_type	Must be set to the value VpcSubnet	string
subnet_dhcp_config	DHCP configuration for subnet DHCP configurations for a specific subnet, including DHCP mode, DHCP server options, and reserved IPs.	SubnetDhcpConfig
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Example Response:

{ "id": "subnet-1", "resource_type": "VpcSubnet", "display_name": "Subnet 1", "description": "This is test VpcSubnet", "path": "/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1", "access_mode": "Private", "ip_addresses": ["10.112.2.0/24"], "ipv4_subnet_size": 64, "dhcp_config": { "enable_dhcp": true }, "_create_time": 1515745891661, "_last_modified_user": "admin", "_last_modified_time": 1515745891661, "_system_owned": false, "_create_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 1 } { "id": "subnet-1", "resource_type": "VpcSubnet", "display_name": "Subnet 1", "description": "This is test VpcSubnet", "path": "/orgs/org-1/projects/project-1/vpcs/vpc-1/subnets/subnet-1", "access_mode": "Private", "ip_addresses": ["10.112.2.0/24"], "ipv4_subnet_size": 64, "dhcp_server_additional_config": { "options": { "others": [ { "code": 2, "values": [ "43200" ] } ]}, "reserved_ip_ranges": ["21.20.20.73"] } }, "_create_time": 1515745891661, "_last_modified_user": "admin", "_last_modified_time": 1515745891661, "_system_owned": false, "_create_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 1 }

Required Permissions:

crud

Feature:

policy_vpc_subnet

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable