Managed Object - DrConfigSraSraManager

Property of
DrConfigServiceInstanceContent
See also
DrConfigConfigurationTask, DrConfigSraSraImageInfo
Since
DrConfig API 3.0


Managed Object Description

Interface for managing SRA images and containers in the SRM Configuration Service.

Properties

Name Type Description
currentTask* PManagedObjectReference
to a DrConfigConfigurationTask		Deprecated.

The currently active retrieve update task or null.
*May not be presentP Required privilege: VcDr.Internal.com.vmware.vcDr.InternalAccess

Methods

Methods defined in this Managed Object
CopySraConfiguration, DeleteImage, DeleteImageContainers, DrConfigSraSraManager_GetRunningTask, GetImageInfo, GetSraImages, ResetToFactorySettings

CopySraConfiguration

Copies the SRA configuration from a source image to a destination image.
Required Privileges
VcDr.Internal.com.vmware.vcDr.InternalAccess

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigSraSraManager used to make the method call.
fromImage Pxsd:string

The docker image id of the source image. It can be either in the [REPOSITORY:[TAG]] format or in the canonical sha256 format.

Since DrConfig API 3.0
toImage Pxsd:string

The docker image id of the destination image. It can be either in the [REPOSITORY:[TAG]] format or in the canonical sha256 format.

Since DrConfig API 3.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
vmodl.RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
DrConfigSraFaultCannotCreateSraLogDirectoryWhen the SRA Log directory for the source or destination SRA cannot be created.
DrConfigSraFaultCannotExecuteDockerCommandWhen there are issues with the 'docker' CLI itself. See CannotExecuteDockerCommand.
DrConfigSraFaultDockerCommandFailedWhen there are issues with executing a 'docker' CLI command. See DockerCommandFailed.
DrConfigSraFaultDockerImageDoesNotExistWhen the image with the given id does not exist in the docker daemon.

Events

Type
None



DeleteImage

Stops and then deletes the containers instantiated from the given image. Afterwards, deletes the image itself.
Required Privileges
VcDr.Internal.com.vmware.vcDr.InternalAccess

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigSraSraManager used to make the method call.
imageId Pxsd:string

The image id of the image which has to be deleted. This can be either the sha256 id of the image, or the image repository tag in the [REPOSITORY[:TAG]] format.

Since DrConfig API 3.0
P Required privilege: imageId

Return Value

Type Description
xsd:booleanTrue when the image was deleted, false if the image did not exist in the first place.

Faults

Type Description
vmodl.RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
DrConfigSraFaultCannotExecuteDockerCommandWhen there are issues with the 'docker' CLI itself. See CannotExecuteDockerCommand.
DrConfigSraFaultDockerCommandFailedWhen there are issues with executing a 'docker' CLI command. See DockerCommandFailed.

Events

Type
None



DeleteImageContainers

Stops and then deletes the containers which were instantiated from the given image.
Required Privileges
VcDr.Internal.com.vmware.vcDr.InternalAccess

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigSraSraManager used to make the method call.
imageId Pxsd:string

The id of the image whose containers must be stopped. This can be either the sha256 id of the image, or the image repository tag in the [REPOSITORY[:TAG]] format.

Since DrConfig API 3.0
P Required privilege: imageId

Return Value

Type Description
xsd:booleanTrue when the image's containers were deleted, false if the image did not exist in the first place or it had no containers.

Faults

Type Description
vmodl.RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
DrConfigSraFaultCannotExecuteDockerCommandWhen there are issues with the 'docker' CLI itself. See CannotExecuteDockerCommand.
DrConfigSraFaultDockerCommandFailedWhen there are issues with executing a 'docker' CLI command. See DockerCommandFailed.

Events

Type
None



DrConfigSraSraManager_GetRunningTask

The currently active retrieve update task or null.
Required Privileges
VcDr.Internal.com.vmware.vcDr.InternalAccess
Since
DrConfig API 3.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigSraSraManager used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a DrConfigConfigurationTask

Faults

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

Events

Type
None



GetImageInfo

Returns the image info as taken from the 'queryInfo' SRA command. Since docker images are immutable, the 'queryInfo' SRA command is executed only once, the first time the info is requested. Subsequent calls will return a cached value which lives for the duration of the SRM Configuration Service lifetime.
Required Privileges
VcDr.Internal.com.vmware.vcDr.InternalAccess

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigSraSraManager used to make the method call.
imageId Pxsd:string

The id of the image the info is requested for. This can be either the sha256 id of the image, or the image repository tag in the [REPOSITORY[:TAG]] format.

Since DrConfig API 3.0
P Required privilege: imageId

Return Value

Type Description
DrConfigSraSraImageInfoThe SRA image info.

Faults

Type Description
vmodl.RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
DrConfigSraFaultCannotCreateSraLogDirectoryWhen the SRA Log directory for the SRA image cannot be created.
DrConfigSraFaultCannotExecuteDockerCommandWhen there are issues with the 'docker' CLI itself. See CannotExecuteDockerCommand.
DrConfigSraFaultDockerCommandFailedWhen there are issues with executing a 'docker' CLI command. See DockerCommandFailed.
DrConfigSraFaultDockerImageDoesNotExistWhen the image with the given id does not exist in the docker daemon.

Events

Type
None



GetSraImages

Returns a collection of SRA images loaded into the docker daemon of the SRM VA.
Required Privileges
VcDr.Internal.com.vmware.vcDr.InternalAccess

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigSraSraManager used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a DrConfigConfigurationTask		ConfigurationTask object that can be used to monitor the operation. ConfigurationTask.info a collection of DrConfigSraSraImages describing the SRA images loaded into docker.

Faults

Type Description
vmodl.RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
DrConfigFaultServiceBusyThrown if another configuration task is already running.

Events

Type
None



ResetToFactorySettings

Reverts the SRA image's configuration to its factory settings. Any changes to the configuration made since the image was loaded into docker will be lost.
Required Privileges
VcDr.Internal.com.vmware.vcDr.InternalAccess

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigSraSraManager used to make the method call.
imageId Pxsd:string

The docker image id of the source image. It can be either in the [REPOSITORY:[TAG]] format or in the canonical sha256 format.

Since DrConfig API 3.0
P Required privilege: imageId

Return Value

Type Description
None

Faults

Type Description
vmodl.RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
DrConfigSraFaultCannotExecuteDockerCommandWhen there are issues with the 'docker' CLI itself. See CannotExecuteDockerCommand.
DrConfigSraFaultDockerCommandFailedWhen there are issues with executing a 'docker' CLI command. See DockerCommandFailed.
DrConfigSraFaultDockerImageDoesNotExistWhen the image with the given id does not exist in the docker daemon.

Events

Type
None