artexget Command

Purpose

The artexget command lists the configuration and tuning parameter information from a specified profile or from the system.

Syntax

artexget [-v] [-d] [-p | -r | -n] [-l {dynamic | disruptive | reboot}] [-f {txt |csv | xml}] [-m comment] [-V version] [-g categories] [-g level] profile

artexget [-q] [-d] [-p | -r | -n] [-l {dynamic | disruptive | reboot}] [-f {txt |csv | xml}] [-m comment] [-V version] [-g categories] [-g level] profile

Description

The artexget command lists the configuration and tuning parameter information from a profile or from the system. If none of the options -p, -r, or -n are specified, the command outputs the parameter and value pairs from the argument profile. If -r option is specified, the command outputs the current values of the parameters from the system. If the -n option is specified, the command outputs the values of the parameters after the next system restart. If -p option is specified, it outputs either current values of the parameters or values of the parameters after the next system restart, based on the applyType attribute value in the profile.

This command can also list the subset of the parameters based on selection criteria. If no selection criteria is specified, the command outputs a list of all parameters listed in the profile. If dynamic selection criteria (-l dynamic) is specified, then the command outputs a list of the parameters that do not require a reboot or disruptive action for the changes to take effect. The disruptive actions can be stopping and restarting a service or unmounting and mounting a file system. If disruptive selection criteria (-l disruptive) is specified, then the command outputs a list of parameters that need a disruptive action for the changes to take effect. If the selection criteria reboot (-l reboot) is specified, the command outputs a list of parameters that require a reboot for the changes to take effect.

This command displays the output in three different formats to stdout. This output can be saved into a file using the redirector (>). If none of the output formats are specified, the output displays in XML format. If Comma Separated Values (CSV) format (-f csv) is specified, then it displays in csv format, which can be used to open in a spreadsheet. If a text format (-f txt) is specified, the output is in a table like readable format.

A user comment and version can be added to the profile. If the -m option with a comment is specified, the comment is included in the output profile. If the -V option is specified with a user revision number, the version number of the output profile is updated and the revision number is changed to the user-specified revision number. Otherwise, the revision number of the output profile version number is incremented by 1.

The specified profile can exist on the local file system using a relative or absolute path or on a Lightweight Directory Access Protocol (LDAP) server.

Flags

Item	Description
-d	Creates a profile that sets all the instances of a parameter to the same value when used with the -d flag of the artexset command. The output profile contains only those parameters for which all instances would share the same value if the -d flag were not used; other parameters are removed from the profile.
-f	Specifies the output format. The -f flag has the following variables: The txt variable specifies plain text format. The csv variable specifies comma separated values format. The xml format specifies xml format. This is the default format.
-g categories	Displays debug messages for the specified coma-separated list of categories. This option is useful while you write new catalog files. The available categories follow: ALL: Includes all of the following categories. COMMANDS: Prints information about the AIX® command that is being run. DISCOVERY: Prints information about the discovery commands that are being run. THREADS: Prints information about threads that are being run within the framework. PARSING: Prints information about the parsing of profile and catalog files. FLOW: Prints information about the progress of the operation. Note: The default category is ALL.
-g level	Specifies the verbosity of the debug traces, as an integer in the range of 0 (no debug traces) - 3 (most verbose level). The default level is 0.
-l {dynamic \| disruptive \| reboot}	Indicates what tunable values to list in the output. The -l flag has the following options: The dynamic variable indicates to list the tunable parameters for which the changes take effect immediately, without any condition. The disruptive variable indicates to list the tunable parameters that require a disruptive operation such as an interruption of service or the recycling of a resource for the changes to take effect. The reboot variable indicates to list the tunable parameters that require a system reboot for changes to take effect.
-m comment	Allows users to add comments to the profile. If the -m flag is used, the specified comment overwrites the previous comment. This is an optional flag.
-n	Lists the values of the parameters after the next system restart. If the -p, -r, or -n option is not specified, then list the tunable values described by the profile.
-p	Lists either the current values of the parameters or values of the parameters after the next system restart, based on the `applyType` attribute value in the .
-q	Allows users to ignore the nonfatal warning messages. The ignored messages are not displayed on the screen. This is an optional flag. Note: This flag cannot be used with the-v flag.
-r	Lists the current values on the running system.
-v	Displays the warning and error messages generated by the AIX commands that are run during the processing of the artexget command. The messages are displayed on the `stderr`. This is an optional flag. Note: This flag cannot be used with the -q flag.
-V version	Sets the user revision number of the resulting profile. By default, the user revision number of the entry profile is incremented. If the flag -V is used, the specified user revision number overwrites the existing revision number in the profile version number.

Parameters

Item	Description
profile	This is a mandatory file. The file specified includes a list of the tunable parameters. A profile name of - (dash) can be specified for standard input.

Exit Status

Item	Description
0	The command completed successfully
>0	An error occurred.

Security

Access Control: This command should grant execute (x) access only to the root user and members of the security group. This command should be installed as a program in the trusted computing base (TCB). The command should be owned by the root user with the setuid (SUID) bit set.

Attention RBAC users and Trusted AIX users: This command can perform privileged operations. Only privileged users can run privileged operations. For more information about authorizations and privileges, see Privileged Command Database in Security. For a list of privileges and the authorizations associated with this command, see the lssecattr command or the getcmdattr subcommand. To get the full functionality of the command, besides the accessauths, the role should also have the following authorizations:

aix.security.user.audit
aix.security.role.assign
aix.security.group.change
aix.security.user.change

Files Accessed:

Mode	File
rw	/etc/passwd
rw	/etc/security/user
rw	/etc/security/user.roles
rw	/etc/security/limits
rw	/etc/security/environ
rw	/etc/group
rw	/etc/security/group
r	/usr/lib/security/artexget.default
x	/usr/lib/security/artexget.sys

Auditing Events:

Event	Information
USER_Create	user

Examples

The following example illustrates how to output the parameter and value pairs from the profile1.xml profile that is stored on a LDAP server.

artexget ldap://profile1.xml

The following example illustrates how to output the values of parameters after the next system restart from the system using the local_profile.xml profile.

artexget -n local_profile.xml

The following example illustrates how to output the current values of the parameters in text format from the system using the local_profile.xml profile.

artexget -r -f txt local_profile.xml