Validate VIM

Validate VIM

Validates a VIM.

Request
URI
PUT
https://{api_host}/tca/vim/api/v1/orgs/{orgId}/vims
COPY
Path Parameters
string
orgId
Required

orgId

Query Parameters
string
action
Required

action type e.g. 'validate'.

Request Body
RegisterVim of type(s) application/json
Optional 
{
    "hcxCloudUrl": "string",
    "vimName": "string",
    "tenantName": "string",
    "username": "string",
    "password": "string",
    "clusterName": "string",
    "kubeconfig": "string",
    "cloudSubType": "string",
    "region": "string",
    "authType": "string",
    "tags": [
        {
            "autoCreated": false
        }
    ]
}
string
hcxCloudUrl
Optional

The Control-Plane server URL, e.g. 'https://cp-server/', that manages the VIM.

string
vimName
Optional

The user-friendly name to be given to the VIM registered in TCA.

string
tenantName
Optional

The name of tenant, who owns the VIM (or a share of the VIM, in case of multi-tenant VIM, e.g. VMware vCloud Director, VIO).

string
username
Optional

The username associated with the tenants ownership in the VIM. Required if other authentication modes (e.g. kubeconfig for Kubernetes VIMs) are not specified.

string
password
Optional

The password associated with the username. Required if the 'username' is specified.

string
clusterName
Optional

The name of the Kubernetes cluster where the VNFs/CNFs will be hosted. This must be present in the kubeconfig specified.

string
kubeconfig
Optional

The kubefonfig content associated with (or having) the 'custerName'.

string
cloudSubType
Optional

The underlying cloud type for the Kubernetes VIM, e.g. 'eks', 'tkg'. Defaults to 'tkg' if unspecified.

string
region
Optional

The region for the Kubernetes VIM.

string
authType
Optional

The authentication type for the VIM registration. This authentication is used to access the underlying infrastructure of the VIM and is recognized by same. Allowed values include 'kubeconfig' and 'password'.

array of Tag
tags
Optional

A container for the list of tags to be associated with the VIM.

Authentication
This operation uses the following authentication methods.
Responses
200

validate VIM response

Returns ValidateVimResponse of type(s) application/json 
{
    "status": "string",
    "statusCode": 0,
    "reason": "string",
    "headers": [
        {}
    ],
    "cookies": {
        "name": "string",
        "value": "string",
        "domain": "string",
        "path": "string",
        "expiry": 0
    },
    "result": "string"
}
string
status
Optional

The values include 'ACTIVE', 'NOT_ACTIVE', and 'MAINTENANCE_MODE'.

integer
statusCode
Optional

The status code corresponding to the 'state' above.

string
reason
Optional

A brief statement indicating the cause of the state (if NOT_ACTIVE).

array of headers
headers
Optional

headers

object
cookies
Optional

cookies

string
result
Optional

result


On This Page
Vim Operations
GET
Get Tenants
GET
Get Vims
PUT
Modify Vim
POST
Register VIM
DELETE
Remove Vim
PUT
Validate VIM