Vcenter NamespaceManagement Networks Nsx Projects VpcConnectivityProfiles get
Returns information of a VPC Connectivity Profile.
This operation was added in vSphere API 9.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
System.Read.
Identifier of the Project.
The parameter must be an identifier for the resource type: NSXProject.
Identifier of the VPC Connectivity Profile.
The parameter must be an identifier for the resource type: VpcConnectivityProfile.
Information about a VPC Connectivity Profile.
{
"profile": "string",
"name": "string",
"nsx_path": "string",
"description": "string",
"default_profile": false,
"external_ip_blocks": [
{
"path": "string",
"name": "string",
"cidr": {
"address": "string",
"prefix": 0
},
"available_ip_ranges": [
{
"address": "string",
"count": 0
}
],
"used_ip_count": 0,
"available_ip_count": 0
}
],
"privatetgw_ip_blocks": [
{
"path": "string",
"name": "string",
"cidr": {
"address": "string",
"prefix": 0
},
"available_ip_ranges": [
{
"address": "string",
"count": 0
}
],
"used_ip_count": 0,
"available_ip_count": 0
}
]
}Identifier of the VPC Connectivity Profile.
This property was added in vSphere API 9.0.0.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VpcConnectivityProfile. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VpcConnectivityProfile.
Name of the VPC Connectivity Profile.
This property was added in vSphere API 9.0.0.0.
NSX path of the VPC Connectivity Profile.
This property was added in vSphere API 9.0.0.0.
Description of the VPC Connectivity Profile.
This property was added in vSphere API 9.0.0.0.
If missing or null, no description is added to the VPC Connectivity Profile.
true if this profile is the default VPC connectivity profile in the NSX project that profiles belongs to, false otherwise.
This property was added in vSphere API 9.0.0.0.
List of NSX external IP blocks currently configured with the VPC Connectivity Profile.
This property was added in vSphere API 9.0.0.0.
If missing or null, no external IP blocks are defined in the VPC Connectivity Profile.
List of NSX private TGW IP blocks currently configured with the VPC Connectivity Profile.
This property was added in vSphere API 9.0.0.0.
If missing or null, no private TGW IP blocks are defined in the VPC Connectivity Profile.
if the user cannot be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user does not have System.Read privilege.
"Vapi Std Errors Unauthorized Object"if profile cannot be located.
"Vapi Std Errors NotFound Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/namespace-management/networks/nsx/projects/{project}/vpc-connectivity-profiles/{profile}