NSX-T Data Center REST API
Project (schema)
Policy Project
Project is a construct that provides network isolation for all
its contents out of the box, where the compute and networking elements
within are isolated from other Projects. The Project will also be used to provide
hybridity across on-prem datacenters and the cloud, thus providing a means
of building private clouds with elements both on-prem and in the cloud.
The project can be created by users with Org Admin role and read access to Tier0s and Edge clusters.
Read access to Tier0s and Edge clusters can be achieved by either associating the user with another role with the required permissions (say Auditor),
or by sharing the Tier0s and Edge clusters with the Org before creating the project. The project can also be created by users with Enterprise Admin role
without explicit sharing of Tier0s and Edge clusters.
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 |
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) ChildVpc |
|
dedicated_resources | DedicatedResources | ||
default | Flag to indicate that the project is a default project true - the project is a default project. Default projects are non-editable, system create ones. |
boolean | Readonly |
description | Description of this resource | string | Maximum length: 1024 Sortable |
display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
external_ipv4_blocks | PolicyPath of public ip block IP block used for allocating CIDR blocks for public subnets. IP block can be consumed by all the VPCs under this project. CIDR that must be unique across Org/provider and will be auto advertised up to Org/Provider Tier0 gateway. |
array of string | Maximum items: 5 |
id | Unique identifier of this resource | string | Sortable |
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 gets 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 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 is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. |
string | Readonly |
resource_type | Must be set to the value Project | string | |
short_id | Identifier to use when displaying project context in logs Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set. |
string | Maximum length: 8 |
site_infos | Collection of Site information Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed. |
array of SiteInfo | Maximum items: 16 |
tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
tier_0s | Array of Tier 0s path or label associated with this Project. The tier 0 path or label of type Tier0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans. Label should have reference of Tier0 path. |
array of string | |
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 |