Create Virtual Center

Create Virtual Center

All the listed privileges are required -

Privileges Description
GLOBAL_CONFIG_MANAGEMENT Caller should have permission to this privilege, to perform this operation.
Request
URI
POST
https://{api_host}/rest/config/v3/virtual-centers
COPY
Request Body
VirtualCenterCreateSpecV3 of type(s) application/json
Required

Show optional properties

{
    "password": [
        {}
    ],
    "port": 443,
    "server_name": "vc1.example.com",
    "user_name": "[email protected]"
}
{
    "certificate_override": {
        "certificate": "string",
        "type": "PEM"
    },
    "deployment_type": "GENERAL",
    "description": "Virtual Center Server",
    "display_name": "vc1.example.com",
    "limits": {
        "instant_clone_engine_provisioning_limit": 20,
        "instant_clone_maintenance_limit": 12,
        "power_operations_limit": 50,
        "provisioning_limit": 20
    },
    "password": [
        "<password>"
    ],
    "port": 443,
    "se_sparse_reclamation_enabled": true,
    "server_name": "vc1.example.com",
    "storage_accelerator_data": {
        "default_cache_size_mb": 1024,
        "enabled": false,
        "host_overrides": [
            {
                "cache_size_mb": 2048,
                "path": "/path/host"
            }
        ]
    },
    "user_name": "[email protected]"
}
object
certificate_override
Optional

Certificate details and type information, which can be used to override thumbprint details.

string
deployment_type
Optional

Indicates different environments that Horizon can be deployed into.

  • GENERAL: Horizon is deployed on On-premises.
  • AZURE: Horizon is deployed on Azure.
  • AWS: Horizon is deployed on AWS.
  • DELL_EMC: Horizon is deployed on Dell EMC.
  • GOOGLE: Horizon is deployed on Google Cloud.
  • ORACLE: Horizon is deployed on Oracle Cloud.
Possible values are : GENERAL, AZURE, AWS, DELL_EMC, GOOGLE, ORACLE,
string
description
Optional
Constraints: minLength: 0 maxLength: 1024

Human readable description of the Virtual Center instance.

string
display_name
Optional
Constraints: minLength: 0 maxLength: 256

Human readable display name of the virtual center instance.

object
limits
Optional

Information about the limits configured for Virtual Center

array of string
password
Required

Password to use for the connection

integer As int32 As int32
port
Required
Constraints: minimum: 1 maximum: 65535

Port of the virtual center to connect to.

boolean
se_sparse_reclamation_enabled
Optional

Indicates if Storage Efficiency Sparse (seSparse) reclamation is enabled.

string
server_name
Required

Virtual Center’s server name or IP address

object
storage_accelerator_data
Optional

Information about the Storage Accelerator Data

string
user_name
Required

User name to use for the connection.

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Operation doesn't return any data structure

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

409

Conflict

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"password":["string"],"port:"integer","server_name:"string","user_name:"string"}' https://{api_host}/rest/config/v3/virtual-centers
On This Page
Config Operations
GET
Get Admin Users Or Groups Permissions
GET
Get Preferences
PUT
Update Preferences
GET
List App Volumes Managers
POST
Add App Volumes Manager
POST
Unassign Farms
POST
Validate AVM Certificate
DELETE
Delete App Volumes Manager
GET
Get App Volumes Manager
PUT
Update App Volumes Manager
POST
Assign Farms
POST
Override Certificate
POST
Push Certificates
GET
Get CEIP Info
PUT
Update CEIP Info
GET
List Connection Servers
POST
Back Up
DELETE
Delete Certificate
POST
Disable Connection Servers
POST
Enable Connection Servers
POST
Export Certificate
POST
Generate CSR
POST
Import Certificate
POST
Recover Certificates
GET
List Certificate Infos
GET
Get Security Configuration Info
GET
Get Connection Server
PUT
Update Connection Server
GET
Get Environment
GET
Get Event Database
PUT
Update Event Database
POST
Clear Event Database
GET
List Federation Access Groups
POST
Create Federation Access Group
DELETE
Delete Federation Access Group
GET
Get Federation Access Group
DELETE
Delete Gateway Access User Or Group
GET
List Gateway Access User Or Group
POST
Create Gateway Access User Or Group
GET
List Gateways
POST
Register Gateway
DELETE
Unregister Gateway
GET
Get Gateway
GET
Get Global Policies
PUT
Update Global Policies
GET
List GSSAPI Authenticators
POST
Create GSSAPI Authenticator
DELETE
Delete GSSAPI Authenticator
GET
Get GSSAPI Authenticator
PUT
Update GSSAPI Authenticator
GET
List IC Domain Accounts
POST
Create IC Domain Account
DELETE
Delete IC Domain Account
GET
Get IC Domain Account
PUT
Update IC Domain Account
GET
Get AD Sites Info
GET
List IM Assets
POST
Create IM Asset
POST
Create IM Assets
DELETE
Delete IM Asset
GET
Get IM Asset
PUT
Update IM Asset
GET
List IM Streams
POST
Create IM Stream
POST
Create IM Streams
DELETE
Delete IM Stream
GET
Get IM Stream
PUT
Update IM Stream
GET
List IM Tags
POST
Create IM Tag
POST
Create IM Tags
DELETE
Delete IM Tag
GET
Get IM Tag
PUT
Update IM Tag
GET
List IM Versions
POST
Create IM Version
POST
Create IM Versions
DELETE
Delete IM Version
GET
Get IM Version
PUT
Update IM Version
GET
List JWT Authenticators
POST
Create JWT Authenticator
DELETE
Delete JWT Authenticator
GET
Get JWT Authenticator
PUT
Update JWT Authenticator
GET
List Licenses
POST
Reset Highest Usage Metrics
POST
Reset Named User Metrics
POST
Set License Mode
GET
List Local Access Groups
POST
Create Local Access Group
DELETE
Delete Local Access Group
GET
Get Local Access Group
POST
Collect
GET
Get Log Levels
PUT
Set Log Levels
GET
List Log Collector Tasks
POST
Clean
POST
Generate Download UR Ls
POST
Purge
GET
List Message Clients
POST
Create Message Client
DELETE
Delete Message Client
GET
Get Message Client
PUT
Update Message Client
DELETE
Delete Permissions
GET
List Permissions
POST
Create Permissions
GET
Get Permission
GET
Get Pre Logon Settings
GET
List Selectable Privileges
GET
List RADIUS Authenticators
POST
Create RADIUS Authenticator
DELETE
Delete RADIUS Authenticator
GET
Get RADIUS Authenticator
PUT
Update RADIUS Authenticator
POST
Register RCX Client
DELETE
Unregister RCX Client
PUT
Update RCX Client
GET
List RCX Servers
GET
List Roles
POST
Create Role
DELETE
Delete Role
GET
Get Role
PUT
Update Role
GET
List SAML Authenticators
POST
Create SAML Authenticator
POST
Validate SAML Certificate
DELETE
Delete SAML Authenticator
GET
Get SAML Authenticator
PUT
Update SAML Authenticator
GET
List Secondary Credentials
POST
Create Secondary Credential
DELETE
Delete Secondary Credential
GET
Get Secondary Credentials
POST
Updatepassword
GET
Get Settings
PUT
Update Settings
GET
Get Agent Restriction Settings
PUT
Update Agent Restriction Settings
GET
Get Client Settings
PUT
Update Client Settings
GET
Get Feature Settings
PUT
Update Feature Settings
GET
Get General Settings
PUT
Update General Settings
GET
Get Security Settings
PUT
Update Security Settings
GET
Get Syslog
PUT
Update Syslog
GET
List True SSO Connectors
POST
Create True SSO Connector
GET
List Enrollment Servers
GET
Get Enrollment Server
DELETE
Delete True SSO Connector
GET
Get True SSO Connector
PUT
Update True SSO Connector
GET
List Unauthenticated Access Users
POST
Create Unauthenticated Access User
DELETE
Delete Unauthenticated Access User
GET
Get Unauthenticated Access User
GET
List Users Or Groups Global Summary
GET
Get Users Or Groups Global Summary
GET
List Users Or Groups Local Summary
POST
Get Storage Details
GET
List VC Info
POST
Validate Virtual Center Certificate
POST
Mark Datastores For Archival
GET
Get Preferences V2
PUT
Update Preferences V2
GET
List App Volumes Managers V2
POST
Add App Volumes Manager V2
DELETE
Delete App Volumes Manager V2
GET
Get App Volumes Manager V2
PUT
Update App Volumes Manager V2
GET
List Connection Servers V2
GET
List Certificate Infos V2
GET
Get Connection Server V2
PUT
Update Connection Server V2
GET
Get Environment V2
GET
List Federation Access Groups V2
GET
Get Federation Access Group V2
GET
List Licenses V2
POST
Set License Key
GET
List Local Access Groups V2
GET
Get Local Access Group V2
DELETE
Delete Permissions V2
GET
List Permissions V2
POST
Create Permissions V2
GET
Get Permission V2
GET
Get Settings V2
PUT
Update Settings V2
GET
Get Feature Settings V2
PUT
Update Feature Settings V2
GET
Get General Settings V2
PUT
Update General Settings V2
GET
Get Security Settings V2
GET
List Users Or Groups Local Summary V2
GET
Get Users Or Group Local Summary V2
GET
List VC Info V2
GET
Get Settings V3
PUT
Update Settings V3
GET
Get General Settings V3
PUT
Update General Settings V3
GET
Get Security Settings V3
PUT
Update Security Settings V3
GET
List Users Or Groups Local Summary V3
GET
Get Users Or Group Local Summary V3
GET
List VC Info V3
POST
Create Virtual Center
DELETE
Remove Virtual Center
GET
Get Virtual Center
PUT
Update Virtual Center
GET
Get Settings V4
PUT
Update Settings V4
GET
Get General Settings V4
PUT
Update General Settings V4
GET
Get Security Settings V4
PUT
Update Security Settings V4
GET
List Users Or Groups Local Summary V4
GET
Get Users Or Group Local Summary V4
GET
List VC Info V4
POST
Create Virtual Center V4
GET
Get Virtual Center V4
PUT
Update Virtual Center V4
GET
Get Settings V5
PUT
Update Settings V5
GET
Get General Settings V5
PUT
Update General Settings V5
GET
Get Security Settings V5
PUT
Update Security Settings V5
GET
List VC Info V5
POST
Create Virtual Center V5
DELETE
Remove Virtual Center V5
GET
Get Virtual Center V5
PUT
Update Virtual Center V5
GET
Get Settings V6
PUT
Update Settings V6
GET
List VC Info V6