VCF Operations Disconnected Registration

Appliance Registration

This endpoint facilitates the registration of a VCF ops instance operating offline(disconnected mode). The request requires a multi-part payload containing the VCF ops name and the necessary registration file.

Request

URI

POST

https://eapi.broadcom.com/vcf/license-mgmt/api/v1/tenants/{tenant_id}/appliance-registration/upload

COPY

Path Parameters

string

tenant_id

Required

The id of the tenant

Request Body

This API take the VCF ops registration file as an upload.

ApplianceRegistrationRequest of type(s) multipart/form-data

Required

Show optional properties

{
    "name": "Private VCF",
    "file": "registration_file.data"
}

{
    "name": "string",
    "file": "string"
}

string

name

Required

Name of the appliance

string As binary As binary

file

Required

Multipart registration data file

Authentication

This operation uses the following authentication methods.

Bearer

Responses

201

VCF Ops registered successfully.

Returns ApplianceRegistrationResponse of type(s) application/json

{
    "vcf_ops_id": "f6151794-b2e6-4d75-b3fe-4b812aa6f292",
    "status": "SUCCESS",
    "message": "Successfully registered the VCF Ops",
    "created_on": "2024-05-10T14:30:00Z",
    "name": "LM-1"
}

string

model_version

Optional

Constraints: default: 1.0.0

model_version

string

vcf_ops_id

Optional

vcf_ops_id

string

name

Optional

name

string

status

Optional

RegistrationStatus

Possible values are : IN_PROGRESS, SUCCESS, ERROR,

string

message

Optional

message

string As date-time As date-time

created_on

Optional

created_on

string As uuid As uuid

tenant_id

Optional

tenant_id

400

Bad Request

Returns ErrorResponse of type(s) application/json

{
    "parameter_list": [
        "string"
    ],
    "message": "string",
    "major_error_code": "string",
    "minor_error_code": "string"
}

array of string

parameter_list

Optional

parameter_list

string

message

Optional

message

string

major_error_code

Optional

major_error_code

string

minor_error_code

Optional

minor_error_code

401

Unauthorized

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

array of string

parameter_list

Optional

parameter_list

string

message

Optional

message

string

major_error_code

Optional

major_error_code

string

minor_error_code

Optional

minor_error_code

403

Forbidden

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

array of string

parameter_list

Optional

parameter_list

string

message

Optional

message

string

major_error_code

Optional

major_error_code

string

minor_error_code

Optional

minor_error_code

404

Not Found

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

array of string

parameter_list

Optional

parameter_list

string

message

Optional

message

string

major_error_code

Optional

major_error_code

string

minor_error_code

Optional

minor_error_code

409

VCF Ops Already Registered

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

array of string

parameter_list

Optional

parameter_list

string

message

Optional

message

string

major_error_code

Optional

major_error_code

string

minor_error_code

Optional

minor_error_code

500

Internal Server Error

Returns ErrorResponse of type(s) application/json

"ErrorResponse Object"

array of string

parameter_list

Optional

parameter_list

string

message

Optional

message

string

major_error_code

Optional

major_error_code

string

minor_error_code

Optional

minor_error_code

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: multipart/form-data' -d '{"name:"string","file:"string"}' https://{api_host}/vcf/license-mgmt/api/v1/tenants/{tenant_id}/appliance-registration/upload

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

201 Response Body

Errors

Registration Operations

POST

VCF Operations Disconnected Registration