instances

usage: awx instances [-h] action ...

positional arguments:
  action
    list
    create
    get
    modify

options:
  -h, --help  show this help message and exit

awx instances: the following arguments are required: action

instances list

usage: awx instances list [-h] [--all] [--order_by ORDER_BY] [-f {json,yaml,jq,human}] [--filter TEXT] [--conf.color BOOLEAN] [-v] [--hostname TEXT]
                          [--type {instance}] [--uuid TEXT] [--created CREATED] [--modified MODIFIED] [--last_seen LAST_SEEN]
                          [--health_check_started HEALTH_CHECK_STARTED] [--last_health_check LAST_HEALTH_CHECK] [--errors TEXT]
                          [--capacity_adjustment CAPACITY_ADJUSTMENT] [--version TEXT] [--capacity INTEGER] [--cpu CPU] [--memory INTEGER] [--cpu_capacity INTEGER]
                          [--mem_capacity INTEGER] [--enabled BOOLEAN] [--managed_by_policy BOOLEAN] [--node_type {control,execution,hybrid,hop}]
                          [--node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}] [--managed BOOLEAN]
                          [--ip_address TEXT]

options:
  -h, --help            show this help message and exit
  --all                 fetch all pages of content from the API when returning results (instead of just the first page)
  --order_by ORDER_BY   order results by given field name, prefix the field name with a dash (-) to sort in reverse eg --order_by='-name',multiple sorting fields may
                        be specified by separating the field names with a comma (,)
  --hostname TEXT       only list instances with the specified hostname
  --type {instance}     only list instances with the specified type
  --uuid TEXT           only list instances with the specified uuid
  --created CREATED     only list instances with the specified created
  --modified MODIFIED   only list instances with the specified modified
  --last_seen LAST_SEEN
                        only list instances with the specified last_seen
  --health_check_started HEALTH_CHECK_STARTED
                        only list instances with the specified health_check_started
  --last_health_check LAST_HEALTH_CHECK
                        only list instances with the specified last_health_check
  --errors TEXT         only list instances with the specified errors
  --capacity_adjustment CAPACITY_ADJUSTMENT
                        only list instances with the specified capacity_adjustment
  --version TEXT        only list instances with the specified version
  --capacity INTEGER    only list instances with the specified capacity
  --cpu CPU             only list instances with the specified cpu
  --memory INTEGER      only list instances with the specified memory
  --cpu_capacity INTEGER
                        only list instances with the specified cpu_capacity
  --mem_capacity INTEGER
                        only list instances with the specified mem_capacity
  --enabled BOOLEAN     only list instances with the specified enabled
  --managed_by_policy BOOLEAN
                        only list instances with the specified managed_by_policy
  --node_type {control,execution,hybrid,hop}
                        only list instances with the specified node_type
  --node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}
                        only list instances with the specified node_state
  --managed BOOLEAN     only list instances with the specified managed
  --ip_address TEXT     only list instances with the specified ip_address

input/output formatting:
  -f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}
                        specify a format for the input and output
  --filter TEXT         specify an output filter (only valid with jq or human format)
  --conf.color BOOLEAN  Display colorized output. Defaults to True
  -v, --verbose         print debug-level logs, including requests made

instances create

usage: awx instances create [-h] --hostname TEXT [--capacity_adjustment CAPACITY_ADJUSTMENT] [--enabled BOOLEAN] [--managed_by_policy BOOLEAN]
                            [--node_type {control,execution,hybrid,hop}]
                            [--node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}] [--peers PEERS]
                            [--listener_port INTEGER] [--peers_from_control_nodes BOOLEAN]

required arguments:
  --hostname TEXT

options:
  -h, --help            show this help message and exit
  --capacity_adjustment CAPACITY_ADJUSTMENT
  --enabled BOOLEAN
  --managed_by_policy BOOLEAN
  --node_type {control,execution,hybrid,hop}
                        Role that this node plays in the mesh.
  --node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}
                        Indicates the current life cycle stage of this instance.
  --peers PEERS         Primary keys of receptor addresses to peer to.
  --listener_port INTEGER
  --peers_from_control_nodes BOOLEAN

awx instances create: the following arguments are required: --hostname

instances get

usage: awx instances get [-h] [-f {json,yaml,jq,human}] [--filter TEXT] [--conf.color BOOLEAN] [-v] id

positional arguments:
  id                    the ID (or unique name) of the resource

options:
  -h, --help            show this help message and exit

input/output formatting:
  -f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}
                        specify a format for the input and output
  --filter TEXT         specify an output filter (only valid with jq or human format)
  --conf.color BOOLEAN  Display colorized output. Defaults to True
  -v, --verbose         print debug-level logs, including requests made

awx instances get: the following arguments are required: id

instances modify

usage: awx instances modify [-h] id

positional arguments:
  id          the ID (or unique name) of the resource

options:
  -h, --help  show this help message and exit

awx instances modify: the following arguments are required: id