# Managed Object - DrConfigCloudCloudConnectionManager

Property of
  DrConfigServiceInstanceContent
See also
  DrConfigCloudCloudConnectionManagerAgentInfo, DrConfigCloudCloudConnectionManagerCloudUrls, DrConfigCloudCloudConnectionManagerCredentials, DrConfigCloudCloudConnectionManagerHttpProxyInfo, DrConfigCloudCloudConnectionManagerHttpProxySpec, DrConfigConfigurationTask
Since
  DrConfig API 9.0

## Managed Object Description

Managed object that configures the network connection between DPX agent installed on this appliance and the DPX cloud service.

Properties

Name | Type | Description
--- | --- | ---
None

Methods

Methods defined in this Managed Object
BreakPair, GetActiveAgent, GetProxy, GetProxyCredentials, GetRunningBreakTask, GetRunningPairingTask, GetRunningProxyConfigurationTask, GetSddcId, GetUrls, PairWithOrg, ProbeConnection, SetProxy, SetSddcId, UnsetSddcId

# BreakPair

Breaks the active cloud pair. Does nothing if there is no active cloud pair. throws CloudPairingError in case of error.

Required Privileges
  DrConfig.Admin

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a DrConfigConfigurationTask | Task object to track the execution.

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# GetActiveAgent

Check for active DPX agent running within the same VC deployment and if found, return info about it. Note that the agent may not always run on this appliance.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.

Return Value

Type | Description
--- | ---
DrConfigCloudCloudConnectionManagerAgentInfo |

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# GetProxy

HTTP proxy used by the DPX agent on this appliance. Unset when no proxy is used.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.

Return Value

Type | Description
--- | ---
DrConfigCloudCloudConnectionManagerHttpProxyInfo |

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# GetProxyCredentials

Get the credentials used by DPX agent to authenticate with the HTTP proxy. Note that the password will always be empty string and not the actual password used. Unset when no credentials are used.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.

Return Value

Type | Description
--- | ---
DrConfigCloudCloudConnectionManagerCredentials |

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# GetRunningBreakTask

Get the task associated with currently running 'break cloud pair' operation, if any.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a DrConfigConfigurationTask |

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# GetRunningPairingTask

Get the task associated with currently running 'cloud pair' operation, if any.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a DrConfigConfigurationTask |

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# GetRunningProxyConfigurationTask

Get the currently running proxy configuration task, if any.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a DrConfigConfigurationTask |

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# GetSddcId

Get the id of the SDDC where this appliance is deployed.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.

Return Value

Type | Description
--- | ---
xsd:string | The id of the SDDC. Unset id this appliance is deployed on-prem.

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# GetUrls

Get CSP and DPX urls used by this service.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.

Return Value

Type | Description
--- | ---
DrConfigCloudCloudConnectionManagerCloudUrls |

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# PairWithOrg

Associate the DPX agent with a cloud org and an optional SDDC (if this appliance is in VMC). This method will initiate 'cloud pair' operation and wait for the user to complete it. As a result it will return both: - codes and verification url received by SaaS Infra during initiate; - a task to track the rest of the 'cloud pair' operation.

Required Privileges
  DrConfig.Admin

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.

Return Value

Type | Description
--- | ---
ManagedObjectReference to a DrConfigConfigurationTask | ConfigurationTask Task to track the initialization of the pair. This includes break current pair if already paired and initiate new pair. The result of the task will be InitPairingInfo structure.

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# ProbeConnection

Check connectivity to the cloud service.

Required Privileges
  DrConfig.Admin

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.
proxySpec* P | DrConfigCloudCloudConnectionManagerHttpProxySpec | Optional HTTP proxy and proxy authentication to use. Since DrConfig API 9.0

*Need not be set P Required privilege: proxySpec

Return Value

Type | Description
--- | ---
ManagedObjectReference to a DrConfigConfigurationTask | Task object to track the execution. The result of the task will be ProbeConnectionStatus structure.

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# SetProxy

Configure the DPX agent on this appliance to use the specified HTTP proxy and proxy authentication when connecting to the cloud service. As part of the method all checks done by probeConnection() method are done. If the connection is successfull the proxy settings are stored for further use. The agent must be restarted for the new settings to take effect. ServiceManager.Restart(dpxagent)

Required Privileges
  DrConfig.Admin

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.
proxySpec* P | DrConfigCloudCloudConnectionManagerHttpProxySpec | HTTP proxy and proxy authentication to use. If unset, any previos proxy data is removed and HTTP proxy will not be used. Since DrConfig API 9.0

*Need not be set P Required privilege: proxySpec

Return Value

Type | Description
--- | ---
ManagedObjectReference to a DrConfigConfigurationTask | Task object to track the operation. The result of the task is ProbeConnectionStatus.

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# SetSddcId

Set the SDDC id where this appliance is deployed. SDDC id must be set in VMC deployemnts.

Required Privileges
  DrConfig.Admin

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.
id P | xsd:string | Since DrConfig API 9.0

P Required privilege: id

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

# UnsetSddcId

Remove the SDDC id for this appliance.

Required Privileges
  DrConfig.Admin

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the DrConfigCloudCloudConnectionManager used to make the method call.

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
vmodl.RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None