Utility Methods for Zowe

export

### Hierarchy

- ZosmfSession

## Index

### Properties

- ZOSMF_CONNECTION_OPTIONS
- ZOSMF_CONNECTION_OPTION_GROUP

### Accessors

- log

### Methods

- createSessCfgFromArgs

### Object literals

- ZOSMF_OPTION_BASE_PATH
- ZOSMF_OPTION_CERT_FILE
- ZOSMF_OPTION_CERT_KEY_FILE
- ZOSMF_OPTION_COMPLETION_TIMEOUT
- ZOSMF_OPTION_ESTABLISH_CONNECTION_TIMEOUT
- ZOSMF_OPTION_HOST
- ZOSMF_OPTION_PASSWORD
- ZOSMF_OPTION_PORT
- ZOSMF_OPTION_PROTOCOL
- ZOSMF_OPTION_REJECT_UNAUTHORIZED
- ZOSMF_OPTION_USER

## Properties

### Static ZOSMF_CONNECTION_OPTIONS

ZOSMF_CONNECTION_OPTIONS: ICommandOptionDefinition[] = [ZosmfSession.ZOSMF_OPTION_HOST,ZosmfSession.ZOSMF_OPTION_PORT,ZosmfSession.ZOSMF_OPTION_USER,ZosmfSession.ZOSMF_OPTION_PASSWORD,ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED,ZosmfSession.ZOSMF_OPTION_BASE_PATH,ZosmfSession.ZOSMF_OPTION_PROTOCOL,ZosmfSession.ZOSMF_OPTION_CERT_FILE,ZosmfSession.ZOSMF_OPTION_CERT_KEY_FILE,ZosmfSession.ZOSMF_OPTION_COMPLETION_TIMEOUT,ZosmfSession.ZOSMF_OPTION_ESTABLISH_CONNECTION_TIMEOUT,// ZosmfSession.ZOSMF_OPTION_CERT_FILE_PASSPHRASE]

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:168

Options related to connecting to z/OSMF These options can be filled in if the user creates a profile

### Static ZOSMF_CONNECTION_OPTION_GROUP

ZOSMF_CONNECTION_OPTION_GROUP: string = "Zosmf Connection Options"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:25

## Accessors

### Static Private log

- get log(): Logger

- - Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:199

  #### Returns Logger

## Methods

### Static createSessCfgFromArgs

- createSessCfgFromArgs(args: ICommandArguments): ISession

- - Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:188

  Given command line arguments, create an session configuration object.

  #### Parameters

  - ##### args: ICommandArguments

    The arguments specified by the user

  #### Returns ISession

  - A session configuration to be used for a session.

## Object literals

### Static ZOSMF_OPTION_BASE_PATH

ZOSMF_OPTION_BASE_PATH: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:90

Option used in profile creation and commands for base path setting for connecting to z/OSMF

### aliases

aliases: string[] = ["bp"]

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:92

### description

description: string = "The base path for your API mediation layer instance." +" Specify this option to prepend the base path to all z/OSMF resources when making REST requests." +" Do not specify this option if you are not using an API mediation layer."

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:93

### group

group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:97

### name

name: string = "base-path"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:91

### type

type: string = "string"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:96

### Static ZOSMF_OPTION_CERT_FILE

ZOSMF_OPTION_CERT_FILE: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:115

Option used to specify the path to the certificate file for authentication

### description

description: string = "The file path to a certificate file to use for authentication"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:117

### group

group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:119

### name

name: string = "cert-file"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:116

### type

type: string = "existingLocalFile"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:118

### Static ZOSMF_OPTION_CERT_KEY_FILE

ZOSMF_OPTION_CERT_KEY_FILE: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:125

Option used to specify the path to the cert's key file for authentication

### description

description: string = "The file path to a certificate key file to use for authentication"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:127

### group

group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:129

### name

name: string = "cert-key-file"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:126

### type

type: string = "existingLocalFile"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:128

### Static ZOSMF_OPTION_COMPLETION_TIMEOUT

ZOSMF_OPTION_COMPLETION_TIMEOUT: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:145

Option to specify a request completion timeout

### aliases

aliases: string[] = ["cto"]

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:147

### description

description: string = "The amount in time, in seconds, a REST operation should wait to complete before timing out"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:148

### group

group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:150

### name

name: string = "completion-timeout"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:146

### type

type: string = "number"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:149

### Static ZOSMF_OPTION_ESTABLISH_CONNECTION_TIMEOUT

ZOSMF_OPTION_ESTABLISH_CONNECTION_TIMEOUT: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:156

Option to specify a request establishment timeout

### aliases

aliases: string[] = ["ecto"]

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:158

### description

description: string = "The amount of time, in seconds, a REST operation should wait while connecting to the server before timing out"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:159

### group

group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:161

### name

name: string = "establish-connection-timeout"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:157

### type

type: string = "number"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:160

### Static ZOSMF_OPTION_HOST

ZOSMF_OPTION_HOST: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:30

Option used in profile creation and commands for hostname for z/OSMF

### aliases

aliases: string[] = ["H"]

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:32

### description

description: string = "The z/OSMF server host name."

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:33

### group

group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:36

### name

name: string = "host"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:31

### required

required: boolean = false

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:35

### type

type: string = "string"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:34

### Static ZOSMF_OPTION_PASSWORD

ZOSMF_OPTION_PASSWORD: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:66

Option used in profile creation and commands for password/passphrase for z/OSMF

### aliases

aliases: string[] = ["pass", "pw"]

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:68

### description

description: string = "Mainframe (z/OSMF) password, which can be the same as your TSO password."

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:69

### group

group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:72

### name

name: string = "password"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:67

### required

required: boolean = false

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:71

### type

type: string = "string"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:70

### Static ZOSMF_OPTION_PORT

ZOSMF_OPTION_PORT: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:42

Option used in profile creation and commands for port for z/OSMF

### aliases

aliases: string[] = ["P"]

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:44

### defaultValue

defaultValue: number = 443

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:47

### description

description: string = "The z/OSMF server port."

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:45

### group

group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:48

### name

name: string = "port"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:43

### type

type: string = "number"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:46

### Static ZOSMF_OPTION_PROTOCOL

ZOSMF_OPTION_PROTOCOL: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:103

Option used to specify HTTP or HTTPS Protocol

### defaultValue

defaultValue: string = "https"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:107

### description

description: string = "The protocol used (HTTP or HTTPS)"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:105

### group

group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:108

### name

name: string = "protocol"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:104

### type

type: string = "string"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:106

### allowableValues

allowableValues: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:109

### caseSensitive

caseSensitive: boolean = false

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:109

### values

values: string[] = ["http", "https"]

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:109

### Static ZOSMF_OPTION_REJECT_UNAUTHORIZED

ZOSMF_OPTION_REJECT_UNAUTHORIZED: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:78

Option used in profile creation and commands for rejectUnauthorized setting for connecting to z/OSMF

### aliases

aliases: string[] = ["ru"]

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:80

### defaultValue

defaultValue: boolean = true

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:83

### description

description: string = "Reject self-signed certificates."

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:81

### group

group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:84

### name

name: string = "reject-unauthorized"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:79

### type

type: string = "boolean"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:82

### Static ZOSMF_OPTION_USER

ZOSMF_OPTION_USER: object

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:54

Option used in profile creation and commands for username / ID for z/OSMF

### aliases

aliases: string[] = ["u"]

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:56

### description

description: string = "Mainframe (z/OSMF) user name, which can be the same as your TSO login."

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:57

### group

group: string = ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:60

### name

name: string = "user"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:55

### required

required: boolean = false

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:59

### type

type: string = "string"

- Defined in @zowe/zosmf-for-zowe-sdk/src/ZosmfSession.ts:58

Generated using TypeDoc