Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getUsername
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

iosxe.getUsername

Explore with Pulumi AI

Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

This data source can read the Username configuration.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetUsername.Invoke(new()
    {
        Name = "user1",
    });

});
Copy
package main

import (
	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iosxe.LookupUsername(ctx, &iosxe.LookupUsernameArgs{
			Name: "user1",
		}, nil)
		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.iosxe.IosxeFunctions;
import com.pulumi.iosxe.inputs.GetUsernameArgs;
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) {
        final var example = IosxeFunctions.getUsername(GetUsernameArgs.builder()
            .name("user1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as iosxe from "@pulumi/iosxe";

const example = iosxe.getUsername({
    name: "user1",
});
Copy
import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_username(name="user1")
Copy
variables:
  example:
    fn::invoke:
      Function: iosxe:getUsername
      Arguments:
        name: user1
Copy

Using getUsername

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUsername(args: GetUsernameArgs, opts?: InvokeOptions): Promise<GetUsernameResult>
function getUsernameOutput(args: GetUsernameOutputArgs, opts?: InvokeOptions): Output<GetUsernameResult>
Copy
def get_username(device: Optional[str] = None,
                 name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetUsernameResult
def get_username_output(device: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetUsernameResult]
Copy
func LookupUsername(ctx *Context, args *LookupUsernameArgs, opts ...InvokeOption) (*LookupUsernameResult, error)
func LookupUsernameOutput(ctx *Context, args *LookupUsernameOutputArgs, opts ...InvokeOption) LookupUsernameResultOutput
Copy

> Note: This function is named LookupUsername in the Go SDK.

public static class GetUsername 
{
    public static Task<GetUsernameResult> InvokeAsync(GetUsernameArgs args, InvokeOptions? opts = null)
    public static Output<GetUsernameResult> Invoke(GetUsernameInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUsernameResult> getUsername(GetUsernameArgs args, InvokeOptions options)
public static Output<GetUsernameResult> getUsername(GetUsernameArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: iosxe:index/getUsername:getUsername
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Device string
A device name from the provider configuration.
Name This property is required. string
Device string
A device name from the provider configuration.
name This property is required. String
device String
A device name from the provider configuration.
name This property is required. string
device string
A device name from the provider configuration.
name This property is required. str
device str
A device name from the provider configuration.
name This property is required. String
device String
A device name from the provider configuration.

getUsername Result

The following output properties are available:

Description string
description string with max 128 characters
Id string
The path of the retrieved object.
Name string
Password string
PasswordEncryption string
Privilege int
Set user privilege level
Secret string
SecretEncryption string
Device string
A device name from the provider configuration.
Description string
description string with max 128 characters
Id string
The path of the retrieved object.
Name string
Password string
PasswordEncryption string
Privilege int
Set user privilege level
Secret string
SecretEncryption string
Device string
A device name from the provider configuration.
description String
description string with max 128 characters
id String
The path of the retrieved object.
name String
password String
passwordEncryption String
privilege Integer
Set user privilege level
secret String
secretEncryption String
device String
A device name from the provider configuration.
description string
description string with max 128 characters
id string
The path of the retrieved object.
name string
password string
passwordEncryption string
privilege number
Set user privilege level
secret string
secretEncryption string
device string
A device name from the provider configuration.
description str
description string with max 128 characters
id str
The path of the retrieved object.
name str
password str
password_encryption str
privilege int
Set user privilege level
secret str
secret_encryption str
device str
A device name from the provider configuration.
description String
description string with max 128 characters
id String
The path of the retrieved object.
name String
password String
passwordEncryption String
privilege Number
Set user privilege level
secret String
secretEncryption String
device String
A device name from the provider configuration.

Package Details

Repository
iosxe lbrlabs/pulumi-iosxe
License
Apache-2.0
Notes
This Pulumi package is based on the iosxe Terraform Provider.
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe