NSX-T Data Center REST API
VirtualNetworkApplianceCluster (type)
{
"additionalProperties": false,
"description": "VirtualNetworkApplianceCluster is the object,where logical group of Virtual Network Appliances related parameters are configured.",
"extends": {
"$ref": "PolicyConfigResource"
},
"id": "VirtualNetworkApplianceCluster",
"module_id": "VirtualNetworkApplianceCluster",
"policy_hierarchical_children": [
"ChildBaseNetworkAppliance"
],
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp",
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp",
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink"
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "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.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"computed": true,
"description": "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.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink",
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"advanced_configuration": {
"$ref": "VirtualNetworkApplianceClusterAdvancedConfiguration"
},
"appliance_form_factor": {
"$ref": "VirtualNetworkApplianceFormFactor",
"default": "MEDIUM",
"description": "The form factor of the virtual network appliance(VNA) in the cluster. In case of an update of the form factor field, new virtual network appliance(VNA) at the cluster level will be deployed with an updated form factor value. Virtual Network Appliance redeploy API <br>https://<nsx-mgr>policy/api/v1/infra/sites/default/enforcement-points/<enforcementpoint-id>/virtual-network-appliance-clusters/<virtual-network-appliance-cluster-id>/virtual-network-appliances/<virtual-network-appliance-id>/action/redeploy</br> is recommended to be used to apply/update the new form factor value in existing virtual network appliance(VNA). Any inconsistency in the form factor of the virtual network appliance(VNA) at the cluster level will be reported through the state API <<br>https://<nsx-mgr>policy/api/v1/infra/sites/default/enforcement-points/<enforcementpoint-id>/virtual-network-appliance-clusters/<virtual-network-appliance-cluster-id>/virtual-network-appliances/<virtual-network-appliance-id>/state</br>"
},
"appliance_type": {
"$ref": "VirtualNetworkApplianceType",
"default": "VirtualNetworkAppliance",
"description": "The virtual network appliance type of cluster.",
"readonly": true,
"title": "Virtual Network Appliance Type"
},
"children": {
"description": "Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.",
"items": {
"$ref": "ChildPolicyConfigResource"
},
"required": false,
"title": "Subtree for this type within policy tree",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"computed": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"marked_for_delete": {
"default": false,
"description": "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.",
"readonly": true,
"required": false,
"title": "Indicates whether the intent object is marked for deletion",
"type": "boolean"
},
"members": {
"description": "This field contains the virtual network appliance cluster members.",
"items": {
"$ref": "VirtualNetworkApplianceClusterMember"
},
"readonly": true,
"required": false,
"title": "Virtual Network Appliance Cluster Member",
"type": "array"
},
"origin_site_id": {
"description": "This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system for knowing which site owns an object",
"type": "string"
},
"overridden": {
"default": false,
"description": "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.",
"readonly": true,
"required": false,
"title": "Indicates whether this object is the overridden intent object",
"type": "boolean"
},
"owner_id": {
"description": "This is a UUID generated by the system for knowing who owns this object. This is used in NSX+.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system for the ownership of an object",
"type": "string"
},
"parent_path": {
"description": "Path of its parent",
"readonly": true,
"required": false,
"title": "Path of its parent",
"type": "string"
},
"password_managed_by_vcf": {
"default": true,
"description": "Setting to true enables VCF password management for all virtual network appliances in the cluster.",
"title": "VCF managed password flag",
"type": "boolean"
},
"path": {
"description": "Absolute path of this object",
"readonly": true,
"required": false,
"title": "Absolute path of this object",
"type": "string"
},
"realization_id": {
"description": "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.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system for realizing intent",
"type": "string"
},
"relative_path": {
"description": "Path relative from its parent",
"readonly": true,
"required": false,
"title": "Relative path of this object",
"type": "string"
},
"remote_path": {
"description": "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.",
"readonly": true,
"required": false,
"title": "Path of the object on the remote end.",
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"service_type": {
"$ref": "VirtualNetworkApplianceClusterType",
"default": "VPC_SERVICES",
"description": "If the service type is set to route controller then the virtual network appliance cluster is exclusively for route controller and can't be used to connect VPC workloads. By default, this field value is set to be VPC_SERVICES and it can not be modified after virtual network appliance cluster creation.",
"title": "Virtual Network Appliance Cluster Type"
},
"tags": {
"items": {
"$ref": "Tag"
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"unique_id": {
"description": "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.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system",
"type": "string"
}
},
"search_dsl_exclude": true,
"title": "Virtual Network Appliance(VNA) Cluster",
"type": "object"
}