NSX-T Data Center REST API
CloudIpAllocationMappings (schema)
Cloud IP Allocation Mappings
Information about Cloud IP mappings.
| 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 |
| cloud_account_id | Cloud Account ID ID of the Cloud Account in which the IPs are allocated. |
string | 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 |
| error_code | Error code for IP allocation failure | integer | Readonly |
| error_message | Error message for IP allocation failure | string | Readonly |
| id | Unique identifier of this resource | string | Sortable |
| ip_allocation_type | IP allocation type Based on the type, IP allocation will be done accordingly. Legal values are PAS and NAT. |
string | Readonly Enum: PAS, NAT Default: "PAS" |
| ip_mappings | IP mappings for a foundation. | array of CloudIpAllocationMapping | Readonly |
| ip_operation_status | IP Allocation State Indicates the state of the IP allocation or de-allocation. ALLOCATION_IN_PROGRESS: IP allocation is in progress. DELETION_IN_PROGRESS: IP de-allocation or deletion is in progress. SUCCESSFUL: IP allocation is successful. Successful de-allocation can be confirmed if the status API for this mapping returns a 404 error. FAILED: IP allocation or de-allocation failed. |
string | Readonly Enum: ALLOCATION_IN_PROGRESS, DELETION_IN_PROGRESS, SUCCESSFUL, FAILED |
| resource_type | Must be set to the value CloudIpAllocationMappings | string | |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |