Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. SshConnectionWorker
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.SshConnectionWorker

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    This resource manages a SSH connection worker in Octopus Deploy.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  minimum:
    type: octopusdeploy:SshConnectionWorker
    properties:
      accountId: account-42
      dotnetPlatform: linux-x64
      fingerprint: 'SHA256: 12345abc'
      host: hostname
      machinePolicyId: machine-policy-1
      port: 22
      workerPools:
        - worker-pools-1
  optionals:
    type: octopusdeploy:SshConnectionWorker
    properties:
      accountId: account-42
      dotnetPlatform: linux-x64
      fingerprint: 'SHA256: 12345abc'
      host: hostname
      isDisabled: true
      machinePolicyId: machine-policy-1
      port: 22
      proxyId: proxy-31
      workerPools:
        - worker-pools-1
        - worker-pools-2

    Create SshConnectionWorker Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SshConnectionWorker(name: string, args: SshConnectionWorkerArgs, opts?: CustomResourceOptions);
    @overload
def SshConnectionWorker(resource_name: str,
                        args: SshConnectionWorkerArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def SshConnectionWorker(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        account_id: Optional[str] = None,
                        dotnet_platform: Optional[str] = None,
                        fingerprint: Optional[str] = None,
                        host: Optional[str] = None,
                        machine_policy_id: Optional[str] = None,
                        port: Optional[float] = None,
                        worker_pool_ids: Optional[Sequence[str]] = None,
                        is_disabled: Optional[bool] = None,
                        name: Optional[str] = None,
                        proxy_id: Optional[str] = None,
                        space_id: Optional[str] = None)
    func NewSshConnectionWorker(ctx *Context, name string, args SshConnectionWorkerArgs, opts ...ResourceOption) (*SshConnectionWorker, error)
    public SshConnectionWorker(string name, SshConnectionWorkerArgs args, CustomResourceOptions? opts = null)
    public SshConnectionWorker(String name, SshConnectionWorkerArgs args)
public SshConnectionWorker(String name, SshConnectionWorkerArgs args, CustomResourceOptions options)

    type: octopusdeploy:SshConnectionWorker
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SshConnectionWorkerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SshConnectionWorkerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SshConnectionWorkerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SshConnectionWorkerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SshConnectionWorkerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sshConnectionWorkerResource = new Octopusdeploy.SshConnectionWorker("sshConnectionWorkerResource", new()
{
    AccountId = "string",
    DotnetPlatform = "string",
    Fingerprint = "string",
    Host = "string",
    MachinePolicyId = "string",
    Port = 0,
    WorkerPoolIds = new[]
    {
        "string",
    },
    IsDisabled = false,
    Name = "string",
    ProxyId = "string",
    SpaceId = "string",
});

    example, err := octopusdeploy.NewSshConnectionWorker(ctx, "sshConnectionWorkerResource", &octopusdeploy.SshConnectionWorkerArgs{
	AccountId:       pulumi.String("string"),
	DotnetPlatform:  pulumi.String("string"),
	Fingerprint:     pulumi.String("string"),
	Host:            pulumi.String("string"),
	MachinePolicyId: pulumi.String("string"),
	Port:            pulumi.Float64(0),
	WorkerPoolIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsDisabled: pulumi.Bool(false),
	Name:       pulumi.String("string"),
	ProxyId:    pulumi.String("string"),
	SpaceId:    pulumi.String("string"),
})

    var sshConnectionWorkerResource = new SshConnectionWorker("sshConnectionWorkerResource", SshConnectionWorkerArgs.builder()
    .accountId("string")
    .dotnetPlatform("string")
    .fingerprint("string")
    .host("string")
    .machinePolicyId("string")
    .port(0.0)
    .workerPoolIds("string")
    .isDisabled(false)
    .name("string")
    .proxyId("string")
    .spaceId("string")
    .build());

    ssh_connection_worker_resource = octopusdeploy.SshConnectionWorker("sshConnectionWorkerResource",
    account_id="string",
    dotnet_platform="string",
    fingerprint="string",
    host="string",
    machine_policy_id="string",
    port=0,
    worker_pool_ids=["string"],
    is_disabled=False,
    name="string",
    proxy_id="string",
    space_id="string")

    const sshConnectionWorkerResource = new octopusdeploy.SshConnectionWorker("sshConnectionWorkerResource", {
    accountId: "string",
    dotnetPlatform: "string",
    fingerprint: "string",
    host: "string",
    machinePolicyId: "string",
    port: 0,
    workerPoolIds: ["string"],
    isDisabled: false,
    name: "string",
    proxyId: "string",
    spaceId: "string",
});

    type: octopusdeploy:SshConnectionWorker
properties:
    accountId: string
    dotnetPlatform: string
    fingerprint: string
    host: string
    isDisabled: false
    machinePolicyId: string
    name: string
    port: 0
    proxyId: string
    spaceId: string
    workerPoolIds:
        - string

    SshConnectionWorker Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SshConnectionWorker resource accepts the following input properties:

    AccountId string
    Connection account
    DotnetPlatform string
    NET Core platform of self-contained version of Calamari
    Fingerprint string
    The host fingerprint to be verified
    Host string
    The hostname or IP address of the deployment target to connect to
    MachinePolicyId string
    Select the machine policy
    Port double
    The port number of the host to connect to (usually 22)
    WorkerPoolIds List<string>
    Select at least one worker pool for the worker
    IsDisabled bool
    When disabled, worker will not be included in any deployments
    Name string
    The name of this resource.
    ProxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    SpaceId string
    The space ID associated with this Listening tentacle worker.
    AccountId string
    Connection account
    DotnetPlatform string
    NET Core platform of self-contained version of Calamari
    Fingerprint string
    The host fingerprint to be verified
    Host string
    The hostname or IP address of the deployment target to connect to
    MachinePolicyId string
    Select the machine policy
    Port float64
    The port number of the host to connect to (usually 22)
    WorkerPoolIds []string
    Select at least one worker pool for the worker
    IsDisabled bool
    When disabled, worker will not be included in any deployments
    Name string
    The name of this resource.
    ProxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    SpaceId string
    The space ID associated with this Listening tentacle worker.
    accountId String
    Connection account
    dotnetPlatform String
    NET Core platform of self-contained version of Calamari
    fingerprint String
    The host fingerprint to be verified
    host String
    The hostname or IP address of the deployment target to connect to
    machinePolicyId String
    Select the machine policy
    port Double
    The port number of the host to connect to (usually 22)
    workerPoolIds List<String>
    Select at least one worker pool for the worker
    isDisabled Boolean
    When disabled, worker will not be included in any deployments
    name String
    The name of this resource.
    proxyId String
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId String
    The space ID associated with this Listening tentacle worker.
    accountId string
    Connection account
    dotnetPlatform string
    NET Core platform of self-contained version of Calamari
    fingerprint string
    The host fingerprint to be verified
    host string
    The hostname or IP address of the deployment target to connect to
    machinePolicyId string
    Select the machine policy
    port number
    The port number of the host to connect to (usually 22)
    workerPoolIds string[]
    Select at least one worker pool for the worker
    isDisabled boolean
    When disabled, worker will not be included in any deployments
    name string
    The name of this resource.
    proxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId string
    The space ID associated with this Listening tentacle worker.
    account_id str
    Connection account
    dotnet_platform str
    NET Core platform of self-contained version of Calamari
    fingerprint str
    The host fingerprint to be verified
    host str
    The hostname or IP address of the deployment target to connect to
    machine_policy_id str
    Select the machine policy
    port float
    The port number of the host to connect to (usually 22)
    worker_pool_ids Sequence[str]
    Select at least one worker pool for the worker
    is_disabled bool
    When disabled, worker will not be included in any deployments
    name str
    The name of this resource.
    proxy_id str
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    space_id str
    The space ID associated with this Listening tentacle worker.
    accountId String
    Connection account
    dotnetPlatform String
    NET Core platform of self-contained version of Calamari
    fingerprint String
    The host fingerprint to be verified
    host String
    The hostname or IP address of the deployment target to connect to
    machinePolicyId String
    Select the machine policy
    port Number
    The port number of the host to connect to (usually 22)
    workerPoolIds List<String>
    Select at least one worker pool for the worker
    isDisabled Boolean
    When disabled, worker will not be included in any deployments
    name String
    The name of this resource.
    proxyId String
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId String
    The space ID associated with this Listening tentacle worker.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SshConnectionWorker resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SshConnectionWorker Resource

    Get an existing SshConnectionWorker resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SshConnectionWorkerState, opts?: CustomResourceOptions): SshConnectionWorker
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        dotnet_platform: Optional[str] = None,
        fingerprint: Optional[str] = None,
        host: Optional[str] = None,
        is_disabled: Optional[bool] = None,
        machine_policy_id: Optional[str] = None,
        name: Optional[str] = None,
        port: Optional[float] = None,
        proxy_id: Optional[str] = None,
        space_id: Optional[str] = None,
        worker_pool_ids: Optional[Sequence[str]] = None) -> SshConnectionWorker
    func GetSshConnectionWorker(ctx *Context, name string, id IDInput, state *SshConnectionWorkerState, opts ...ResourceOption) (*SshConnectionWorker, error)
    public static SshConnectionWorker Get(string name, Input<string> id, SshConnectionWorkerState? state, CustomResourceOptions? opts = null)
    public static SshConnectionWorker get(String name, Output<String> id, SshConnectionWorkerState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:SshConnectionWorker    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    Connection account
    DotnetPlatform string
    NET Core platform of self-contained version of Calamari
    Fingerprint string
    The host fingerprint to be verified
    Host string
    The hostname or IP address of the deployment target to connect to
    IsDisabled bool
    When disabled, worker will not be included in any deployments
    MachinePolicyId string
    Select the machine policy
    Name string
    The name of this resource.
    Port double
    The port number of the host to connect to (usually 22)
    ProxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    SpaceId string
    The space ID associated with this Listening tentacle worker.
    WorkerPoolIds List<string>
    Select at least one worker pool for the worker
    AccountId string
    Connection account
    DotnetPlatform string
    NET Core platform of self-contained version of Calamari
    Fingerprint string
    The host fingerprint to be verified
    Host string
    The hostname or IP address of the deployment target to connect to
    IsDisabled bool
    When disabled, worker will not be included in any deployments
    MachinePolicyId string
    Select the machine policy
    Name string
    The name of this resource.
    Port float64
    The port number of the host to connect to (usually 22)
    ProxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    SpaceId string
    The space ID associated with this Listening tentacle worker.
    WorkerPoolIds []string
    Select at least one worker pool for the worker
    accountId String
    Connection account
    dotnetPlatform String
    NET Core platform of self-contained version of Calamari
    fingerprint String
    The host fingerprint to be verified
    host String
    The hostname or IP address of the deployment target to connect to
    isDisabled Boolean
    When disabled, worker will not be included in any deployments
    machinePolicyId String
    Select the machine policy
    name String
    The name of this resource.
    port Double
    The port number of the host to connect to (usually 22)
    proxyId String
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId String
    The space ID associated with this Listening tentacle worker.
    workerPoolIds List<String>
    Select at least one worker pool for the worker
    accountId string
    Connection account
    dotnetPlatform string
    NET Core platform of self-contained version of Calamari
    fingerprint string
    The host fingerprint to be verified
    host string
    The hostname or IP address of the deployment target to connect to
    isDisabled boolean
    When disabled, worker will not be included in any deployments
    machinePolicyId string
    Select the machine policy
    name string
    The name of this resource.
    port number
    The port number of the host to connect to (usually 22)
    proxyId string
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId string
    The space ID associated with this Listening tentacle worker.
    workerPoolIds string[]
    Select at least one worker pool for the worker
    account_id str
    Connection account
    dotnet_platform str
    NET Core platform of self-contained version of Calamari
    fingerprint str
    The host fingerprint to be verified
    host str
    The hostname or IP address of the deployment target to connect to
    is_disabled bool
    When disabled, worker will not be included in any deployments
    machine_policy_id str
    Select the machine policy
    name str
    The name of this resource.
    port float
    The port number of the host to connect to (usually 22)
    proxy_id str
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    space_id str
    The space ID associated with this Listening tentacle worker.
    worker_pool_ids Sequence[str]
    Select at least one worker pool for the worker
    accountId String
    Connection account
    dotnetPlatform String
    NET Core platform of self-contained version of Calamari
    fingerprint String
    The host fingerprint to be verified
    host String
    The hostname or IP address of the deployment target to connect to
    isDisabled Boolean
    When disabled, worker will not be included in any deployments
    machinePolicyId String
    Select the machine policy
    name String
    The name of this resource.
    port Number
    The port number of the host to connect to (usually 22)
    proxyId String
    Specify the connection type for the Tentacle: direct(when not set) or via a proxy server.
    spaceId String
    The space ID associated with this Listening tentacle worker.
    workerPoolIds List<String>
    Select at least one worker pool for the worker

    Import

    $ pulumi import octopusdeploy:index/sshConnectionWorker:SshConnectionWorker [options] octopusdeploy_ssh_connection_worker.<name> <machine-id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy