Command |
Description |
---|---|
add |
Assigns a profile to an element. |
create |
Creates a new, empty profile. |
delete |
Deletes a profile. |
export |
Exports the profiles contained in a profile to the specified target, using a zip file format. |
import |
Imports a profile stored in zip file format from the specified source. The source contains the profiles to be imported into the profile. |
list |
Lists all the profiles or the profiles assigned to an element or the elements a profile has been assigned to. |
login |
Stores the username and password for this datastore back end in a file in the administrator's home directory. This username and password can then be used in future invocations of pgtool. |
modify |
Changes the priority of a profile. |
remove |
Unassigns a profile from an element. |
rename |
Renames a profile. |
Table 3–2 Options
Option |
Description |
---|---|
-b <base name>, --base=<base name>, DEPRECATED |
The root entry of the storage back end. The format for this base entry is determined by the storage back end used. For example, an LDAP storage back end with a root entry of o=apoc: --base o=apoc. DEPRECATED: use the --url option instead |
-e <entity>, --entity=<entity> |
Represents a user, role, organization, host or domain element. The entry format for the element is determined by the storage back end used. For example, an LDAP storage back end with a user “jmonroe”: -e uid=jmonroe,ou=People,o=Staff,o=apoc. |
-f <file>, --file=<file> |
The fully qualified path to the file detailing the bootstrapping information to be used in the execution of this command. For example: -f /var/opt/apoc/cli.properties. |
-h <hostname>, --hostname=<hostname>, DEPRECATED |
The name of the host for the storage back end. For example: --host=server1.sun.com. DEPRECATED: use the --url option instead |
-i <priority>, --priority=<priority> |
A strictly positive integer specifying the priority of the profile. For example: -i 12. |
-l <url>, --url=<url> |
the URL identifying the datastore. The URL format is ldap://<hostname>:<port>/<base name> with <hostname> the name of the server (default is localhost), <port> the port number on the server (default is 389) and <base name> the distinguished name of the base entry. For example: --url=ldap://server1.sun.com:399/o=apoc. |
-m <name>, --name=<name> |
The name of the profile. For example: --name=UserProfile1. |
-p <port>, --port=<port>, DEPRECATED |
The port number for the storage back end. For example: -p 399. DEPRECATED: use the --url option instead |
-s <scope>, --scope=<scope> |
the scope for the profile, which can be either user or host. If not specified, then defaults to the user scope. For example: --scope=host. |
-t <type>, --type=<type>, DEPRECATED |
The type of storage back end. This defaults to LDAP. For example: -t LDAP. DEPRECATED: use the --url option instead |
-u <username>, --username=<username> |
The username of the administrator in the format used by the storage back end. The administrator is then prompted for a password. If this option is not used, and the administrator has not used the pgtool login sub-command, then the administrator is prompted to enter a username and password. For example: --username=jmonroe. |
-?, --help |
Displays the help information |
-V, --version |
Displays the version information. |