[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Register Default Modules To Edge

Description

Register default edge modules in edge controller for a provider type.

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/admin/v2/edge-deployments/{id}/edge-modules
Copy

Path Parameters

Path Parameters

string
id Required

Edge deployment ID


Query Parameters

Query Parameters

string
action Required

Action to perform. One of: ‘refresh’


string
org_id Required

Organization ID: non-super users can only access their own organization


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns EdgeDeploymentTOV2 of type */*

Successfully registered edge modules to edge controller

{
    "adTwinSyncStatus": "SYNCED",
    "description": "My new edge deployment",
    "fqdn": "edge.example.com",
    "id": "id",
    "location": "US",
    "name": "edge-deployment-1",
    "orgId": "orgId",
    "providerInstanceId": "providerInstanceId",
    "providerLabel": "AZURE|VSPHERE",
    "status": "PENDING"
}
adMonitoring Optional

string
adTwinSyncStatus Optional

Edge deployment synchronization status with AD twin

Possible values are: NONESYNCEDSYNC_NEEDED


agentMonitoringConfig Optional

authEngine Optional

string as date-time
createdAt Optional

Record creation timestamp


deploymentModeDetails Optional

string
description Optional

The description of the Edge Deployment


edgeGatewayLocation Optional

edgeVmDetails Optional

array of ErrorDetail
errorDetails Optional

Error details in case of Edge VM operation failure


string
fqdn Optional

FQDN with which to resolve the Edge VM management IP


HDC
hdc Optional

string
id Optional

The id of the Edge Deployment


infrastructure Optional

Infrastructure Resources needed by the Edge Deployment such as managementNetwork


string
location Optional

location


string
name Optional

The name of the Edge Deployment


string
orgId Optional

The id of the CSP org


privateEndpointDetails Optional

string
providerInstanceId Optional

The ProviderInstance where the Edge Deployment is deployed


string
providerLabel Optional

The type of the provider edge deployment belongs to


proxyConfiguration Optional

map of string
registeredModules Optional

List of modules registered with the edge deployment


reportedStatus Optional

map of string
resourceTags Optional

Resource tags that are added to edge deployment


ssoConfigurations Optional

Edge SSO configuration


string
status Optional

The current status of the Edge Gateway deployment

Possible values are: CONNECT_PENDINGCREATE_ACCEPTEDCREATE_FAILEDCREATE_PENDINGCREATINGDELETEDDELETE_FAILEDDELETE_PENDINGDELETINGFORCE_DELETE_PENDINGFORCE_DELETINGMIGRATE_FAILEDMIGRATE_PENDINGMIGRATINGPOST_PROVISIONING_CONFIG_IN_PROGRESSREADYUPDATE_FAILEDUPDATE_PENDINGUPDATINGUPGRADE_FAILEDUPGRADE_PENDINGUPGRADING


map of string
twinSyncStatusMap Optional

Edge deployment synchronization status of edge twins

Possible values are: NONESYNCEDSYNC_NEEDED


string as date-time
updatedAt Optional

Record update timestamp


integer as int64
version Optional

Record version (internal)


201 Created

Created

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


409

Conflict


500

Unexpected internal server error

Code Samples

Code Samples

cURL Command

curl -X POST https://cloud.vmwarehorizon.com/admin/v2/edge-deployments/{id}/edge-modules?action=string&org_id=string


Feedback

Was this page helpful?