Alias namespaces and classes

The default WMIC aliases are provided in the root\Cli namespace. You can add aliases in this namespace, or you can define aliases in other namespaces. If you define aliases in other namespaces, you must use the /ROLE switch to specify the namespace when using WMIC.

MSFT_CliAlias

The principal class in the schema is the MSFT_CliAlias class. Instances of this class are aliases. An MSFT_CliAlias instance has the following properties:

FriendlyName--the name of the alias. It must be unique.

Description--a description of the alias. This is the descriptive text when /? is entered at the WMIC command line.

Formats--a list, each of which has a name and a list of properties (objects of the class MSFT_CliProperty) to be displayed for that format. All formats are objects of the class MSFT_CliFormat.

Verbs--a list, each of which are the various behaviors available through this alias. The behaviors come in two forms:

Standard verbs which are directly supported by the utility.

User-defined verbs which must map to some method defined for the target of the alias.

All verbs are objects of the class MSFT_CliVerb.

Qualifiers--a list, much the same as WMI qualifiers. All qualifiers are objects of the class MSFT_Qualifier.

Target--a WQL expression without the WHERE clause that designates which class and which of its properties the alias applies to.

PWhereclause--optional WHERE clauase that limits the Target. It may have substitution values which are the parameters of the alias. The substitution values are marked with #. If multiple parameters are needed, they are matched with the # markers in sequence.

Connection--details on which computers to connect to, the security details to be used, etc. If a connection is not specified, the computers to be accessed will be the value of /NODE, and the namespace is the value of /NAMESPACE. If a user name and password are not provided, then the value of /USER and /PASSWORD will be used, if available (otherwise the current account is used). Connection is an object of the class MSFT_CliConnection.

Classes for MSFT_CliAlias Properties

The following classes are used to define objects that are used in the properties of the MSFT_CliAlias class.

MSFT_CliFormat

Used in aliases.

The MSFT_CliFormat class defines a named format which will determine the set of properties to be displayed by the utility on a LIST command. Each MSFT_CliFormat instance has a name, a list of properties and a Format property which contains the name of a style sheet (XSL file) which must be used to format the property display.

MSFT_CliProperty

Used in formats.

Each MSFT_CliFormat instance contains a list of MSFT_CliProperty instances. Instances of the MSFT_CliProperty class define the set of properties to be displayed for a given format. Each MSFT_CliProperty instance has a derivation which might be either a constant, the name of a property or a WMI command line GET command. Each MSFT_CliProperty also has a localized description.

Formats are related to a specific XSL by the NAME property of the format object. FULL, BRIEF, and INSTANCE correspond to particular XSLs, and the NAME could specify the name of a custom XSL file.

MSFT_CliVerb

Used in aliases.

Instances of the MSFT_CliVerb class represent verbs defined for the alias. Verbs are either standard verbs (GET, LIST, CALL and SET) or user defined verbs. Standard verbs will have descriptions and usages but will not have parameters.

MSFT_CliParam

Used in verbs.

MSFT_CliQualifier

Used in both aliases and verbs. WMIC qualifiers serve the same purpose as WMI qualifiers.

MSFT_CliConnection

Used in aliases.

Other Alias Classes

The following classes are used with WMIC functionality that doesn't involve the MSFT_CliAlias class.

MSFT_CliTranslateTable

Used with GET /TRANSLATE and LIST /TRANSLATE verb-specific switches. The only translation table included with WMIC is BasicXml.

MSFT_CliTranslateTableEntry

Used in the translation table.

MSFT_CliSeeAlso

The MSFT_CliSeeAlso association provides a relationship between an alias and any aliases with some kind of functional relationship to the alias. You can extend the alias schema to allow aliases to be categorized and navigated in various ways.

More details on this class will be included in the next version of this help.

 

Note

When browsing the role namespaces using WMI browsing tools (such as CIM Studio), only the MSFT_CliAlias and MSFT_CliTranslateTable classes have instances. Their properties might includes objects of the other classes, but the other classes will not have instances of their own. CliSeeAlso might also be an exception to this note.

For this reason, when creating aliases, you primarily create instances in the MSFT_CliAlias class. You create instances of the other classes as properties of the MSFT_CliAlias class or as properties of its properties.



© 2018 Microsoft Corporation. All rights reserved. Contact Us |Terms of Use |Trademarks |Privacy & Cookies