Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix
  3. API Docs
  4. networkedge
  5. SshUser
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix

equinix.networkedge.SshUser

Explore with Pulumi AI

Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix

Resource equinix.networkedge.SshUser allows creation and management of Equinix Network Edge SSH users.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Equinix = Pulumi.Equinix;

return await Deployment.RunAsync(() => 
{
    var john = new Equinix.NetworkEdge.SshUser("john", new()
    {
        Username = "john",
        Password = "secret",
        DeviceIds = new[]
        {
            "csr1000v-ha-uuid",
            "csr1000v-ha-redundant-uuid",
        },
    });

});
Copy
package main

import (
	"github.com/equinix/pulumi-equinix/sdk/go/equinix/networkedge"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkedge.NewSshUser(ctx, "john", &networkedge.SshUserArgs{
			Username: pulumi.String("john"),
			Password: pulumi.String("secret"),
			DeviceIds: pulumi.StringArray{
				pulumi.String("csr1000v-ha-uuid"),
				pulumi.String("csr1000v-ha-redundant-uuid"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.networkedge.SshUser;
import com.pulumi.equinix.networkedge.SshUserArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var john = new SshUser("john", SshUserArgs.builder()
            .username("john")
            .password("secret")
            .deviceIds(            
                "csr1000v-ha-uuid",
                "csr1000v-ha-redundant-uuid")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@equinix-labs/pulumi-equinix";

const john = new equinix.networkedge.SshUser("john", {
    username: "john",
    password: "secret",
    deviceIds: [
        "csr1000v-ha-uuid",
        "csr1000v-ha-redundant-uuid",
    ],
});
Copy
import pulumi
import pulumi_equinix as equinix

john = equinix.networkedge.SshUser("john",
    username="john",
    password="secret",
    device_ids=[
        "csr1000v-ha-uuid",
        "csr1000v-ha-redundant-uuid",
    ])
Copy
resources:
  # Create SSH user with password auth method and associate it with
  # two virtual network devices
  john:
    type: equinix:networkedge:SshUser
    properties:
      username: john
      password: secret
      deviceIds:
        - csr1000v-ha-uuid
        - csr1000v-ha-redundant-uuid
Copy

Create SshUser Resource

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

Constructor syntax

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

@overload
def SshUser(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            device_ids: Optional[Sequence[str]] = None,
            password: Optional[str] = None,
            username: Optional[str] = None)
func NewSshUser(ctx *Context, name string, args SshUserArgs, opts ...ResourceOption) (*SshUser, error)
public SshUser(string name, SshUserArgs args, CustomResourceOptions? opts = null)
public SshUser(String name, SshUserArgs args)
public SshUser(String name, SshUserArgs args, CustomResourceOptions options)

type: equinix:networkedge:SshUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SshUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SshUserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SshUserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SshUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SshUserArgs
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 sshUserResource = new Equinix.NetworkEdge.SshUser("sshUserResource", new()
{
    DeviceIds = new[]
    {
        "string",
    },
    Password = "string",
    Username = "string",
});
Copy
example, err := networkedge.NewSshUser(ctx, "sshUserResource", &networkedge.SshUserArgs{
	DeviceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Password: pulumi.String("string"),
	Username: pulumi.String("string"),
})
Copy
var sshUserResource = new SshUser("sshUserResource", SshUserArgs.builder()
    .deviceIds("string")
    .password("string")
    .username("string")
    .build());
Copy
ssh_user_resource = equinix.networkedge.SshUser("sshUserResource",
    device_ids=["string"],
    password="string",
    username="string")
Copy
const sshUserResource = new equinix.networkedge.SshUser("sshUserResource", {
    deviceIds: ["string"],
    password: "string",
    username: "string",
});
Copy
type: equinix:networkedge:SshUser
properties:
    deviceIds:
        - string
    password: string
    username: string
Copy

SshUser 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 SshUser resource accepts the following input properties:

DeviceIds This property is required. List<string>
list of device identifiers to which user will have access.
Password This property is required. string
SSH user password.
Username
This property is required.
Changes to this property will trigger replacement.
string
SSH user login name.
DeviceIds This property is required. []string
list of device identifiers to which user will have access.
Password This property is required. string
SSH user password.
Username
This property is required.
Changes to this property will trigger replacement.
string
SSH user login name.
deviceIds This property is required. List<String>
list of device identifiers to which user will have access.
password This property is required. String
SSH user password.
username
This property is required.
Changes to this property will trigger replacement.
String
SSH user login name.
deviceIds This property is required. string[]
list of device identifiers to which user will have access.
password This property is required. string
SSH user password.
username
This property is required.
Changes to this property will trigger replacement.
string
SSH user login name.
device_ids This property is required. Sequence[str]
list of device identifiers to which user will have access.
password This property is required. str
SSH user password.
username
This property is required.
Changes to this property will trigger replacement.
str
SSH user login name.
deviceIds This property is required. List<String>
list of device identifiers to which user will have access.
password This property is required. String
SSH user password.
username
This property is required.
Changes to this property will trigger replacement.
String
SSH user login name.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Uuid string
SSH user unique identifier.
Id string
The provider-assigned unique ID for this managed resource.
Uuid string
SSH user unique identifier.
id String
The provider-assigned unique ID for this managed resource.
uuid String
SSH user unique identifier.
id string
The provider-assigned unique ID for this managed resource.
uuid string
SSH user unique identifier.
id str
The provider-assigned unique ID for this managed resource.
uuid str
SSH user unique identifier.
id String
The provider-assigned unique ID for this managed resource.
uuid String
SSH user unique identifier.

Look up Existing SshUser Resource

Get an existing SshUser 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?: SshUserState, opts?: CustomResourceOptions): SshUser
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device_ids: Optional[Sequence[str]] = None,
        password: Optional[str] = None,
        username: Optional[str] = None,
        uuid: Optional[str] = None) -> SshUser
func GetSshUser(ctx *Context, name string, id IDInput, state *SshUserState, opts ...ResourceOption) (*SshUser, error)
public static SshUser Get(string name, Input<string> id, SshUserState? state, CustomResourceOptions? opts = null)
public static SshUser get(String name, Output<String> id, SshUserState state, CustomResourceOptions options)
resources:  _:    type: equinix:networkedge:SshUser    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
DeviceIds List<string>
list of device identifiers to which user will have access.
Password string
SSH user password.
Username Changes to this property will trigger replacement. string
SSH user login name.
Uuid string
SSH user unique identifier.
DeviceIds []string
list of device identifiers to which user will have access.
Password string
SSH user password.
Username Changes to this property will trigger replacement. string
SSH user login name.
Uuid string
SSH user unique identifier.
deviceIds List<String>
list of device identifiers to which user will have access.
password String
SSH user password.
username Changes to this property will trigger replacement. String
SSH user login name.
uuid String
SSH user unique identifier.
deviceIds string[]
list of device identifiers to which user will have access.
password string
SSH user password.
username Changes to this property will trigger replacement. string
SSH user login name.
uuid string
SSH user unique identifier.
device_ids Sequence[str]
list of device identifiers to which user will have access.
password str
SSH user password.
username Changes to this property will trigger replacement. str
SSH user login name.
uuid str
SSH user unique identifier.
deviceIds List<String>
list of device identifiers to which user will have access.
password String
SSH user password.
username Changes to this property will trigger replacement. String
SSH user login name.
uuid String
SSH user unique identifier.

Package Details

Repository
equinix equinix/pulumi-equinix
License
Apache-2.0
Notes
This Pulumi package is based on the equinix Terraform Provider.
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix