/ 
Zonemaster-Backend-11.2.0
River stage zero No dependents
/ zmb

NAME

zmb - Shell bindings for the Zonemaster::Backend RPC API

Zmb is meant to be pronounced Zimba.

SYNOPSIS

zmb [GLOBAL OPTIONS] COMMAND [OPTIONS]

This interface is unstable and will change in a future release.

GLOBAL OPTIONS

--help         Show usage
--verbose      Show RPC query
--server URL   The server to connect to. Default is http://localhost:5000/.

COMMANDS

man

Show the full manual page.

zmb [GLOBAL OPTIONS] man

non_existing_method

Call a non-existing RPC method.

zmb [GLOBAL OPTIONS] non_existing_method

version_info

zmb [GLOBAL OPTIONS] version_info

profile_names

zmb [GLOBAL OPTIONS] profile_names

get_language_tags

zmb [GLOBAL OPTIONS] get_language_tags

start_domain_test

zmb [GLOBAL OPTIONS] start_domain_test [OPTIONS]

Options:

   --domain DOMAIN_NAME
   --ipv4 true|false|null
   --ipv6 true|false|null
   --nameserver DOMAIN_NAME:IP_ADDRESS
   --nameserver DOMAIN_NAME  # Trailing colon is optional when not specifing IP_ADDRESS
   --ds-info DS_INFO
   --client-id CLIENT_ID
   --client-version CLIENT_VERSION
   --profile PROFILE_NAME
   --queue QUEUE
   --language LANGUAGE

DS_INFO is a comma separated list of key-value pairs. The expected pairs are:

   keytag=NON_NEGATIVE_INTEGER
   algorithm=NON_NEGATIVE_INTEGER
   digtype=NON_NEGATIVE_INTEGER
   digest=HEX_STRING

test_progress

zmb [GLOBAL OPTIONS] test_progress [OPTIONS]

Options:
  --test-id TEST_ID

get_test_params

zmb [GLOBAL OPTIONS] get_test_params [OPTIONS]

Options:
  --test-id TEST_ID

get_test_results

zmb [GLOBAL OPTIONS] get_test_results [OPTIONS]

Options:
  --test-id TEST_ID
  --lang LANGUAGE

get_test_history

zmb [GLOBAL OPTIONS] get_test_history [OPTIONS]

Options:
  --domain DOMAIN_NAME
  --filter all|delegated|undelegated
  --offset COUNT
  --limit COUNT

add_api_user

zmb [GLOBAL OPTIONS] add_api_user [OPTIONS]

Options:
  --username USERNAME
  --api-key API_KEY

add_batch_job

zmb [GLOBAL OPTIONS] add_batch_job [OPTIONS]

Options:
   --username USERNAME
   --api-key API_KEY
   --domain DOMAIN_NAME
   --ipv4 true|false|null
   --ipv6 true|false|null
   --nameserver DOMAIN_NAME:IP_ADDRESS
   --nameserver DOMAIN_NAME  # Trailing colon is optional when not specifing IP_ADDRESS
   --ds-info DS_INFO
   --client-id CLIENT_ID
   --client-version CLIENT_VERSION
   --profile PROFILE_NAME
   --queue QUEUE

"--domain" is repeated for each domain to be tested.
"--nameserver" can be repeated for each name server.
"--ds-info" can be repeated for each DS record.

DS_INFO is a comma separated list of key-value pairs. The expected pairs are:

   keytag=NON_NEGATIVE_INTEGER
   algorithm=NON_NEGATIVE_INTEGER
   digtype=NON_NEGATIVE_INTEGER
   digest=HEX_STRING

get_batch_job_result

zmb [GLOBAL OPTIONS] get_batch_job_result [OPTIONS]

Options:
  --batch-id BATCH-ID