Skip to main content

Tag Commands

count-tags​

Syntax:

ssh-mgr-client count-tags [options] [-F <filter>] [-vvv] [-U <url>]

Returns the number of tags in the Key Manager system.

For filtering (-F), you can use the same attributes that are available for the list-tags command (see list-tags).

Example:

$ ssh-mgr-client count-tags
16

create-tag​

Syntax:

ssh-mgr-client create-tag -d <data> [options] [-vvv] [-U <url>]

Creates a new tag. You must provide a unique name and a free-text description for the tag. You may optionally provide a description for the tag. The tag name may not contain spaces.

Required data:

name​

The name of the tag.

Optional data:

description​

The free-text description for the tag.

Example:

$ ssh-mgr-client create-tag -d \
name=tag_name,description='Description for tag'

delete-tag​

Syntax:

ssh-mgr-client delete-tag -i <id> [options] [-vvv] [-U <url>] [-B]

Deletes tags from the system.

You must identify the tag by its ID. When a tag is deleted from the Key Manager system, the tag is also removed from all objects.

Example:

$ ssh-mgr-client delete-tag -i 4

list-tags​

Syntax:

ssh-mgr-client list-tags [options] [-F <filter>] [-vvv] [-U <url>] [-o <format>] \
[-C <columns>] [-H] [-O <sort-order>] [-S <start-from>] [-M <max-results>] \
[-E <delim>] [-B]

The default command lists all the tags in the Key Manager system:

$ ssh-mgr-client list-tags

The following columns can be used for filtering (-F) and output formatting (-C):

description​

Description of the tag

id​

Internal PrivX Key Manager id for tag

name​

Name of the tag

For example, to find all the tags, the name of which contains deleted:

$ ssh-mgr-client list-tags -F "name=*deleted*"

show-tag​

Syntax:

ssh-mgr-client show-tag -i <id> [options] [-vvv] [-U <url>] [-o <format>] [-C <columns>]

Displays the tag with the given ID.

For output formatting (-C), you can use the same attributes that are available for the list-tags command (see list-tags).

Example:

$ ssh-mgr-client show-tag -i 3