1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. Pim
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

nxos.Pim

Explore with Pulumi AI

This resource can manage the global PIM 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.Pim("example", new()
    {
        AdminState = "enabled",
    });

});
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.NewPim(ctx, "example", &nxos.PimArgs{
			AdminState: pulumi.String("enabled"),
		})
		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.Pim;
import com.pulumi.nxos.PimArgs;
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 Pim("example", PimArgs.builder()        
            .adminState("enabled")
            .build());

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

const example = new nxos.Pim("example", {adminState: "enabled"});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.Pim("example", admin_state="enabled")
Copy
resources:
  example:
    type: nxos:Pim
    properties:
      adminState: enabled
Copy

Create Pim Resource

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

Constructor syntax

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

@overload
def Pim(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        admin_state: Optional[str] = None,
        device: Optional[str] = None)
func NewPim(ctx *Context, name string, args *PimArgs, opts ...ResourceOption) (*Pim, error)
public Pim(string name, PimArgs? args = null, CustomResourceOptions? opts = null)
public Pim(String name, PimArgs args)
public Pim(String name, PimArgs args, CustomResourceOptions options)
type: nxos:Pim
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 PimArgs
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 PimArgs
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 PimArgs
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 PimArgs
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. PimArgs
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 pimResource = new Nxos.Pim("pimResource", new()
{
    AdminState = "string",
    Device = "string",
});
Copy
example, err := nxos.NewPim(ctx, "pimResource", &nxos.PimArgs{
	AdminState: pulumi.String("string"),
	Device:     pulumi.String("string"),
})
Copy
var pimResource = new Pim("pimResource", PimArgs.builder()
    .adminState("string")
    .device("string")
    .build());
Copy
pim_resource = nxos.Pim("pimResource",
    admin_state="string",
    device="string")
Copy
const pimResource = new nxos.Pim("pimResource", {
    adminState: "string",
    device: "string",
});
Copy
type: nxos:Pim
properties:
    adminState: string
    device: string
Copy

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

AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Device string
A device name from the provider configuration.
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Device string
A device name from the provider configuration.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
device String
A device name from the provider configuration.
adminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
device string
A device name from the provider configuration.
admin_state str
Administrative state. - Choices: enabled, disabled - Default value: enabled
device str
A device name from the provider configuration.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
device String
A device name from the provider configuration.

Outputs

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

Get an existing Pim 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?: PimState, opts?: CustomResourceOptions): Pim
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state: Optional[str] = None,
        device: Optional[str] = None) -> Pim
func GetPim(ctx *Context, name string, id IDInput, state *PimState, opts ...ResourceOption) (*Pim, error)
public static Pim Get(string name, Input<string> id, PimState? state, CustomResourceOptions? opts = null)
public static Pim get(String name, Output<String> id, PimState state, CustomResourceOptions options)
resources:  _:    type: nxos:Pim    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:
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Device string
A device name from the provider configuration.
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Device string
A device name from the provider configuration.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
device String
A device name from the provider configuration.
adminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
device string
A device name from the provider configuration.
admin_state str
Administrative state. - Choices: enabled, disabled - Default value: enabled
device str
A device name from the provider configuration.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
device String
A device name from the provider configuration.

Import

 $ pulumi import nxos:index/pim:Pim example "sys/pim"
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.