Broadband Provisioner Reference

Optional ISO-standard strftime arguments

Current date as a string

This function returns the current date. The optional format argument allows you to specify an ISO-C strftime format for the returned value. Information about strftime can be found at various sites on the Internet.

Optional ISO-standard strftime arguments

Current year as a string

This function returns the current year. The optional format argument allows you to specify an ISO-C strftime format for the returned value. Information about strftime can be found at various sites on the Internet.

Optional ISO-standard strftime arguments

Current month as a string

This function returns the current month. The optional format argument allows you to specify an ISO-C strftime format for the returned value. Information about strftime can be found at various sites on the Internet.

Optional ISO-standard strftime arguments

Current month as a string

This function returns the current day of the week. The optional format argument allows you to specify an ISO-C strftime format for the returned value. Information about strftime can be found at various sites on the Internet.

None

Current UTC time as an integer

This function returns the current UTC (GMT) time as an integer.

Current UTC time as an integer

Current UTC time as a string

This function returns the current UTC time as a string. The optional format argument allows you to specify an ISO-C strftime format for the returned value. Information about strftime can be found at various sites on the Internet.

Current UTC time as an integer

Current local time as a string

This function returns the current local time as a string. The optional format argument allows you to specify an ISO-C strftime format for the returned value. Information about strftime can be found at various sites on the Internet.

File name as a string

true if the file exists, false otherwise

This function checks for the existence of a file on the local file system.

File name as a string, key to search on as a string

The value associated with the key

This function retrieves a single value from a file, using the key argument as an index. The format of the file is:

    <default>=some value
    key1=some other value
    key2=yet another value
    ...

Any values

result1 or result2 depending on whether value evaluates to true or false

This function is the equivalent of an if…then…else construct.

Any number of sub-expressions

The first true sub-expression, or the last false if all sub-expressions are false.

This function is somewhat similar to the LISP COND function. The first sub-expression that returns any valid value except false will be the return value of this function. The invalid data type always evaluates to false, so a function that returns invalid does not stop the processing of sub-expressions.

Generally the last subexpression listed should be the default value in case all other subexpressions are false.

Any value

true or false

This function converts any type to a boolean result.

Any value

integer

This function attempts to convert value to an integer. value can be any data type, but the conversion is not guaranteed to succeed because the type or format of value may not facilitate conversion.

Any value

ip address

This function attempts to convert value to an ip address. value can be any data type, but the conversion is not guaranteed to succeed because the type or format of value may not facilitate conversion.

Any value

byte sequence

This function attempts to convert value to a byte sequence. value can be any data type, but the conversion is not guaranteed to succeed because the type or format of value may not facilitate conversion.

Any value

string

This function converts value to a string. It is always possible to convert a non-string type to a string. Use the optional delimiter argument to specify your own delimiter for data types that support them.

Byte sequence

string

This function converts a byte sequence to a human-readable string. This function is not the same as the $STRING function, which simply gives a text representation of the bytes.

source string

string in upper case

This function returns the input string as all upper case. If this function is called with an argument that is not of type string, the argument is returned unmodified.

source string

string in lower case

This function returns the input string as all lower case. If this function is called with an argument that is not of type string, the argument is returned unmodified.

source string, number of elements

string

This function returns the left-most count elements from string. The string argument need not be of type string; it may be any type that can be converted to a string.

source string, number of elements

string

This function returns the right-most count elements from string. The string argument need not be of type string; it may be any type that can be converted to a string.

source string, number of elements, starting position

string

This function returns count elements from string, starting at position pos. The pos argument specifies the zero-based index of the starting character.

any value

integer

This function computes the length of the input value, in bytes

string, search string

integer

This function searches string for the first occurence of substring and returns the zero-based index of the position at which substring appears in string. Returns -1 if substring doesn’t appear in string.

byte sequence

string

This function encodes the byte sequence argument as a base-64 string.

string

byte sequence

This function decodes the string from base-64 to a byte sequence.

string, string

string or invalid

This function returns needle if haystack begins with needle, otherwise it returns invalid. This function is useful in conjunction with the LISP-style COND function for creating flow control.

byte sequence

byte sequence

This function encodes the byte sequence with the server’s shared system key. The encoded value is an even multiple of 8 bytes with an 8-bit length prefix.

byte sequence

byte sequence

This function decodes the byte sequence with the server’s shared system key. The length of the input argument must be an even multiple of 8 bytes with an 8-bit length prefix.

string

byte sequence

This function encodes the string argument with the server’s shared system key. The encoded value is an even multiple of 8 bytes with an 8-bit length prefix.

byte sequence

string

This function decodes the byte sequence with the server’s shared system key. The length of the input argument must be an even multiple of 8 bytes with an 8-bit length prefix.

byte sequence

byte sequence

This function computes an MD5 hash of the input argument.

integer

nothing

This function causes the server to pause for usec microseconds.

any valid expression syntax

result of expression execution

This function parses and executes the input string as an expression.

any value

nothing

This function prints an audit message in the system log containing value.

A haystack and a needle

haystack if needle is found, otherwise unknown

This function performs wildcard matching on haystack using needle. The result can always be evaluated as a boolean, but in some cases it may be preferable to use the native result type such as with the COND function.

None

The unknown data type

This function returns data type unknown. This can be useful to explicitly induce an expression to fail.

None

byte sequence

This function returns the remote identifier of the device as specified by the relay agent through which the device is communicating. This is the Option 82 Remote ID.

None

byte sequence

This function returns the identifier of the relay agent’s circuit through which the device is communicating. This is the Option 82 Circuit ID.

None

byte sequence

This function returns the Option 82 DOCSIS device class.

None

ip address

This function returns the IP address of the relay agent through which the device is communicating.

None

true or false

This function returns true if the device is a Cablelabs cable modem, false otherwise.

None

byte sequence

This function returns the link-layer address (MAC address) of the device the server is communicating with.

None

integer

This function returns the length of the link-layer address (MAC address) in octets.

None

integer

This function returns the IANA hardware type (e.g. Ethernet) of the device the server is communicating with.

None

byte sequence

This function returns the device’s self-proclaimed identifier. See $DEVICE.ID() for a more thorough identifier.

None

byte sequence

This function returns the value of the client identifier option if it exists, otherwise a byte sequence comprised of the hardware type and hardware address.

None - returns a description of the device currently being processed String - returns a description of the device identified by the specified vendor class

A text description of the device

This function returns the description associated with the vendor class for this device. Vendor classes are complete descriptions for different types of devices as well as the information required to match an input packet to a vendor class item. In all cases if no match is available, this function returns type unknown.

None

string

This function returns an identifier denoting the class of device the server is communicating with.

None

string

This function returns an identifier denoting the type of user or application the server is communicating with.

None

boolean

This function returns true if the device is using the BOOTP protocol, false otherwise.

A tag path having the form "1" or "43/2"

any data type

This is a general-purpose function that allows you to inspect the value of any DHCP option or field found in the packet received by the server.

A tag path having the form "1" or "43/2"

any data type

This is a general-purpose function that allows you to inspect the value of any DHCP option or field found in the packet to be transmitted to the client.

None

An ip address

This method returns the ip address to be assigned to the device. Only valid for ack packets.

None

boolean

This method returns true if processing a DHCP discover packet, false otherwise.

None

boolean

This method returns true if processing a DHCP request packet, false otherwise.

None

boolean

This method returns true if processing a DHCP release packet, false otherwise.

None

boolean

This method returns true if processing a DHCP inform packet, false otherwise.

None

boolean

This method returns true if processing a DHCP decline packet, false otherwise.

None

boolean

This method returns true if processing a DHCP leasequery packet, false otherwise.

None - returns the IANA vendor identifier of the device currently being processed String - returns the IANA vendor identifier that most closely matches the vendor class string

An integer representing the IANA identifier for the vendor, or unknown if no vendor id can be determined.

When called with no arguments, returns the IANA vendor identifier of the device currently being processed. When called with a vendor class string argument, returns the IANA vendor identifier that most closely matches the vendor class string. In all cases if no match is available, this function returns type unknown.

None - returns a device type identifier that uniquely identifies the kind of device currently being processed String - returns a device type identifier that uniquely identifies the type of device identified by the vendor class string

A string representing a device type id path, or unknown if no type id can be determined.

A device type id is numeric path, such as 4491/1, that uniquely identifies a specific type of device. If the device communicating with the server supplies a vendor class identifier and the server is configured to recognize this type of device, this function returns a type id that can be used to dictate specific processing for this kind of device.

None

string

If the device has requested a specific boot file, this function returns it. If no boot file was requested, the return value is an empty string.

None

string

This function returns the client-supplied hostname if one was provided.

None

integer

Returns the number of relay agent hops the device’s packet made to get to the server.

None

integer

This function returns the current transaction id the device is using to communicate with the server.

None

integer

This function returns the number of seconds the device has been attempting to get an address.

None

ip address

This function returns the dhcpv4 magic cookie the device is using.

None

ip address

This function returns the local ip address on which the dhcpv4 packet was received.

A class, subclass and key. class and subclass can be any value, and key should be unique within class and subclass unless you explicitly want multiple values for a single key.

The value associated with the key

This function allows you to find a value associated with a key in the associations table. Associations are useful for assigning arbitrary values for use by the DHCP server.

A class, subclass, key and return value

return if the association exists, otherwise unknown

This function allows you to check if an association exists. It does not return the value of the association, but rather it returns return if the association exists.

None

The result of a rule that has been executed by the provisioner when identifying the device

This function allows you to access the result of any rule that was executed by the provisioner. It can be useful for creating dependencies when writing provisioning rules. Rules are executed in order starting with rule #0.

Boolean - true or false, denoting whether the provisioner should automatically enable a new account

The same value passed in, boolean_value

When the provisioner is configured to automatically create new device accounts, this function can allows you to instruct the provisioner to enable or disable a new account at the time of initial creation.

None

The account name for the account created or located for this device

The provisioner locates device accounts, or optionally creates new accounts when configured to do so with rules. This function returns the account name which is typically the device ID.

None

byte sequence

This function returns the remote identifier of the device as specified by the relay agent through which the device is communicating. This is the Option 82 Remote ID.

None

byte sequence

This function returns the identifier of the relay agent’s circuit through which the device is communicating. This is the Option 82 Circuit ID.

None

byte sequence

This function returns the Option 82 DOCSIS device class.

None

ip address

This function returns the IP address of the relay agent through which the device is communicating.

None

true or false

This function returns true if the device is a Cablelabs cable modem, false otherwise.

None

byte sequence

This function returns the device’s unique identifier.

None

byte sequence

This function returns the device’s unique identifier.

None - returns a description of the device currently being processed Integer, String - returns a description of the device identified by the specified enterprise number and optional vendor data

A text description of the device

This function returns the description associated with the vendor class for this device. Vendor classes are complete descriptions for different types of devices as well as the information required to match an input packet to a vendor class item. In all cases if no match is available, this function returns type unknown.

None

string

This function returns an identifier denoting the class of device the server is communicating with.

None

string

This function returns an identifier denoting the type of user or application the server is communicating with.

A tag path having the form "1" or "43/2"

any data type

This is a general-purpose function that allows you to inspect the value of any DHCP option or field found in the packet received by the server.

A tag path having the form "1" or "43/2"

any data type

This is a general-purpose function that allows you to inspect the value of any DHCP option or field found in the packet to be transmitted to the client.

None - returns the IANA vendor identifier of the device currently being processed String - returns the IANA vendor identifier that most closely matches the vendor class string

An integer representing the IANA identifier for the vendor, or unknown if no vendor id can be determined.

When called with no arguments, returns the IANA vendor identifier of the device currently being processed. When called with a vendor class string argument, returns the IANA vendor identifier that most closely matches the vendor class string. In all cases if no match is available, this function returns type unknown.

None - returns a device type identifier that uniquely identifies the kind of device currently being processed Integer,String - Returns a device type identifier that uniquely identifies the type of device identified by the vendor enterprise number. Specify an optional vendor data string for a more closely matched device type.

A string representing a device type id path, or unknown if no type id can be determined.

A device type id is numeric path, such as 4491/1, that uniquely identifies a specific type of device. If the device communicating with the server supplies a vendor class identifier and the server is configured to recognize this type of device, this function returns a type id that can be used to dictate specific processing for this kind of device.

None

integer

Returns the number of relay agent hops the device’s packet made to get to the server.

None

integer

This function returns the current transaction id the device is using to communicate with the server.

None

ip address

This function returns the local ip address on which the dhcpv4 packet was received.

A class, subclass and key. class and subclass can be any value, and key should be unique within class and subclass unless you explicitly want multiple values for a single key.

The value associated with the key

This function allows you to find a value associated with a key in the associations table. Associations are useful for assigning arbitrary values for use by the DHCP server.

A class, subclass, key and return value

return if the association exists, otherwise unknown

This function allows you to check if an association exists. It does not return the value of the association, but rather it returns return if the association exists.

None

The result of a rule that has been executed by the provisioner when identifying the device

This function allows you to access the result of any rule that was executed by the provisioner. It can be useful for creating dependencies when writing provisioning rules. Rules are executed in order starting with rule #0.

Boolean - true or false, denoting whether the provisioner should automatically enable a new account

The same value passed in, boolean_value

When the provisioner is configured to automatically create new device accounts, this function can allows you to instruct the provisioner to enable or disable a new account at the time of initial creation.

None

The account name for the account created or located for this device

The provisioner locates device accounts, or optionally creates new accounts when configured to do so with rules. This function returns the account name which is typically the device ID.

This command sets the DHCP server context to DHCPv4 or DHCPv6. Must be executed after first login to set an initial server context.

None

4 or 6. Issued directly with the command.

Nothing

Returns information about the currently selected DHCP context.

None

None

Information about the current context

This command returns all configuration values from the server’s main configuration file.

None

None

Server configuration settings

This command sets one or more configuration values in the server’s main configuration file. Changes take effect immediately.

None

Key/values to change

Nothing

Returns various operating parameters for this interactive session.

None

None

Operating parameters

Sets various operating parameters for this interactive session.

None

Operating parameters as key/value pairs

Nothing

Displays system-wide operational attributes. The only currently defined attribute is mode, which is used to indicate the current operating mode of the system.

None

None

Operational mode

Sets system-wide operational attributes. The only currently defined attribute is mode, which is used to place the system in servicing, standby, learning or paused mode.

None

mode=m, where m is one of: servicing, paused, standby, learning

Nothing

Get an instantaneous reading of all system counters.

None

filter=x - this optional argument limits the output to those counters that contain the filter string.

The current values for system counters. Each value is broken down by DHCP subsystem (4 or 6), task or object to which the count belongs, and thread instance the count is for. In addition, totals are provided for all threads in a task, all tasks in a subsystem, and all subsystems.

Display a list of commands the interactive session supports.

None

None

A list of supported commands

Display a list of configuration keys supported by the application.

None

None

A list of supported configuration keys

Display various data about the product, machine and software registration.

None

None

Various data

Display a complete dump of the data held in the server.

None

None

All data stored in the DHCP server

Display a list of functions supported within this context.

None

None

A list of supported functions

Display information about the binding licenses in use.

None

None

Information about the number of binding licenses free and currently in use.

Displays the list of plugins that are loaded and operational.

None

None

The list of operational plugins

Displays a list of acceptable queries the DHCP engine will accept and their pre-determined responses.

None

None

A set of queries and responses

Displays the number of bindings in the server.

None

None

The number of bindings

Re-reads the configuration settings from the application’s configuration file.

None

None

Nothing

Insert a new account record.

ia

name, pass, class, description, domains, enabled

Nothing

Delete an account record.

da

SQL where clause

Nothing

Modify an account record.

ua

SQL where clause and any of: name, pass, class, description, domains, enabled

Nothing

Select one or more account records.

sa

SQL where clause and zero or more of: count, pager, pager_type

Zero or more account records

Continue traversing the result set of a prior select_account command.

snxa

zero or more of: count

Zero or more account records

Count the total number of account records matching the given WHERE clause.

ca

SQL where clause

A count value

Insert a new domain record.

id

name, groups, description, domains

Nothing

Delete a domain record.

dd

SQL where clause

Nothing

Modify a domain record.

ud

SQL where clause and any of: name, groups, description, domains

Nothing

Select one or more domain records.

sd

SQL where clause and zero or more of: count, pager, pager_type

Zero or more domain records

Continue traversing the result set of a prior select_domain command.

snxd

zero or more of: count

Nothing

Count the total number of domain records matching the given WHERE clause.

cd

SQL where clause

A count value

Insert a new domain group record.

idg

name, description, domains

Nothing

Delete a domain group record.

ddg

SQL where clause

Nothing

Modify a domain group record.

udg

SQL where clause and any of: name, description, domains

Nothing

Select one or more domain group records.

sdg

SQL where clause and zero or more of: count, pager, pager_type

Zero or more domain records

Continue traversing the result set of a prior select_domain_group command.

snxdg

zero or more of: count

Nothing

Count the total number of domain group records matching the given WHERE clause.

cdg

SQL where clause

A count value

Insert a new system sample.

is

version, data, domains

Nothing

No example is provided. This command is not for administrative use.

Delete a system sample.

ds

SQL where clause

Nothing

Modify a system sample.

us

SQL where clause and any of: name, description, domains

Nothing

No example is provided. This command is not for administrative use.

Select one or more system sample records.

ss

SQL where clause and zero or more of: count, pager, pager_type

Zero or more system sample records

Continue traversing the result set of a prior select_sample command.

snxdg

zero or more of: count

Nothing

Count the total number of system sample records matching the given WHERE clause.

cdg

SQL where clause

A count value

Insert a new access control record.

iac

access_id, domain_id, rights

Nothing

Delete an access control record.

dac

SQL where clause

Nothing

Modify an access control record.

uac

SQL where clause and any of: access_id, domain_id, rights

Nothing

Select one or more access control records.

sac

SQL where clause and zero or more of: count, pager, pager_type

Zero or more access control records

Continue traversing the result set of a prior select_access_control command.

snxac

zero or more of: count

Nothing

Count the total number of access control records matching the given WHERE clause.

cac

SQL where clause

A count value

Insert a new key/value record.

ikv

class, subclass, key, value, enabled, domains

Nothing

Delete a key/value record.

dkv

SQL where clause

Nothing

Modify a key/value record.

ukv

SQL where clause and any of: class, subclass, key, value, enabled, domains

Nothing

Select one or more key/value records.

skv

SQL where clause and zero or more of: count, pager, pager_type

Zero or more key/value records

Continue traversing the result set of a prior select_keyvalue command.

snxkv

zero or more of: count

Nothing

Count the total number of key/value records matching the given WHERE clause.

ckv

SQL where clause

A count value

Insert a new historical packet record.

ihp

pkt, pkt_type, primary_id, secondary_id, domains

Nothing

Delete a historical packet record.

dhp

SQL where clause

Nothing

Modify a historical packet record.

uhp

SQL where clause and any of: pkt, pkt_type, primary_id, secondary_id, domains

Nothing

Select one or more historical packet records.

shp

SQL where clause and zero or more of: count, pager, pager_type

Zero or more historical packet records

Continue traversing the result set of a prior select_historical_packet command.

snxhp

zero or more of: count

Nothing

Count the total number of historical packet records matching the given WHERE clause.

chp

SQL where clause

A count value

Insert a new address binding record.

iab

client_id, fixed, ipaddr, lease_commit, lease_duration, protocol, relay, source_pool, tid, tid_type, domains

duid, iaid, iatype, fixed, ipaddr, lease_commit, lease_duration, protocol, relay, source_pool, tid, tid_type, domains

Nothing

Delete an address binding.

dab

SQL where clause

Nothing

Modify an address binding.

uab

SQL where clause and any of: client_id, fixed, ipaddr, lease_commit, lease_duration, protocol, relay, source_pool, tid, tid_type, domains

SQL where clause and any of: duid, iaid, iatype, fixed, ipaddr, lease_commit, lease_duration, protocol, relay, source_pool, tid, tid_type, domains

Nothing

Select one or more address binding records.

sab

SQL where clause and zero or more of: count, pager, pager_type

Zero or more address binding records

Continue traversing the result set of a prior select_address_binding command.

snxab

zero or more of: count

Nothing

Count the total number of address binding records matching the given WHERE clause.

cab

SQL where clause

A count value

Insert a new address pending record.

none

client_id, offer_time, source_pool, ipaddr, relay, domains

duid, iaid, iatype, offer_time, source_pool, ipaddr, relay, domains

Nothing

Delete an address pending.

none

SQL where clause

Nothing

Modify an address pending.

none

SQL where clause and any of: client_id, offer_time, source_pool, ipaddr, relay, domains

SQL where clause and any of: duid, iaid, iatype, offer_time, source_pool, ipaddr, relay, domains

Nothing

Select one or more address pending records.

none

SQL where clause and zero or more of: count, pager, pager_type

Zero or more address pending records

Continue traversing the result set of a prior select_address_pending command.

none

zero or more of: count

Nothing

Count the total number of address pending records matching the given WHERE clause.

cap

SQL where clause

A count value

Insert a new network pending record. Network pendings are only valid in a DHCPv6 context.

none

duid, iaid, iatype, prefix_len, offer_time, source_pool, ipaddr, relay, domains

Nothing

Delete a network pending. Network pendings are only valid in a DHCPv6 context.

none

SQL where clause

Nothing

Modify a network pending. Network pendings are only valid in a DHCPv6 context.

none

SQL where clause and any of: duid, iaid, iatype, prefix_len, offer_time, source_pool, ipaddr, relay, domains

Nothing

Select one or more network pending records. Network pendings are only valid in a DHCPv6 context.

none

SQL where clause and zero or more of: count, pager, pager_type

Zero or more network pending records

Continue traversing the result set of a prior select_network_pending command.

none

zero or more of: count

Nothing

Count the total number of network pending records matching the given WHERE clause.

cnp

SQL where clause

A count value

Insert a new network binding record. Network bindings are only valid in a DHCPv6 context.

inb

duid, iaid, iatype, prefix_len, fixed, ipaddr, lease_commit, lease_duration, protocol, relay, source_pool, tid, tid_type, domains

Nothing

Delete a network binding. Network bindings are only valid in a DHCPv6 context.

dnb

SQL where clause

Nothing

Modify a network binding. Network bindings are only valid in a DHCPv6 context.

unb

SQL where clause and any of: duid, iaid, iatype, prefix_len, fixed, ipaddr, lease_commit, lease_duration, protocol, relay, source_pool, tid, tid_type, domains

Nothing

Select one or more network binding records. Network bindings are only valid in a DHCPv6 context.

snb

SQL where clause and zero or more of: count, pager, pager_type

Zero or more network binding records

Continue traversing the result set of a prior select_network_binding command.

none

zero or more of: count

Nothing

Count the total number of network binding records matching the given WHERE clause.

cnb

SQL where clause

A count value

Insert a new address pool record.

iap

allow, deny, description, enabled, name, pref_lt, valid_lt, prefix, prefix_len, rangestart, rangestop, relay, weight, xrange, domains, any DHCP option

Nothing

Delete an address pool.

dap

SQL where clause

Nothing

Modify an address pool.

uap

SQL where clause and any of: allow, deny, description, enabled, name, pref_lt, valid_lt, prefix, prefix_len, rangestart, rangestop, relay, weight, xrange, domains, any DHCP option

Nothing

Select one or more address pool records.

sap

SQL where clause and zero or more of: count, pager, pager_type

Zero or more address pool records

Continue traversing the result set of a prior select_address_pool command.

snxap

zero or more of: count

Nothing

Count the total number of address pool records matching the given WHERE clause.

cap

SQL where clause

A count value

Insert a new network pool record. Network pools are only valid in a DHCPv6 context.

inp

allow, deny, description, enabled, name, pref_lt, valid_lt, prefix, prefix_len, sub_prefix_len, relay, weight, xrange, domains, any DHCP option

Nothing