Start TSO address space and receive servlet key

export

### Hierarchy

- StartTso

## Index

### Methods

- getResourcesQuery
- setDefaultAddressSpaceParams
- start
- startCommon

## Methods

### Static getResourcesQuery

- getResourcesQuery(parms: IStartTsoParms): string

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/StartTso.ts:97

  Builds a resources query from passed parameters which is needed for z/OSMF api URI.

  memberof

    StartTso

  #### Parameters

  - ##### parms: IStartTsoParms

    object with required parameters, @see {IStartTsoParms}

  #### Returns string

  URI for z/OSMF REST call

### Static setDefaultAddressSpaceParams

- setDefaultAddressSpaceParams(parms: IStartTsoParms, accountNumber: string): IStartTsoParms

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/StartTso.ts:79

  Sets required parameters by default if not provided. If some parameters provided it uses received and the rest required parameters will be default

  static
  memberof

    StartTso

  #### Parameters

  - ##### parms: IStartTsoParms

    object with required parameters, @see {IStartTsoParms}

  - ##### accountNumber: string

    this key of IStartTsoParms required, because it cannot be default.

  #### Returns IStartTsoParms

  object with provided parameters if not the with default

### Static start

- start(session: AbstractSession, accountNumber: string, parms?: IStartTsoParms): Promise<IStartStopResponses>

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/StartTso.ts:55

  Start TSO address space with provided parameters.

  static
  memberof

    StartTso

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### accountNumber: string

    this key of IStartTsoParms required, because it cannot be default.

  - ##### Optional parms: IStartTsoParms

    optional object with required parameters, @see {IStartTsoParms}

  #### Returns Promise<IStartStopResponses>

  command response on resolve, @see {IStartStopResponses}

### Static startCommon

- startCommon(session: AbstractSession, commandParms: IStartTsoParms): any

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/StartTso.ts:38

  Start TSO address space with provided parameters

  static
  memberof

    StartTso

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### commandParms: IStartTsoParms

    object with required parameters, @see {IStartTsoParms}

  #### Returns any

  z/OSMF response object, @see {IZosmfTsoResponse}

Generated using TypeDoc