Regtok Commands#

synadm regtok#

Manage registration tokens.

synadm regtok [OPTIONS] COMMAND [ARGS]...

delete#

Delete a registration token.

synadm regtok delete [OPTIONS] TOKEN

Arguments

TOKEN#

Required argument

details#

View details of the given token.

synadm regtok details [OPTIONS] TOKEN

Options

--datetime, --dt, --timestamp, --ts#

Display expiry time in a human readable format, or as a unix timestamp in milliseconds. [default: datetime].

Arguments

TOKEN#

Required argument

list#

List registration tokens

synadm regtok list [OPTIONS]

Options

-v, --valid, -V, --invalid#

List only valid/invalid tokens.

--datetime, --dt, --timestamp, --ts#

Display expiry time in a human readable format, or as a unix timestamp in milliseconds. [default: datetime].

new#

Create a new registration token.

synadm regtok new [OPTIONS]

Options

-n, --token <token>#

Set the registration token. The default is a random value generated by the server.

-l, --length <length>#

The length of the randomly generated token if the token is not specified.

Default:

16

-u, --uses-allowed <uses_allowed>#

The number of times the token can be used to complete a registration before it becomes invalid. [default: unlimited uses]

-t, --expiry-ts <expiry_ts>#

The latest time the registration token is valid. Given as the number of milliseconds since 1970-01-01 00:00:00 UTC.

[default: no expiry]

-e, --expire-at <expire_at>#

The latest time the registration token is valid. See above for available date/time formats. [default: no expiry]

update#

Update a registration token

synadm regtok update [OPTIONS] TOKEN

Options

-u, --uses-allowed <uses_allowed>#

The number of times the token can be used to complete a registration before it becomes invalid. Use -1 for an unlimited number of uses. [default: unchanged]

-t, --expiry-ts <expiry_ts>#

The latest time the registration token is valid. Given as the number of milliseconds since 1970-01-01 00:00:00 UTC. Use -1 for no expiration. [default: unchanged]

-e, --expire-at <expire_at>#

The latest time the registration token is valid. See above for available date/time formats. [default: unchanged]

Arguments

TOKEN#

Required argument