1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. PolicyMap
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

iosxe.PolicyMap

Explore with Pulumi AI

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

    This resource can manage the Policy Map configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Lbrlabs.PulumiPackage.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Iosxe.PolicyMap("example", new()
        {
            Subscriber = true,
            Type = "control",
        });
    
    });
    
    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.NewPolicyMap(ctx, "example", &iosxe.PolicyMapArgs{
    			Subscriber: pulumi.Bool(true),
    			Type:       pulumi.String("control"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.iosxe.PolicyMap;
    import com.pulumi.iosxe.PolicyMapArgs;
    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 PolicyMap("example", PolicyMapArgs.builder()        
                .subscriber(true)
                .type("control")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_iosxe as iosxe
    
    example = iosxe.PolicyMap("example",
        subscriber=True,
        type="control")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@lbrlabs/pulumi-iosxe";
    
    const example = new iosxe.PolicyMap("example", {
        subscriber: true,
        type: "control",
    });
    
    resources:
      example:
        type: iosxe:PolicyMap
        properties:
          subscriber: true
          type: control
    

    Create PolicyMap Resource

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

    Constructor syntax

    new PolicyMap(name: string, args?: PolicyMapArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyMap(resource_name: str,
                  args: Optional[PolicyMapArgs] = None,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyMap(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  device: Optional[str] = None,
                  name: Optional[str] = None,
                  subscriber: Optional[bool] = None,
                  type: Optional[str] = None)
    func NewPolicyMap(ctx *Context, name string, args *PolicyMapArgs, opts ...ResourceOption) (*PolicyMap, error)
    public PolicyMap(string name, PolicyMapArgs? args = null, CustomResourceOptions? opts = null)
    public PolicyMap(String name, PolicyMapArgs args)
    public PolicyMap(String name, PolicyMapArgs args, CustomResourceOptions options)
    
    type: iosxe:PolicyMap
    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 PolicyMapArgs
    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 PolicyMapArgs
    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 PolicyMapArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyMapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyMapArgs
    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 policyMapResource = new Iosxe.PolicyMap("policyMapResource", new()
    {
        Device = "string",
        Name = "string",
        Subscriber = false,
        Type = "string",
    });
    
    example, err := iosxe.NewPolicyMap(ctx, "policyMapResource", &iosxe.PolicyMapArgs{
    	Device:     pulumi.String("string"),
    	Name:       pulumi.String("string"),
    	Subscriber: pulumi.Bool(false),
    	Type:       pulumi.String("string"),
    })
    
    var policyMapResource = new PolicyMap("policyMapResource", PolicyMapArgs.builder()
        .device("string")
        .name("string")
        .subscriber(false)
        .type("string")
        .build());
    
    policy_map_resource = iosxe.PolicyMap("policyMapResource",
        device="string",
        name="string",
        subscriber=False,
        type="string")
    
    const policyMapResource = new iosxe.PolicyMap("policyMapResource", {
        device: "string",
        name: "string",
        subscriber: false,
        type: "string",
    });
    
    type: iosxe:PolicyMap
    properties:
        device: string
        name: string
        subscriber: false
        type: string
    

    PolicyMap Resource Properties

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

    Inputs

    The PolicyMap resource accepts the following input properties:

    Device string
    A device name from the provider configuration.
    Name string
    Name of the policy map
    Subscriber bool
    Domain name of the policy map
    Type string
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella
    Device string
    A device name from the provider configuration.
    Name string
    Name of the policy map
    Subscriber bool
    Domain name of the policy map
    Type string
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella
    device String
    A device name from the provider configuration.
    name String
    Name of the policy map
    subscriber Boolean
    Domain name of the policy map
    type String
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella
    device string
    A device name from the provider configuration.
    name string
    Name of the policy map
    subscriber boolean
    Domain name of the policy map
    type string
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella
    device str
    A device name from the provider configuration.
    name str
    Name of the policy map
    subscriber bool
    Domain name of the policy map
    type str
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella
    device String
    A device name from the provider configuration.
    name String
    Name of the policy map
    subscriber Boolean
    Domain name of the policy map
    type String
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella

    Outputs

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

    Get an existing PolicyMap 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?: PolicyMapState, opts?: CustomResourceOptions): PolicyMap
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            device: Optional[str] = None,
            name: Optional[str] = None,
            subscriber: Optional[bool] = None,
            type: Optional[str] = None) -> PolicyMap
    func GetPolicyMap(ctx *Context, name string, id IDInput, state *PolicyMapState, opts ...ResourceOption) (*PolicyMap, error)
    public static PolicyMap Get(string name, Input<string> id, PolicyMapState? state, CustomResourceOptions? opts = null)
    public static PolicyMap get(String name, Output<String> id, PolicyMapState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Device string
    A device name from the provider configuration.
    Name string
    Name of the policy map
    Subscriber bool
    Domain name of the policy map
    Type string
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella
    Device string
    A device name from the provider configuration.
    Name string
    Name of the policy map
    Subscriber bool
    Domain name of the policy map
    Type string
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella
    device String
    A device name from the provider configuration.
    name String
    Name of the policy map
    subscriber Boolean
    Domain name of the policy map
    type String
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella
    device string
    A device name from the provider configuration.
    name string
    Name of the policy map
    subscriber boolean
    Domain name of the policy map
    type string
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella
    device str
    A device name from the provider configuration.
    name str
    Name of the policy map
    subscriber bool
    Domain name of the policy map
    type str
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella
    device String
    A device name from the provider configuration.
    name String
    Name of the policy map
    subscriber Boolean
    Domain name of the policy map
    type String
    type of the policy-map - Choices: access-control, appnav, control, epbr, inspect, packet-service, performance-monitor, queueing, service, service-chain, umbrella

    Import

     $ pulumi import iosxe:index/policyMap:PolicyMap example "Cisco-IOS-XE-native:native/policy/Cisco-IOS-XE-policy:policy-map=dot1x_policy"
    

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

    Package Details

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