Vim

Vim

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

JSON Example

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

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.

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.

object

connection

Optional

Describes the status of the VIM and its connectivity.

boolean

compatible

Optional

compatible

array of object

vnfInstancesCounts

Optional

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

object

stats

Optional

The usage statistics of the VIM.

string

id

Optional

id

string

name

Optional

name

Property Of

Tenant

VimList