com.vmware.vcloud.sdk.admin
Class EdgeGateway

java.lang.Object
  com.vmware.vcloud.sdk.VcloudResource<T>
      com.vmware.vcloud.sdk.VcloudEntity<com.vmware.vcloud.api.rest.schema.GatewayType>
          com.vmware.vcloud.sdk.admin.EdgeGateway

public class EdgeGateway
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.GatewayType>

Helper class for the EdgeGateway resource in vCloud Admin API.

Since:

API 5.1, SDK 5.1

Author:

Administrator

Method Summary

Task	configureServices(com.vmware.vcloud.api.rest.schema.GatewayFeaturesType gatewayFeaturesType) Update edgeGateway configuration.
Task	configureSyslogServerSettings(com.vmware.vcloud.api.rest.schema.SyslogServerType syslogServerSettings) Configure Syslog server settings for the org vdc edge gateway.
Task	delete() Delete the edgeGateway.
static Task	delete(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType edgeGatewayRef) Delete the edgeGateway.
com.vmware.vcloud.api.rest.schema.ReferenceType	getAdminVdcReference() Returns the Parent Admin Vdc ReferenceType.
static EdgeGateway	getEdgeGatewayById(VcloudClient client, String vCloudId) Get EdgeGateway helper using the vCloud ID
static EdgeGateway	getEdgeGatewayByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType edgeGatewayTypeRef) Returns the EdgeGateway by reference
Task	reapplyServices() Reapply services on an edgeGateway.
Task	redeploy() Redeploy edgeGateway.
Task	syncSyslogServer() Synchronize syslog server settings on an edgeGateway.
Task	updateEdgeGateway(com.vmware.vcloud.api.rest.schema.GatewayType gatewayParams) Update a edgeGateway.
Task	upgradeConfig() Upgrade edgeGateway configuration from compact to full.

Methods inherited from class com.vmware.vcloud.sdk.VcloudEntity

getMetadata, getReference, getTasks

Methods inherited from class com.vmware.vcloud.sdk.VcloudResource

getResource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAdminVdcReference

public com.vmware.vcloud.api.rest.schema.ReferenceType getAdminVdcReference()
                                                                     throws VCloudException

Returns the Parent Admin Vdc ReferenceType.

Returns:

ReferenceType

Throws:

VCloudException

getEdgeGatewayByReference

public static EdgeGateway getEdgeGatewayByReference(VcloudClient client,
                                                    com.vmware.vcloud.api.rest.schema.ReferenceType edgeGatewayTypeRef)
                                             throws VCloudException

Returns the EdgeGateway by reference

Parameters:

client - VcloudClient

edgeGatewayTypeRef - ReferenceType

Returns:

EdgeGateway

Throws:

VCloudException

getEdgeGatewayById

public static EdgeGateway getEdgeGatewayById(VcloudClient client,
                                             String vCloudId)
                                      throws VCloudException

Get EdgeGateway helper using the vCloud ID

Parameters:

client - VcloudClient

vCloudId - format - The vCloud ID is of the form: "urn:vcloud:type:uuid". For example: "urn:vcloud:media:d9d976ba-e0ec-4682-a67d-380af49b54e1". String

Returns:

EdgeGateway

Throws:

VCloudException

updateEdgeGateway

public Task updateEdgeGateway(com.vmware.vcloud.api.rest.schema.GatewayType gatewayParams)
                       throws VCloudException

Update a edgeGateway.

Parameters:

gatewayParams - GatewayType

Returns:

Task

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

reapplyServices

public Task reapplyServices()
                     throws VCloudException

Reapply services on an edgeGateway.

Returns:

Task

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

redeploy

public Task redeploy()
              throws VCloudException

Redeploy edgeGateway.

Returns:

Task

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

syncSyslogServer

public Task syncSyslogServer()
                      throws VCloudException

Synchronize syslog server settings on an edgeGateway.

Returns:

Task

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

upgradeConfig

public Task upgradeConfig()
                   throws VCloudException

Upgrade edgeGateway configuration from compact to full.

Returns:

Task

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

delete

public static Task delete(VcloudClient client,
                          com.vmware.vcloud.api.rest.schema.ReferenceType edgeGatewayRef)
                   throws VCloudException

Delete the edgeGateway.

Parameters:

client -

edgeGatewayRef -

Returns:

Task

Throws:

VCloudException

delete

public Task delete()
            throws VCloudException

Delete the edgeGateway.

Returns:

Task

Throws:

VCloudException

configureServices

public Task configureServices(com.vmware.vcloud.api.rest.schema.GatewayFeaturesType gatewayFeaturesType)
                       throws VCloudException

Update edgeGateway configuration.

Parameters:

gatewayFeaturesType - GatewayFeaturesType

Returns:

TaskType

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

configureSyslogServerSettings

public Task configureSyslogServerSettings(com.vmware.vcloud.api.rest.schema.SyslogServerType syslogServerSettings)
                                   throws VCloudException

Configure Syslog server settings for the org vdc edge gateway.

Parameters:

syslogServerSettings - SyslogServerType

Returns:

Task

Throws:

VCloudException

Since:

API 5.11, SDK 8.0