configure ... set value syntax¶

Most configuration subtrees in ibcli expose a generic pass-through verb of the form:

configure <subtree> set <key>=<value> [<key>=<value> ...]

The handler parses the key/value pairs, coerces each value to a typed Python / JSON value, and PUTs them against the matching WAPI object. Multiple pairs in one line go out as a single PUT.

This page documents the value-coercion rules and the tab-completion helpers that are shared across every ... set site. They are implemented in src/ibcli/coerce.py and src/ibcli/completions_keys.py.

Value coercion¶

Rules are applied in order. The first match wins.

ACL shortcut¶

WAPI ACL-style fields (allow_query, allow_transfer, allow_update, …) expect a list of structured entries like:

[
  {"address": "10.0.0.0/8", "permission": "ALLOW", "_struct": "addressac"},
  {"_ref": "namedacl/..:trusted"}
]

Instead of typing that, you can use a comma-separated shortcut:

<PERM>:<cidr>[,<PERM>:<cidr>...]
acl:<ref>

Examples:

allow_query=ALLOW:10.0.0.0/8
allow_query=DENY:192.168.0.0/16
allow_query=ALLOW:10.0.0.0/8,DENY:192.168.0.0/16
allow_query=10.0.0.0/8                              # permission defaults to ALLOW
allow_query=ALLOW:10.0.0.0/8,acl:namedacl/..:trusted
allow_query=[]                                      # clear the list

Permissions are case-insensitive. Both IPv4 and IPv6 CIDRs are accepted. If a value doesn't match the shortcut pattern it falls through to the string rule (so plain string fields still work).

JSON fallback¶

When a field needs a shape the shortcut can't express - e.g. TSIG keys, forwarders with names and addresses, DHCP option lists - pass JSON:

# struct
configure grid Infoblox dhcp set gss_tsig_keys={"name":"k1","algorithm":"HMAC-SHA1","secret":"..."}

# struct list
configure grid Infoblox dns set forwarders=[{"name":"ns1","address":"10.0.0.1"},{"name":"ns2","address":"10.0.0.2"}]

poetry run ibcli -s <grid> -u <user> -p <pw> -k \
    -e 'configure grid Infoblox dns set allow_query=ALLOW:10.0.0.0/8'

Discovering valid keys¶

Every … set verb has two aids:

1. Tab completion. Hit Tab after the set and you'll get every writable field as a name= completion, with its type as metadata (true/false, number, text list, enum choices, etc.). Type a prefix like enable_ and the list filters to match.

2. … keys helper (grid only). For the grid-level service verbs, ibcli also exposes:

show grid <name> dns keys
show grid <name> dhcp keys
show grid <name> threat_insight keys
show grid <name> threat_protection keys
show grid <name> file_distribution keys

which prints a full alphabetical table of writable fields with types.

Both are driven by the SDK's pydantic models, so the list tracks the WAPI version the SDK is pinned against.

Type labels¶

The metadata shown in the dropdown (and the … keys table) uses these ops-friendly labels rather than raw Python type hints:

Where this applies¶

Every verb in the table below accepts the syntax above. Tab completion is wired on all of them.