Vim

Vim
Vim

A VIM instance. A VIM stands for Virtual Infrastructure Manager in the NFV parlance.

JSON Example
{
    "vimType": "vimType",
    "hcxUUID": "hcxUUID",
    "vimUrl": "vimUrl",
    "vimId": "vimId",
    "hcxCloudUrl": "hcxCloudUrl",
    "tags": [
        {
            "name": "{}",
            "autoCreated": true
        },
        {
            "name": "{}",
            "autoCreated": true
        }
    ],
    "compatible": true,
    "vimName": "vimName",
    "tenantName": "tenantName",
    "stats": {
        "memory": {
            "unit": "unit",
            "available": 1,
            "used": 6,
            "capacity": 5
        },
        "cpu": {
            "unit": "unit",
            "available": 1,
            "used": 6,
            "capacity": 5
        },
        "storage": {
            "unit": "unit",
            "available": 1,
            "used": 6,
            "capacity": 5
        }
    },
    "audit": {
        "creationUser": "creationUser",
        "creationTimestamp": "creationTimestamp"
    },
    "tenantId": "tenantId",
    "name": "name",
    "location": {
        "country": "country",
        "city": "city",
        "latitude": "latitude",
        "cityAscii": "cityAscii",
        "longitude": "longitude"
    },
    "connection": {
        "vimConnectionStatus": "vimConnectionStatus",
        "status": "status",
        "remoteStatus": "remoteStatus"
    },
    "id": "id",
    "username": "username",
    "vnfInstancesCounts": [
        {
            "totalSize": 0,
            "state": "state"
        },
        {
            "totalSize": 0,
            "state": "state"
        }
    ]
}
string
tenantId
Optional

The identifier used to reference the tenant of the VIM.

string
vimName
Optional

The user-friendly name associated with the VIM to be registered with the TCA.

string
tenantName
Optional

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

string
hcxUUID
Optional

Identifier for the TCA Control-Plane instance, that is associated with the VIM.

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. This is a mandatory field, if the authentication mode (‘authType’ or ‘auth_type’) specified is ‘password’.

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.

location
Optional

location

string
vimId
Optional

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

audit
Optional

audit

connection
Optional

connection

boolean
compatible
Optional

compatible

vnfInstancesCounts
Optional

The list of VNF/CNF counts, that are instantiated, and non-instantiated (or otherwise) on the VIM.

stats
Optional

stats

string
id
Optional

id

string
name
Optional

name