Interface for overriding the prompting behavior of ConnectionPropsForSessCfg.addPropsOrPrompt()

export
interface

  IOverridePromptConnProps

### Type parameters

- #### SessCfgType: ISession = ISession

### Hierarchy

- IOverridePromptConnProps

## Index

### Properties

- argumentName
- propertiesOverridden
- propertyName
- propsToPromptFor

## Properties

### Optional argumentName

argumentName: string

- Defined in @zowe/imperative/src/rest/src/session/doc/IOverridePromptConnProps.ts:29

Indicates the CLI argument that should be used to populate the property on the session. If not supplied, uses a CLI argument that matches the session property name.

### propertiesOverridden

propertiesOverridden: (keyof SessCfgType & string)[]

- Defined in @zowe/imperative/src/rest/src/session/doc/IOverridePromptConnProps.ts:37

Indicates the prompting fields the property should override. For example, if the property should be the preferred method of authentication, then it should override user and password. Then, if the property is on the session, it will not prompt for user and password. Prompting logic is only in place for host, port, user, and password, but cert, certKey, tokenType, and tokenValue may also need to be overridden.

### propertyName

propertyName: string

- Defined in @zowe/imperative/src/rest/src/session/doc/IOverridePromptConnProps.ts:23

Indicates the session property that should be considered in the prompting logic.

### Optional propsToPromptFor

propsToPromptFor: (keyof SessCfgType & string)[]

- Defined in @zowe/imperative/src/rest/src/session/doc/IOverridePromptConnProps.ts:43

Allows passing additional properties for which to prompt. Used in cases of an incorrect or missing key passphrase.

Generated using TypeDoc