Avi CloudConnectorUser Object API

CLI ``` - configure cloudconnectoruser - show cloudconnectoruser - test cloudconnectoruser ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /cloudconnectoruser
  2. post /cloudconnectoruser
  3. delete /cloudconnectoruser/{uuid}
  4. get /cloudconnectoruser/{uuid}
  5. patch /cloudconnectoruser/{uuid}
  6. put /cloudconnectoruser/{uuid}
  7. 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

CloudConnectorUserApiResponse

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"
    },
    "oci_credentials" : {
      "pass_phrase" : "aeiou",
      "key_content" : "aeiou",
      "fingerprint" : "aeiou",
      "user" : "aeiou"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

CloudConnectorUser

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"
  },
  "oci_credentials" : {
    "pass_phrase" : "aeiou",
    "key_content" : "aeiou",
    "fingerprint" : "aeiou",
    "user" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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

CloudConnectorUser

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"
  },
  "oci_credentials" : {
    "pass_phrase" : "aeiou",
    "key_content" : "aeiou",
    "fingerprint" : "aeiou",
    "user" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept 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

CloudConnectorUser

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"
  },
  "oci_credentials" : {
    "pass_phrase" : "aeiou",
    "key_content" : "aeiou",
    "fingerprint" : "aeiou",
    "user" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept 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

CloudConnectorUser

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"
  },
  "oci_credentials" : {
    "pass_phrase" : "aeiou",
    "key_content" : "aeiou",
    "fingerprint" : "aeiou",
    "user" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept 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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AzureServicePrincipalCredentials
  2. AzureUserPassCredentials
  3. CloudConnectorUser
  4. CloudConnectorUserApiResponse
  5. CloudConnectorUserTestParams
  6. GCPCredentials
  7. NsxtCredentials
  8. OCICredentials
  9. TencentCredentials
  10. VCenterCredentials

AzureServicePrincipalCredentials Up

application_id (optional)
String Application Id created for Avi Controller. Required for application id based authentication only. Field introduced in 17.2.1.
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.
tenant_id (optional)
String Tenant ID for the subscription. Required for application id based authentication only. Field introduced in 17.2.1.

AzureUserPassCredentials Up

password (optional)
String Password for Azure subscription. Required only if username is provided. Field introduced in 17.2.1.
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.
username (optional)
String Username for Azure subscription. Required only for username password based authentication. Field introduced in 17.2.1.

CloudConnectorUser Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
azure_serviceprincipal (optional)
AzureServicePrincipalCredentials Field introduced in 17.2.1.
azure_userpass (optional)
AzureUserPassCredentials Field introduced in 17.2.1.
gcp_credentials (optional)
GCPCredentials Credentials for Google Cloud Platform. Field introduced in 18.2.1.
name
String Name of the object.
nsxt_credentials (optional)
NsxtCredentials Credentials to talk to NSX-T manager. Field introduced in 20.1.1.
oci_credentials (optional)
OCICredentials Credentials for Oracle Cloud Infrastructure. Field introduced in 18.2.1,18.1.3.
password (optional)
String password of CloudConnectorUser.
private_key (optional)
String private_key of CloudConnectorUser.
public_key (optional)
String public_key of CloudConnectorUser.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
tencent_credentials (optional)
TencentCredentials Credentials for Tencent Cloud. Field introduced in 18.2.3.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.
vcenter_credentials (optional)
VCenterCredentials Credentials to talk to VCenter. Field introduced in 20.1.1.

CloudConnectorUserApiResponse Up

count
Integer format: int32
results
next (optional)

CloudConnectorUserTestParams Up

host (optional)
String host of CloudConnectorUserTestParams.

GCPCredentials Up

service_account_keyfile_data (optional)
String Google Cloud Platform Service Account keyfile data in JSON format. Field introduced in 18.2.1.

NsxtCredentials Up

password (optional)
String Password to talk to Nsx-t manager. Field introduced in 20.1.1.
username (optional)
String Username to talk to Nsx-t manager. Field introduced in 20.1.1.

OCICredentials Up

fingerprint (optional)
String API key with respect to the Public Key. Field introduced in 18.2.1,18.1.3.
key_content (optional)
String Private Key file (pem file) content. Field introduced in 18.2.1,18.1.3.
pass_phrase (optional)
String Pass phrase for the key. Field introduced in 18.2.1,18.1.3.
user (optional)
String Oracle Cloud Id for the User. Field introduced in 18.2.1,18.1.3.

TencentCredentials Up

secret_id
String Tencent secret ID. Field introduced in 18.2.3.
secret_key
String Tencent secret key. Field introduced in 18.2.3.

VCenterCredentials Up

password (optional)
String Password to talk to VCenter server. Field introduced in 20.1.1.
username (optional)
String Username to talk to VCenter server. Field introduced in 20.1.1.