Skip to main content
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

NameTypeDescription
hoststringThe address of the resource to connect to.
typestringThe connection type.
cacertstringThe CA certificate to validate against.
httpsbooleanSet to true to connect using HTTPS instead of HTTP.
insecurebooleanSet to true to skip validating the HTTPS certificate chain.
passwordstringThe password to use for the connection.
portnumberThe port to connect to.
scriptPathstringThe path used to copy scripts meant for remote execution.
timeoutstringThe timeout to wait for the connection to become available.
useNtlmbooleanSet to true to use NTLM authentication rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest.
userstringThe user to use for the connection.

​
hostRequired 

public readonly host: string;
  • Type: string
The address of the resource to connect to.

​
typeRequired 

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.

​
cacertOptional 

public readonly cacert: string;
  • Type: string
The CA certificate to validate against.

​
httpsOptional 

public readonly https: boolean;
  • Type: boolean
Set to true to connect using HTTPS instead of HTTP.

​
insecureOptional 

public readonly insecure: boolean;
  • Type: boolean
Set to true to skip validating the HTTPS certificate chain.

​
passwordOptional 

public readonly password: string;
  • Type: string
The password to use for the connection.

​
portOptional 

public readonly port: number;
  • Type: number
  • Default: 22
The port to connect to.

​
scriptPathOptional 

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

​
timeoutOptional 

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”.)

​
useNtlmOptional 

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.

​
userOptional 

public readonly user: string;
  • Type: string
  • Default: root
The user to use for the connection.