Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. System
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.System

Explore with Pulumi AI

Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

This resource can manage the system configuration.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nxos = Lbrlabs.PulumiPackage.Nxos;

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.System("example");

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nxos.NewSystem(ctx, "example", 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.nxos.System;
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 example = new System("example");

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@lbrlabs/pulumi-nxos";

const example = new nxos.System("example", {});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.System("example")
Copy
resources:
  example:
    type: nxos:System
Copy

Create System Resource

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

Constructor syntax

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

@overload
def System(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           device: Optional[str] = None,
           name: Optional[str] = None)
func NewSystem(ctx *Context, name string, args *SystemArgs, opts ...ResourceOption) (*System, error)
public System(string name, SystemArgs? args = null, CustomResourceOptions? opts = null)
public System(String name, SystemArgs args)
public System(String name, SystemArgs args, CustomResourceOptions options)

type: nxos:System
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 SystemArgs
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 SystemArgs
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 SystemArgs
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 SystemArgs
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. SystemArgs
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 systemResource = new Nxos.System("systemResource", new()
{
    Device = "string",
    Name = "string",
});
Copy
example, err := nxos.NewSystem(ctx, "systemResource", &nxos.SystemArgs{
	Device: pulumi.String("string"),
	Name:   pulumi.String("string"),
})
Copy
var systemResource = new System("systemResource", SystemArgs.builder()
    .device("string")
    .name("string")
    .build());
Copy
system_resource = nxos.System("systemResource",
    device="string",
    name="string")
Copy
const systemResource = new nxos.System("systemResource", {
    device: "string",
    name: "string",
});
Copy
type: nxos:System
properties:
    device: string
    name: string
Copy

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

Device string
A device name from the provider configuration.
Name string
The system name (hostname).
Device string
A device name from the provider configuration.
Name string
The system name (hostname).
device String
A device name from the provider configuration.
name String
The system name (hostname).
device string
A device name from the provider configuration.
name string
The system name (hostname).
device str
A device name from the provider configuration.
name str
The system name (hostname).
device String
A device name from the provider configuration.
name String
The system name (hostname).

Outputs

All input properties are implicitly available as output properties. Additionally, the System 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 System Resource

Get an existing System 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?: SystemState, opts?: CustomResourceOptions): System
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        name: Optional[str] = None) -> System
func GetSystem(ctx *Context, name string, id IDInput, state *SystemState, opts ...ResourceOption) (*System, error)
public static System Get(string name, Input<string> id, SystemState? state, CustomResourceOptions? opts = null)
public static System get(String name, Output<String> id, SystemState state, CustomResourceOptions options)
resources:  _:    type: nxos:System    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:
Device string
A device name from the provider configuration.
Name string
The system name (hostname).
Device string
A device name from the provider configuration.
Name string
The system name (hostname).
device String
A device name from the provider configuration.
name String
The system name (hostname).
device string
A device name from the provider configuration.
name string
The system name (hostname).
device str
A device name from the provider configuration.
name str
The system name (hostname).
device String
A device name from the provider configuration.
name String
The system name (hostname).

Import

 $ pulumi import nxos:index/system:System example "sys"
Copy

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

Package Details

Repository
nxos lbrlabs/pulumi-nxos
License
Apache-2.0
Notes
This Pulumi package is based on the nxos Terraform Provider.
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos