Avi CloudConnectorUser Object API
CLI ``` - configure cloudconnectoruser - show cloudconnectoruser - test cloudconnectoruser ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /cloudconnectoruserpost /cloudconnectoruserdelete /cloudconnectoruser/{uuid}get /cloudconnectoruser/{uuid}patch /cloudconnectoruser/{uuid}put /cloudconnectoruser/{uuid}post /cloudconnectoruser/{uuid}/test
Up
get /cloudconnectoruser
(cloudconnectoruserGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"public_key" : "aeiou",
"azure_userpass" : {
"password" : "aeiou",
"tenant_name" : "aeiou",
"username" : "aeiou"
},
"nsxt_credentials" : {
"password" : "aeiou",
"username" : "aeiou"
},
"tencent_credentials" : {
"secret_id" : "aeiou",
"secret_key" : "aeiou"
},
"private_key" : "aeiou",
"azure_serviceprincipal" : {
"tenant_id" : "aeiou",
"authentication_token" : "aeiou",
"application_id" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"password" : "aeiou",
"gcp_credentials" : {
"service_account_keyfile_data" : "aeiou"
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vcenter_credentials" : {
"password" : "aeiou",
"username" : "aeiou"
},
"configpb_attributes" : {
"version" : 123
},
"oci_credentials" : {
"pass_phrase" : "aeiou",
"key_content" : "aeiou",
"fingerprint" : "aeiou",
"user" : "aeiou"
}
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
CloudConnectorUserApiResponse
401
log in failed
Up
post /cloudconnectoruser
(cloudconnectoruserPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — CloudConnectorUser object creation
Return type
Example data
Content-Type: application/json
{
"public_key" : "aeiou",
"azure_userpass" : {
"password" : "aeiou",
"tenant_name" : "aeiou",
"username" : "aeiou"
},
"nsxt_credentials" : {
"password" : "aeiou",
"username" : "aeiou"
},
"tencent_credentials" : {
"secret_id" : "aeiou",
"secret_key" : "aeiou"
},
"private_key" : "aeiou",
"azure_serviceprincipal" : {
"tenant_id" : "aeiou",
"authentication_token" : "aeiou",
"application_id" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"password" : "aeiou",
"gcp_credentials" : {
"service_account_keyfile_data" : "aeiou"
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vcenter_credentials" : {
"password" : "aeiou",
"username" : "aeiou"
},
"configpb_attributes" : {
"version" : 123
},
"oci_credentials" : {
"pass_phrase" : "aeiou",
"key_content" : "aeiou",
"fingerprint" : "aeiou",
"user" : "aeiou"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
CloudConnectorUser
401
log in failed
Up
delete /cloudconnectoruser/{uuid}
(cloudconnectoruserUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /cloudconnectoruser/{uuid}
(cloudconnectoruserUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"public_key" : "aeiou",
"azure_userpass" : {
"password" : "aeiou",
"tenant_name" : "aeiou",
"username" : "aeiou"
},
"nsxt_credentials" : {
"password" : "aeiou",
"username" : "aeiou"
},
"tencent_credentials" : {
"secret_id" : "aeiou",
"secret_key" : "aeiou"
},
"private_key" : "aeiou",
"azure_serviceprincipal" : {
"tenant_id" : "aeiou",
"authentication_token" : "aeiou",
"application_id" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"password" : "aeiou",
"gcp_credentials" : {
"service_account_keyfile_data" : "aeiou"
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vcenter_credentials" : {
"password" : "aeiou",
"username" : "aeiou"
},
"configpb_attributes" : {
"version" : 123
},
"oci_credentials" : {
"pass_phrase" : "aeiou",
"key_content" : "aeiou",
"fingerprint" : "aeiou",
"user" : "aeiou"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
CloudConnectorUser
401
log in failed
Up
patch /cloudconnectoruser/{uuid}
(cloudconnectoruserUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — CloudConnectorUser object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"public_key" : "aeiou",
"azure_userpass" : {
"password" : "aeiou",
"tenant_name" : "aeiou",
"username" : "aeiou"
},
"nsxt_credentials" : {
"password" : "aeiou",
"username" : "aeiou"
},
"tencent_credentials" : {
"secret_id" : "aeiou",
"secret_key" : "aeiou"
},
"private_key" : "aeiou",
"azure_serviceprincipal" : {
"tenant_id" : "aeiou",
"authentication_token" : "aeiou",
"application_id" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"password" : "aeiou",
"gcp_credentials" : {
"service_account_keyfile_data" : "aeiou"
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vcenter_credentials" : {
"password" : "aeiou",
"username" : "aeiou"
},
"configpb_attributes" : {
"version" : 123
},
"oci_credentials" : {
"pass_phrase" : "aeiou",
"key_content" : "aeiou",
"fingerprint" : "aeiou",
"user" : "aeiou"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
CloudConnectorUser
401
log in failed
Up
put /cloudconnectoruser/{uuid}
(cloudconnectoruserUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — CloudConnectorUser object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"public_key" : "aeiou",
"azure_userpass" : {
"password" : "aeiou",
"tenant_name" : "aeiou",
"username" : "aeiou"
},
"nsxt_credentials" : {
"password" : "aeiou",
"username" : "aeiou"
},
"tencent_credentials" : {
"secret_id" : "aeiou",
"secret_key" : "aeiou"
},
"private_key" : "aeiou",
"azure_serviceprincipal" : {
"tenant_id" : "aeiou",
"authentication_token" : "aeiou",
"application_id" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"password" : "aeiou",
"gcp_credentials" : {
"service_account_keyfile_data" : "aeiou"
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vcenter_credentials" : {
"password" : "aeiou",
"username" : "aeiou"
},
"configpb_attributes" : {
"version" : 123
},
"oci_credentials" : {
"pass_phrase" : "aeiou",
"key_content" : "aeiou",
"fingerprint" : "aeiou",
"user" : "aeiou"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
CloudConnectorUser
401
log in failed
Up
post /cloudconnectoruser/{uuid}/test
(cloudconnectoruserUuidTestPost)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — CloudConnectorUserTestParams
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
[ Jump to Methods ]
Table of Contents
AzureServicePrincipalCredentialsAzureUserPassCredentialsCloudConnectorUserCloudConnectorUserApiResponseCloudConnectorUserTestParamsConfigPbAttributesGCPCredentialsNsxtCredentialsOCICredentialsTencentCredentialsVCenterCredentials
application_id (optional)
String Application Id created for Avi Controller. Required for application id based authentication only. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
authentication_token (optional)
String Authentication token created for the Avi Controller application. Required for application id based authentication only. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_id (optional)
String Tenant ID for the subscription. Required for application id based authentication only. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
password (optional)
String Password for Azure subscription. Required only if username is provided. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_name (optional)
String Tenant or the active directory associated with the subscription. Required for user name password authentication. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
username (optional)
String Username for Azure subscription. Required only for username password based authentication. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
azure_serviceprincipal (optional)
azure_userpass (optional)
AzureUserPassCredentials Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
gcp_credentials (optional)
GCPCredentials Credentials for Google Cloud Platform. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nsxt_credentials (optional)
NsxtCredentials Credentials to talk to NSX-T manager. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.
oci_credentials (optional)
OCICredentials Credentials for Oracle Cloud Infrastructure. Field introduced in 18.2.1,18.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
password (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
private_key (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
public_key (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tencent_credentials (optional)
TencentCredentials Credentials for Tencent Cloud. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_credentials (optional)
VCenterCredentials Credentials to talk to VCenter. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
host (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32
service_account_keyfile_data (optional)
String Google Cloud Platform Service Account keyfile data in JSON format. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
password (optional)
String Password to talk to Nsx-t manager. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
username (optional)
String Username to talk to Nsx-t manager. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fingerprint (optional)
String API key with respect to the Public Key. Field introduced in 18.2.1,18.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key_content (optional)
String Private Key file (pem file) content. Field introduced in 18.2.1,18.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pass_phrase (optional)
String Pass phrase for the key. Field introduced in 18.2.1,18.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
user (optional)
String Oracle Cloud Id for the User. Field introduced in 18.2.1,18.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
secret_id
String Tencent secret ID. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
secret_key
String Tencent secret key. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
password (optional)
String Password to talk to VCenter server. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
username (optional)
String Username to talk to VCenter server. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.