Get Virtual Center

Get Virtual Center

At least one of the listed privileges is required -

Privileges Description
GLOBAL_CONFIG_VIEW Caller should have permission to this privilege, to perform this operation.
VC_CONFIG_VIEW Caller should have permission to this privilege, to perform this operation.
Request
URI
GET
https://{api_host}/rest/config/v3/virtual-centers/{id}
COPY
Path Parameters
string
id
Required

id

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VirtualCenterInfoV3 of type(s) */* 
{
    "certificate_override": {
        "certificate": "string",
        "type": "PEM"
    },
    "deployment_type": "string",
    "description": "Virtual Center Server",
    "display_name": "vc1.example.com",
    "enabled": true,
    "has_virtual_tpm_pools": false,
    "id": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
    "instance_uuid": "6605d116-d1b5-4810-8e3a-b710b30993da",
    "limits": {
        "instant_clone_engine_provisioning_limit": 20,
        "instant_clone_maintenance_limit": 12,
        "power_operations_limit": 50,
        "provisioning_limit": 20
    },
    "maintenance_mode": false,
    "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"
            }
        ]
    },
    "use_ssl": true,
    "user_name": "[email protected]",
    "version": "6.5.0",
    "virtualTPMPools": false
}
CertificateOverrideData
certificate_override
Optional

certificate_override

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

Human readable description of the Virtual Center instance.

string
display_name
Optional

Human readable name of the Virtual Center instance.

boolean
enabled
Optional

Indicates if the virtual center is enabled.

boolean
has_virtual_tpm_pools
Optional

Indicates if there is any instant clone Desktop pool associated with this Virtual Center which has addVirtualTPM set

string
id
Optional

Unique ID of the Virtual Center.

string
instance_uuid
Optional

Virtual center's instanceUuid.

VCLimitsV2
limits
Optional

limits

boolean
maintenance_mode
Optional

Indicates if maintenance or upgrade task is scheduled on Virtual center or hosts

integer As int32 As int32
port
Optional

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
Optional

Virtual Center's server name or IP address.

StorageAcceleratorData
storage_accelerator_data
Optional

storage_accelerator_data

boolean
use_ssl
Optional

Indicates if SSL should be used when connecting to the server.

string
user_name
Optional

User name to use for the connection.

string
version
Optional

Version of the Virtual Center.

boolean
virtualTPMPools
Optional

virtualTPMPools


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

404

Not Found

Operation doesn't return any data structure

On This Page
Config Operations
POST
Add App Volumes Manager
POST
Add App Volumes Manager V2
POST
Assign Farms
POST
Clean
POST
Clear Event Database
POST
Collect
POST
Create Federation Access Group
POST
Create Gateway Access User Or Group
POST
Create GSSAPI Authenticator
POST
Create IC Domain Account
POST
Create IM Asset
POST
Create IM Assets
POST
Create IM Stream
POST
Create IM Streams
POST
Create IM Tag
POST
Create IM Tags
POST
Create IM Version
POST
Create IM Versions
POST
Create JWT Authenticator
POST
Create Local Access Group
POST
Create Message Client
POST
Create Permissions
POST
Create Permissions V2
POST
Create RADIUS Authenticator
POST
Create Role
POST
Create SAML Authenticator
POST
Create Secondary Credential
POST
Create True SSO Connector
POST
Create Unauthenticated Access User
POST
Create Virtual Center
POST
Create Virtual Center V4
POST
Create Virtual Center V5
DELETE
Delete App Volumes Manager
DELETE
Delete App Volumes Manager V2
DELETE
Delete Certificate
DELETE
Delete Federation Access Group
DELETE
Delete Gateway Access User Or Group
DELETE
Delete GSSAPI Authenticator
DELETE
Delete IC Domain Account
DELETE
Delete IM Asset
DELETE
Delete IM Stream
DELETE
Delete IM Tag
DELETE
Delete IM Version
DELETE
Delete JWT Authenticator
DELETE
Delete Local Access Group
DELETE
Delete Message Client
DELETE
Delete Permissions
DELETE
Delete Permissions V2
DELETE
Delete RADIUS Authenticator
DELETE
Delete Role
DELETE
Delete SAML Authenticator
DELETE
Delete Secondary Credential
DELETE
Delete True SSO Connector
DELETE
Delete Unauthenticated Access User
POST
Disable Connection Servers
POST
Enable Connection Servers
POST
Export Certificate
POST
Generate CSR
GET
Get Admin Users Or Groups Permissions
GET
Get AD Sites Info
GET
Get Agent Restriction Settings
GET
Get App Volumes Manager
GET
Get App Volumes Manager V2
GET
Get CEIP Info
GET
Get Client Settings
GET
Get Connection Server
GET
Get Connection Server V2
GET
Get Enrollment Server
GET
Get Environment
GET
Get Environment V2
GET
Get Event Database
GET
Get Feature Settings
GET
Get Federation Access Group
GET
Get Federation Access Group V2
GET
Get Gateway
GET
Get General Settings
GET
Get General Settings V2
GET
Get General Settings V3
GET
Get General Settings V4
GET
Get Global Policies
GET
Get GSSAPI Authenticator
GET
Get IC Domain Account
GET
Get IM Asset
GET
Get IM Stream
GET
Get IM Tag
GET
Get IM Version
GET
Get JWT Authenticator
GET
Get Local Access Group
GET
Get Local Access Group V2
GET
Get Message Client
GET
Get Permission
GET
Get Permission V2
GET
Get Preferences
GET
Get Preferences V2
GET
Get Pre Logon Settings
GET
Get RADIUS Authenticator
GET
Get Role
GET
Get SAML Authenticator
GET
Get Secondary Credentials
GET
Get Security Configuration Info
GET
Get Security Settings
GET
Get Security Settings V2
GET
Get Security Settings V3
GET
Get Security Settings V4
GET
Get Settings
GET
Get Settings V2
GET
Get Settings V3
GET
Get Settings V4
GET
Get Settings V5
POST
Get Storage Details
GET
Get Syslog
GET
Get True SSO Connector
GET
Get Unauthenticated Access User
GET
Get Users Or Group Local Summary V2
GET
Get Users Or Group Local Summary V3
GET
Get Users Or Groups Global Summary
GET
Get Virtual Center
GET
Get Virtual Center V4
GET
Get Virtual Center V5
POST
Import Certificate
GET
List App Volumes Managers
GET
List App Volumes Managers V2
GET
List Certificate Infos
GET
List Certificate Infos V2
GET
List Connection Servers
GET
List Connection Servers V2
GET
List Enrollment Servers
GET
List Federation Access Groups
GET
List Federation Access Groups V2
GET
List Gateway Access User Or Group
GET
List Gateways
GET
List GSSAPI Authenticators
GET
List IC Domain Accounts
GET
List IM Assets
GET
List IM Streams
GET
List IM Tags
GET
List IM Versions
GET
List JWT Authenticators
GET
List Licenses
GET
List Licenses V2
GET
List Local Access Groups
GET
List Local Access Groups V2
GET
List Log Collector Tasks
GET
List Message Clients
GET
List Permissions
GET
List Permissions V2
GET
List RADIUS Authenticators
GET
List RCX Servers
GET
List Roles
GET
List SAML Authenticators
GET
List Secondary Credentials
GET
List Selectable Privileges
GET
List True SSO Connectors
GET
List Unauthenticated Access Users
GET
List Users Or Groups Global Summary
GET
List Users Or Groups Local Summary
GET
List Users Or Groups Local Summary V2
GET
List Users Or Groups Local Summary V3
GET
List VC Info
GET
List VC Info V2
GET
List VC Info V3
GET
List VC Info V4
GET
List VC Info V5
POST
Mark Datastores For Archival
POST
Override Certificate
POST
Purge
POST
Push Certificates
POST
Recover Certificates
POST
Register Gateway
POST
Register RCX Client
DELETE
Remove Virtual Center
DELETE
Remove Virtual Center V5
POST
Reset Highest Usage Metrics
POST
Reset Named User Metrics
POST
Set License Key
POST
Set License Mode
POST
Unassign Farms
DELETE
Unregister Gateway
DELETE
Unregister RCX Client
PUT
Update Agent Restriction Settings
PUT
Update App Volumes Manager
PUT
Update App Volumes Manager V2
PUT
Update CEIP Info
PUT
Update Client Settings
PUT
Update Connection Server
PUT
Update Connection Server V2
PUT
Update Event Database
PUT
Update Feature Settings
PUT
Update General Settings
PUT
Update General Settings V2
PUT
Update General Settings V3
PUT
Update General Settings V4
PUT
Update Global Policies
PUT
Update GSSAPI Authenticator
PUT
Update IC Domain Account
PUT
Update IM Asset
PUT
Update IM Stream
PUT
Update IM Tag
PUT
Update IM Version
PUT
Update JWT Authenticator
PUT
Update Message Client
POST
Updatepassword
PUT
Update Preferences
PUT
Update Preferences V2
PUT
Update RADIUS Authenticator
PUT
Update RCX Client
PUT
Update Role
PUT
Update SAML Authenticator
PUT
Update Security Settings
PUT
Update Security Settings V3
PUT
Update Security Settings V4
PUT
Update Settings
PUT
Update Settings V2
PUT
Update Settings V3
PUT
Update Settings V4
PUT
Update Settings V5
PUT
Update Syslog
PUT
Update True SSO Connector
PUT
Update Virtual Center
PUT
Update Virtual Center V4
PUT
Update Virtual Center V5
POST
Validate AVM Certificate
POST
Validate SAML Certificate
POST
Validate Virtual Center Certificate