Rancher CLI Examples

Table of Contents

• List All Available Commands
• Fetch All Hosts By Environment
• Fetch All Stacks By Environment
• Fetch Stack Details By Name
• Fetch Services By Environment
• Fetch Service Details By Name
• Fetch Service ID By Name
• Fetch Service Name By ID

List All Available Commands

.\rancher.exe
# Rancher CLI, managing containers one UTF-8 character at a time
 
# Usage: rancher [OPTIONS] COMMAND [arg...]
 
# Version: v0.6.3
 
# Options:
#    --debug                           Debug logging
#    --config value, -c value          Client configuration file (default ${HOME}/.rancher/cli.json [%RANCHER_CLIENT_CONFIG%]
#    --environment value, --env value  Environment name or ID [%RANCHER_ENVIRONMENT%]
#    --url value                       Specify the Rancher API endpoint URL [%RANCHER_URL%]
#    --access-key value                Specify Rancher API access key [%RANCHER_ACCESS_KEY%]
#    --secret-key value                Specify Rancher API secret key [%RANCHER_SECRET_KEY%]
#    --host value                      Host used for docker command [%RANCHER_DOCKER_HOST%]
#    --wait, -w                        Wait for resource to reach resting state
#    --wait-timeout value              Timeout in seconds to wait (default: 600)
#    --wait-state value                State to wait for (active, healthy, etc)
#    --help, -h                        show help
#    --version, -v                     print the version
 
# Commands:
#    catalog           Operations with catalogs
#    config            Setup client configuration
#    docker            Run docker CLI on a host
#    environment, env  Interact with environments
#    events, event     Displays resource change events
#    exec              Run a command on a container
#    export            Export configuration yml for a stack as a tar archive or to local files
#    hosts, host       Operations on hosts
#    logs              Fetch the logs of a container
#    ps                Show services/containers
#    restart           Restart service, container
#    rm                Delete service, container, stack, host, volume, secret
#    run               Run services
#    scale             Set number of containers to run for a service
#    secrets, secret   Operations on secrets
#    ssh               SSH into host
#    stacks, stack     Operations on stacks
#    start, activate   Start or activate service, container, host, stack
#    stop, deactivate  Stop or deactivate service, container, host, stack
#    up                Bring all services up
#    volumes, volume   Operations on volumes
#    inspect           View details for service, container, host, environment, stack, volume, secret
#    wait              Wait for resources service, container, host, stack, machine, projectTemplate
#    help              Shows a list of commands or help for one command
    
# Run 'rancher COMMAND --help' for more information on a command.

Fetch All Hosts By Environment

.\rancher.exe --url http://192.168.99.103:8080 --access-key 74FF92AEC4691F7D8AF4 --secret-key Kyw1kfNSJZXrSk8nK1f93P8bhxNMaPDEGEpsRPcT hosts
# ID        HOSTNAME   STATE     CONTAINERS   IP               LABELS       DETAIL
# 1h3       ra2        active    11           192.168.99.103   color=red
# 1h4       ra1        active    11           192.168.99.102   color=blue

Fetch All Stacks By Environment

.\rancher.exe --url http://192.168.99.103:8080 --access-key 74FF92AEC4691F7D8AF4 --secret-key Kyw1kfNSJZXrSk8nK1f93P8bhxNMaPDEGEpsRPcT stacks
# ID        NAME         STATE     CATALOG                            SERVICES   SYSTEM    DETAIL
# 1st9      dokuwiki1    healthy   catalog://community:dokuwiki:0     1          false
# 1st10     dokuwiki2    healthy   catalog://community:dokuwiki:0     1          false
# 1st11     weavescope   healthy   catalog://community:weavescope:0   2          false  

Fetch Stack Details By Name

.\rancher.exe --url http://192.168.99.103:8080 --access-key 74FF92AEC4691F7D8AF4 --secret-key Kyw1kfNSJZXrSk8nK1f93P8bhxNMaPDEGEpsRPcT inspect dokuwiki1

Fetch Services By Environment

# Rancher environment is passed via --env <ENVIRONMENT_ID>
.\rancher.exe --url http://192.168.99.103:8080 --access-key 74FF92AEC4691F7D8AF4 --secret-key Kyw1kfNSJZXrSk8nK1f93P8bhxNMaPDEGEpsRPcT --env 1a7 ps
 
# Command output
# ID        TYPE                  NAME                                      IMAGE                               STATE     SCALE     SYSTEM    ENDPOINTS   DETAIL
# 1s13      service               dokuwiki1/dokuwiki-server                 ununseptium/dokuwiki-docker         healthy   2/1       false
# 1s13      sidekick              dokuwiki1/dokuwiki-server/dokuwiki-data   ununseptium/dokuwiki-docker         healthy   2/1       false
# 1s14      service               dokuwiki2/dokuwiki-server                 ununseptium/dokuwiki-docker         healthy   2/1       false
# 1s14      sidekick              dokuwiki2/dokuwiki-server/dokuwiki-data   ununseptium/dokuwiki-docker         healthy   2/1       false
# 1s15      loadBalancerService   load-balancer/load-balancer               rancher/lb-service-haproxy:v0.7.6   healthy   1/1       false

Fetch Service Details By Name

.\rancher.exe --url http://192.168.99.103:8080 --access-key 74FF92AEC4691F7D8AF4 --secret-key Kyw1kfNSJZXrSk8nK1f93P8bhxNMaPDEGEpsRPcT inspect dokuwiki1/dokuwiki-server

Fetch Service ID By Name

.\rancher.exe --url http://192.168.99.101:8080 --access-key F830A6D384AF8C497D19 --secret-key NERNbgVkmVhpHEfNyMRtDd9avbQzJePkJx1dLxg7 inspect --format '{{.id}}' dokuwiki1/dokuwiki-server
# 1s13

Fetch Service Name By ID

.\rancher.exe --url http://192.168.99.101:8080 --access-key F830A6D384AF8C497D19 --secret-key NERNbgVkmVhpHEfNyMRtDd9avbQzJePkJx1dLxg7 inspect --format '{{.name}}' 1s13
# dokuwiki-server