Profile load specifications - causes profiles to auto-load for this command and will cause options to be exposed on the command for the user to specify the desired profile by name. Profiles specified by the user on the command line always take precedence over defaults.

export
interface

  ICommandProfile

### Hierarchy

- ICommandProfile

## Index

### Properties

- optional
- required
- suppressOptions

## Properties

### Optional optional

optional: string[]

- Defined in @zowe/imperative/src/cmd/src/doc/profiles/definition/ICommandProfile.ts:37

An array of profile "types" that are optional for the execution of this command. Imperative will automatically attempt to load (the default OR the profile specified by name on the CLI). If a profile of an optional type cannot be found, the command can still continue. It is the responsiblity of the handler (for which this profile specification is defined) to properly handle an optional profile not be present when the handler is invoked.

memberof

  ICommandProfile

### Optional required

required: string[]

- Defined in @zowe/imperative/src/cmd/src/doc/profiles/definition/ICommandProfile.ts:27

An array of profile "types" that are required for the execution of this command. Imperative will automatically attempt to load (the default OR the profile specified by name on the CLI). If a profile of a required type cannot be found, the command will fail.

memberof

  ICommandProfile

### Optional suppressOptions

suppressOptions: string[]

- Defined in @zowe/imperative/src/cmd/src/doc/profiles/definition/ICommandProfile.ts:45

An array of profile "types" to suppress automatic generation of options on the command. By default, Imperative will generate an CLI option in the form "---profile" for each required & optional profile specified on this object.

memberof

  ICommandProfile

Generated using TypeDoc