drpcli zones¶
drpcli zones¶
Manage DRP zones for DNS and DHCP network segmentation
Synopsis¶
Zones are network segmentation objects used for DNS and DHCP scoping in DigitalRebar Provision.
Each zone represents a DNS zone (a domain namespace) and can contain DNS resource records. Zones integrate with the DRP DHCP and DNS subsystems to provide automatic DNS registration and resolution for managed machines.
A zone includes:
- Name - the DNS zone name (e.g.
example.com) - Origin - the authoritative domain origin for the zone
- Records - the set of DNS resource records (A, AAAA, CNAME, MX, TXT, etc.)
Additional subcommands allow importing RFC 1035 zone files, viewing the rendered zone table, setting the origin, and managing individual DNS records.
Common operations:
drpcli zones list- list all defined zonesdrpcli zones show <name>- display a specific zone and its recordsdrpcli zones create <json>- create a new zonedrpcli zones update <name> <json>- update an existing zonedrpcli zones destroy <name>- remove a zonedrpcli zones import <file>- import an RFC 1035 zone filedrpcli zones records add <id> <type> <name> <value>- add a DNS recorddrpcli zones records remove <id> <type> <name>- remove a DNS record
Examples¶
# List all zones
drpcli zones list
# Show a specific zone by name
drpcli zones show example.com
# Create a zone from JSON
drpcli zones create '{"Name":"example.com","Origin":"example.com."}'
# Import an RFC 1035 zone file
drpcli zones import example.com.zone
# Set the origin for a zone
drpcli zones origin example.com example.com.
# View the fully rendered zone table
drpcli zones view example.com
# Add an A record to a zone
drpcli zones records add example.com A myhost 192.168.1.10
# Remove a record from a zone
drpcli zones records remove example.com A myhost
# Destroy a zone
drpcli zones destroy example.com
Options¶
Options inherited from parent commands¶
--ca-cert string CA certificate used to verify the server certs (with the system set)
-c, --catalog string The catalog file to use to get product information (default "https://repo.rackn.io")
--catalog-path string The path to where the catalog file exists on the drp server. By default and historically this has been /files/rebar-catalog. For example, if no catalog urls are provided, the complete path will be https://drp-ip:8090/files/rebar-catalog (default "/files/rebar-catalog")
-S, --catalog-source string A location from which catalog items can be downloaded. For example, in airgapped mode it would be the local catalog
--client-cert string Client certificate to use for communicating to the server - replaces RS_KEY, RS_TOKEN, RS_USERNAME, RS_PASSWORD
--client-key string Client key to use for communicating to the server - replaces RS_KEY, RS_TOKEN, RS_USERNAME, RS_PASSWORD
-C, --colors string The colors for JSON and Table/Text colorization. 8 values in the for 0=val,val;1=val,val2... (default "0=32;1=33;2=36;3=90;4=34,1;5=35;6=95;7=32;8=92")
-d, --debug Whether the CLI should run in debug mode
-D, --download-proxy string HTTP Proxy to use for downloading catalog and content
-E, --endpoint string The Digital Rebar Provision API endpoint to talk to (default "https://127.0.0.1:8092")
-X, --exit-early Cause drpcli to exit if a command results in an object that has errors
--fetch-catalogs all Determines which catalog urls to use to fetch the catalog. If set to all, all the catalog urls defined with catalog_url and catalog_urls as well as the default catalog will be used. If set to server, only the catalog urls defined on the server will be used. If set to cli, then the specific url specified with the -c flag will be used. It defaults to `all`. Allowed values `all, `server`, `cli`. (default "all")
-f, --force When needed, attempt to force the operation - used on some update/patch calls
--force-new-session Should the client always create a new session
-F, --format string The serialization we expect for output. Can be "json" or "yaml" or "text" or "table" (default "json")
--http-request-retry-count int Specifies the number of retries for downloads in case of failure
--http-request-retry-delay-max int Specifies the maximum delay (in seconds) between HTTP/HTTPS retry attempts (default 60)
--ignore-unix-proxy Should the client ignore unix proxies
-N, --no-color Whether the CLI should output colorized strings
-H, --no-header Should header be shown in "text" or "table" mode
-x, --no-token Do not use token auth or token cache
-P, --password string password of the Digital Rebar Provision user (default "r0cketsk8ts")
-p, --platform string Platform to filter details by. Defaults to current system. Format: arch/os
-J, --print-fields string The fields of the object to display in "text" or "table" mode. Comma separated
-r, --ref string A reference object for update commands that can be a file name, yaml, or json blob
--server-verify Should the client verify the server cert
-G, --show-global-help-flags Show global flags in help message
-T, --token string token of the Digital Rebar Provision access
-t, --trace string The log level API requests should be logged at on the server side
-Z, --trace-token string A token that individual traced requests should report in the server logs
-j, --truncate-length int Truncate columns at this length (default 40)
-u, --url-proxy string URL Proxy for passing actions through another DRP
-U, --username string Name of the Digital Rebar Provision user to talk to (default "rocketskates")
SEE ALSO¶
- drpcli - A CLI application for interacting with the DigitalRebar Provision API
- drpcli zones action - Show details for a specific action on the zone
- drpcli zones actions - List all available actions for the zone
- drpcli zones await - Wait for a zone's field to become a value within a number of seconds
- drpcli zones count - Count all zones
- drpcli zones create - Create a new zone with the passed-in JSON or string key
- drpcli zones destroy - Destroy zone by id
- drpcli zones etag - Get the etag for a zones by id
- drpcli zones exists - See if a zones exists by id
- drpcli zones fieldinfo - Return the documentation for all the fields or the provided field
- drpcli zones generate - Generate an object of zones type in the content directory
- drpcli zones import - Import a RFC 1035 zone file into DRP
- drpcli zones indexes - Get indexes for zones
- drpcli zones list - List all zones
- drpcli zones meta - Get all metadata key/value pairs for a zone
- drpcli zones origin - Set the domain origin for the zone
- drpcli zones patch - Patch zone by ID using the passed-in JSON Patch
- drpcli zones records - Manage DNS resource records within a zone
- drpcli zones runaction - Run a plugin action on a zone
- drpcli zones show - Show a single zones by id
- drpcli zones update - Unsafely update zone by id with the passed-in JSON
- drpcli zones view - View the fully rendered DNS zone table for a zone
- drpcli zones wait - Wait for a zone's field to become a value within a number of seconds