For the complete documentation index, see llms.txt. This page is also available as Markdown.

Prisma Cloud rules guide for Docker

This article provides a list of all rules and their intended behavior in Prisma Cloud Console UI. The purpose of this article is to help users better understand the intention of each rule in the Console and it’s corresponding effect on the host environment.

Running Docker commands through Defender

To access Docker daemon through Defender, you must explicitly specify Defender’s host and port. For example:

$ docker -H <DEFENDER_HOST_ADDRESS>:9998 run alpine

It is possible to make the management traffic between the Docker client and the Docker daemon flow through Defender by default via two environment variables. Those can be configured on a remote machine that accesses Docker daemon on some host (such as dev laptop), or the host itself for users who do not have root privileges (which should be the majority of users).

$ export DOCKER_HOST=tcp://<defender host address>:9998

$ export DOCKER_TLS_VERIFY=1

Once set, default calls to Docker flow through Defender (e.g., docker ps, docker run alpine). Throughout this guide however, in this guide, we have followed the default command without setting environment variables.

Containers

For more information about the Docker API for containers, see https://docs.docker.com/engine/api/v1.30/#tag/Container.

container_list - List containers

Affects docker ps command on host which is used to list all running containers.

Command:

docker -H 10.0.0.1:9998 --tlsverify ps

Response:

container_create - Create a container

Affects docker create command used to create a new container.

Command:

Response:

container_inspect - Inspect a container

Affects docker inspect command used for returning information about the container.

Command:

Response:

container_top - List processes running inside a container

Affects docker top command used to display the running processes of a container

Command:

Response:

container_logs - Get container logs

Affects docker logs command used for returning logs from the container present at the time of execution.

Command:

Response:

container_changes - Inspect changes on a container’s filesystem

Affect docker commit command and restricts any changes to the container.

Command:

Response:

container_export - Export a container

Affects docker export command that exports a container’s filesystem as a tar archive

Command:

Response:

container_stats - Get container stats based on resource usage

Affects docker stats command on host which returns live data stream for running containers.

Command:

Response:

container_resize - Resize a container

Affects docker logs command used for returning logs from the container present at the time of execution. This related to the size of the window of how output is returned from the container. It is called TTY.

Command:

Response:

container_start - Start a container

Affects docker start command used to start one or more stopped containers

Command:

Response:

container_stop - Stop a container

Affects docker stop command used to stop running container

Command:

Response:

container_restart - Restart a container

Affects docker restart command on host, used to restart a container.

Command:

Response:

container_kill - Kill a container

Affects docker kill command used to kill a running container.

Command:

Response:

container_rename - Rename a container

Affects docker rename command on host that is used to rename a container.

Command:

Response:

container_pause - Pause a container

Affects docker pause command on host which is used to pause all processes within one or more containers.

Command:

Response:

container_unpause - Unpause a container

Affects docker unpause command on host which is used to un-suspend all processes in a container.

Command:

Response:

container_attach - Attach to a container

Affects docker attach command on host where defender is deployed.

Command:

Response:

container_attachws - Attach to a container (websocket)

Affects docker attach command on host where defender is deployed. Attach to the container id via websocket. Implements websocket protocol handshake according to RFC 6455

Command:

Response:

container_wait - Wait a container

Affects docker wait command used to block until a container stops, then print its exit code.

Command:

Response:

container_delete - Remove a container

Affects docker rm command used for deleting a container.

Command:

Response:

container_archive - Gets an archive of filesystem resource in a container

Get a tar archive of a resource in the filesystem of container id. Affects docker cp command

Command:

Response:

container_extract - Extract an archive of files or folders to a directory in a container

Affects docker export command. Uploads a tar archive to be extracted to a path in the filesystem of container id

Command:

Response:

Images

For more information about the Docker API for images, see https://docs.docker.com/engine/api/v1.30/#tag/Image.

image_list - List images

Affects docker images command used to list all images

Command:

Response:

image_build - Build image from a Dockerfile

Affects docker build command that is used to build an image from a Dockerfile.

Command:

Response:

image_create - Create an image

Affects docker pull command which is used to pull an image

Command:

Response:

image_inspect - Inspect an image

Description

Affects docker inspect command used for returning information about the container.

Command:

Response:

image_history - Get the history of an image

Affects docker history <image> command.

Command:

Response:

image_push - Push an image on the registry

Affects command docker push for pushing an image to repository

Command:

Response:

image_tag - Tag an image into a repository

Affects docker tag command used to tag an image in the repository

Command:

Response:

image_delete - Remove an image

Affects docker rmi command used to delete an image

Command:

Response:

images_search - Search images

Affects docker search command which gives a list of available images matching the search item.

Command:

Response:

MISC

Misc other docker commands.

docker_check_auth - Check auth configuration

Validates credentials for a registry and get identity token, if available, for accessing the registry without password. Affects docker login on the host.

Command:

Response:

docker_info - Display system-wide information

Affects docker info command used to display system-wide information

Command:

Response:

docker_version - Show the docker version information

Affects docker version command on host which is used to find docker version.

Command:

Response:

docker_ping - Ping the docker server

The goal of this api is to ping the Docker server and make sure it is up and running.

Command:

It is intended to be called by an external monitoring system. It does not have a direct docker CLI command.

container_commit - Create a new image from a container’s changes

Affects docker commit command used for committing container’s file changes etc into a new image.

Command:

Response:

docker_events - Monitor docker’s events

Affects docker events command on host which is used to return real time events from the server.

Command:

Response:

images_archive - Get a tarball containing all images

Affects docker save command to save images to a tar archive

Command:

Response:

images_load - Load a tarball with a set of images and tags into docker

Affects docker load command to load an image from a tar archive or STDIN

Command:

Response: [Prisma Cloud] The command images_load denied for user admin by rule Default - deny all

container_exec_create - Exec Create

Affects docker_exec command to create any new container.

Command:

Response:

container_exec_start - Exec Start

Affects docker exec command used for running a command in a running container.

Command:

Response:

container_exec_inspect - Exec Inspect

Affects docker exec command used for running a command in a running container.

Command:

Response:

container_archive_head

Command:

Response:

container_copyfiles

Affects docker cp command used to copy files from and to containers and local file system on host.

Command:

Response:

Volumes

For more information about the Docker API for volumes, see https://docs.docker.com/engine/api/v1.30/#tag/Volume.

volume_list - List volumes

Affects docker volume ls command to list all volumes

Command:

Response:

volume_create - Create a volume

Affects docker volume create command to create a volume

Command:

Response:

volume_inspect - Inspect a volume

Affects docker volume inspect command to display detailed information on one or more volumes

Command:

Response:

volume_remove - Remove a volume

Affects docker volume rm command to remove one or more volumes

Command:

Response:

Networks

For information about the Docker API for networks, see https://docs.docker.com/engine/api/v1.30/#tag/Network.

network_list - list networks

Affects docker network ls to list networks

Command:

Response:

network_inspect - Inspect network

Affects docker network inspect to display detailed information on one or more networks

Command:

Response:

network_create - Create a network

Affects docker network create to create a network

Command:

Response:

network_connect - Connect a container to a network

Affects docker network connect to connect a container to a network

Command:

Response:

network_disconnect - Disconnect a container from a network

Affects docker network disconnect to disconnect a container from a network

Command:

Response:

network_remove - Remove a network

Affects docker network rm to remove one or more networks

Command:

Response:

Secrets

Secrets are added in Prisma Cloud 2.0 in accordance with Docker Engine API v1.26.

For more information about the Docker API for secrets, see https://docs.docker.com/engine/api/v1.30/#tag/Secret.

secret_list - List secrets

Affects docker secret ls command used to list secrets.

Command:

Response:

secret_create - Create secrets

Affects docker secret create command used to create secrets.

Command:

Response:

secret_inspect - Inspect secrets

Affects docker secret inspect command used to inspect secrets.

Command:

Response:

secret_remove - Delete secrets

Affects docker secret rm command used to remove one or more secrets.

Command:

Response:

secret_update - Update a secret

Affects POST /secrets/{id}/update command used to remove one or more secrets.

Command:

Response:

Last updated

Was this helpful?