Class RestAPIClient

Client for the HTTPS API at /json/*. Call loginSession first to get a session key. iLO blocks you for some time if you fail three(?) times.

Attempting to call methods with an expired session key will result in 403.

Hierarchy

RestAPIClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RestAPIClient(base: string, requestOptions?: any): RestAPIClient

- Defined in rest.ts:88
Parameters
- base: string
- Optional requestOptions: any
Returns RestAPIClient

Properties

base

base: string

requestOptions

requestOptions: any

Optional sessionKey

sessionKey?: Buffer

Methods

getRcInfo

getRcInfo(): Promise<RemoteConsoleInfo>

- Defined in rest.ts:159
Returns Promise<RemoteConsoleInfo>

getSessionInfo

getSessionInfo(): Promise<SessionInfo>

- Defined in rest.ts:141
Returns Promise<SessionInfo>

getVmStatus

getVmStatus(): Promise<VirtualMediaStatus>

- Defined in rest.ts:150
Returns Promise<VirtualMediaStatus>

loginSession

loginSession(username: string, password: string): Promise<LoginResponse>

- Defined in rest.ts:100
Logs in, returns session info (or fails with 403)

(also sets sessionKey internally for further requests)

Parameters
- username: string
- password: string
Returns Promise<LoginResponse>

rekey

rekey(): Promise<string>

- Defined in rest.ts:117
Returns Promise<string>

updateConfig

updateConfig(configName: string): Promise<string>

- Defined in rest.ts:129
Parameters
- configName: string
Returns Promise<string>

Generated using TypeDoc