Docker module
POST api/v2/jobs/rvc
Starts a SC//Reliantâ„¢ Virtual Controller (RVC) job for the Docker module. This provides a way to retrieve details about the Docker containers and container images on the nodes in your environment. The API response will indicate that the RVC job is created and is scheduled to run. You can use the job ID from the response to retrieve the job status and the payload details.
In order to perform these actions, the following conditions must be met:
- Must have the
Remote Job Executionfeature turned on for your SC//Reliant Platform Manager tenant. - The user making the API request must have the following SC//Reliant Platform Manager capabilities:
Create and Update a RVC jobCall Docker read-only methodsCall Docker state altering methods
Methods
The following are the available RVC methods in the Docker module that can be started using the API.
- List the Docker images on a target
- List the running Docker containers on a target
- Retrieve Docker stats for the running containers on a target
- Generate a report containing Docker data for a target
- Start a Docker container on a target
- Stop a Docker container on a target
- Retrieve Docker system information for a target
- Pull Docker images on a target