Typescript: WinrmProvisionerConnection

Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. See connection

Initializer

import { WinrmProvisionerConnection } from 'cdktn'

const winrmProvisionerConnection: WinrmProvisionerConnection = { ... }

Properties

Name	Type	Description
`host`	`string`	The address of the resource to connect to.
`type`	`string`	The connection type.
`cacert`	`string`	The CA certificate to validate against.
`https`	`boolean`	Set to true to connect using HTTPS instead of HTTP.
`insecure`	`boolean`	Set to true to skip validating the HTTPS certificate chain.
`password`	`string`	The password to use for the connection.
`port`	`number`	The port to connect to.
`scriptPath`	`string`	The path used to copy scripts meant for remote execution.
`timeout`	`string`	The timeout to wait for the connection to become available.
`useNtlm`	`boolean`	Set to true to use NTLM authentication rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest.
`user`	`string`	The user to use for the connection.

`host`^Required

public readonly host: string;

Type: string

The address of the resource to connect to.

`type`^Required

public readonly type: string;

Type: string

The connection type. Valid values are “ssh” and “winrm”. Provisioners typically assume that the remote system runs Microsoft Windows when using WinRM. Behaviors based on the SSH target_platform will force Windows-specific behavior for WinRM, unless otherwise specified.

`cacert`^Optional

public readonly cacert: string;

Type: string

The CA certificate to validate against.

`https`^Optional

public readonly https: boolean;

Type: boolean

Set to true to connect using HTTPS instead of HTTP.

`insecure`^Optional

public readonly insecure: boolean;

Type: boolean

Set to true to skip validating the HTTPS certificate chain.

`password`^Optional

public readonly password: string;

Type: string

The password to use for the connection.

`port`^Optional

public readonly port: number;

Type: number
Default: 22

The port to connect to.

`scriptPath`^Optional

public readonly scriptPath: string;

Type: string

The path used to copy scripts meant for remote execution. Refer to How Provisioners Execute Remote Scripts below for more details

`timeout`^Optional

public readonly timeout: string;

Type: string
Default: 5m

The timeout to wait for the connection to become available. Should be provided as a string (e.g., ”30s” or “5m”.)

`useNtlm`^Optional

public readonly useNtlm: boolean;

Type: boolean

Set to true to use NTLM authentication rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest. Refer to Authentication for Remote Connections in the Windows App Development documentation for more details.

`user`^Optional

public readonly user: string;

Type: string
Default: root

The user to use for the connection.

Typescript: TestingAppConfig

Typescript: Annotations

⌘I

​Initializer

​Properties

​hostRequired

​typeRequired

​cacertOptional

​httpsOptional

​insecureOptional

​passwordOptional

​portOptional

​scriptPathOptional

​timeoutOptional

​useNtlmOptional

​userOptional