Modify Vim

Modify Vim

Modifies the registered VIM, given the path parameter tenantId.

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

orgId

string
vimId
Required

vimId

string
tenantId
Required

tenantId

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

The VIM after modification

Returns RegisterVimResponse of type(s) application/json 
{
    "tenantId": "string",
    "vimName": "string",
    "tenantName": "string",
    "state": "string",
    "hcxCloudUrl": "string",
    "username": "string",
    "password": "string",
    "tags": [
        {
            "autoCreated": false
        }
    ],
    "vimType": "string",
    "vimUrl": "string",
    "hcxUUID": "string",
    "hcxTenantId": "string",
    "organization": "string",
    "enterprise": "string",
    "configuration": {
        "isolationMode": "string"
    },
    "location": {
        "city": "string",
        "country": "string",
        "cityAscii": "string",
        "latitude": "string",
        "longitude": "string"
    },
    "vimId": "string",
    "audit": {
        "creationUser": "string",
        "creationTimestamp": 0
    }
}
string
tenantId
Optional

The TCA generated identifier for the tenant associated with 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
state
Optional

The state of the VIM registration operation.

string
hcxCloudUrl
Optional

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

string
username
Optional

The username associated with the tenants ownership in the VIM.

string
password
Optional

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

array of Tag
tags
Optional

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

string
vimType
Optional

The type of VIM. Allowed values include 'VC', 'VCD', 'VIO', 'KUBERNETES', 'VMC', 'AZURE', 'GOOGLECLOUD', 'IBMCLOUD'. The 'VC' stands for VMware vCenter™; 'VCD' for VMware vCloud-Director™, and 'VIO' for VMware-Integrated-Openstack™.

string
vimUrl
Optional

The URL to externally access the VIM. This corresponds to the API-service URL in case of Kubernetes VIM.

string
hcxUUID
Optional

An internal Unique identifier of the VIM, managed by the TCA Control-Plane.

string
hcxTenantId
Optional

An internal Unique identifier of the tenant, managed by the TCA Control-Plane.

string
organization
Optional

The tenancy name of the tenant, managed internally by the VIM.

string
enterprise
Optional

The tenancy enterprise (if any) of the tenant, managed internally by the VIM.

object
configuration
Optional

Describes the automation mode configuration of the VIM.

object
location
Optional

Describes the geographical location of the VIM (or its component, managed by the tenant).

string
vimId
Optional

The unique identifier to be used for referencing the VIM when using other APIs or Operations.

object
audit
Optional

The user details to log in the Audit-Trails.


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