NSX-T Data Center REST API
# ***************************************************************************
# Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential.
# ***************************************************************************
ComputeManager (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 |
| certificate | Data of CA certificate for compute manager. Specifies CA certificate data for compute manager fetched from VC. |
CACertificateData | |
| create_service_account | Specifies whether service account is created or not on compute manager Enable this flag to create service account user on compute manager. This is required by features such as vSphere Lifecycle Manager for authentication with vAPIs from nsx. From VCF 9.0 service account is mandatory. |
boolean | Default: "True" |
| credential | Login credentials for the compute manager Supported credential types are 'SamlTokenLoginCredential'. Please note 'UsernamePasswordLoginCredential' and 'SessionLoginCredential' are deprecated. VerifiableAsymmetricLoginCredential is used for internal purpose only. |
LoginCredential (Abstract type: pass one of the following concrete types) LoginCredential SamlTokenLoginCredential SessionLoginCredential UsernamePasswordLoginCredential VerifiableAsymmetricLoginCredential |
|
| 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 |
| extension_certificate | Specifies certificate for compute manager extension Specifies certificate for compute manager extension registered on vCenter. |
CertificateData | |
| id | Unique identifier of this resource | string | Sortable |
| multi_nsx | Specifies whether multi nsx feature is enabled for compute manager Enable this flag to manage same compute manager by multiple nsx. |
boolean | Default: "False" |
| origin_properties | Key-Value map of additional specific properties of compute manager | array of KeyValuePair | Readonly |
| origin_type | Compute manager type like vCenter | string | Required |
| resource_type | Must be set to the value ComputeManager | string | |
| reverse_proxy_https_port | Proxy https port of compute manager Specifies https port of the reverse proxy to connect to compute manager. For e.g. In case of VC, this port can be retrieved from this config file /etc/vmware-rhttpproxy/config.xml. |
integer | Minimum: 1 Maximum: 65535 Default: "443" |
| server | IP address or hostname of compute manager | string | Required Format: hostname-or-ip |
| set_as_oidc_provider | Specifies whether compute manager has been set as OIDC provider If the compute manager is VC and need to set set as OIDC provider for NSX then this flag should be set as true. This is specific to wcp feature, should be enabled when this feature is being used. |
boolean | Default: "True" |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| vpc_access_level | VPC access level Defines representation and consumption of VPCs from default Project in vCenter: - Full Access: VPC and Subnet available for configuration from vCenter - READONLY: VPC and Subnet available in vCenter for read only access from vCenter - DISABLED: No VPC objects in vCenter, networks are represented as PortGroup under relevant VDS |
string | Enum: FULL, READONLY, DISABLED Default: "FULL" |
| access_level_for_oidc | Specifies access level to NSX from the compute manager This is a deprecated property which is always set as FULL. Specifies the maximum access level allowed for calls from compute manager to NSX using the OIDC provider. |
string | Deprecated Enum: FULL, LIMITED Default: "FULL" |