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

iosxe.PolicyMapEvent

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 Event configuration.

    Example Usage

    Coming soon!

    Coming soon!

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.iosxe.PolicyMapEvent;
    import com.pulumi.iosxe.PolicyMapEventArgs;
    import com.pulumi.iosxe.inputs.PolicyMapEventClassNumberArgs;
    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 PolicyMapEvent("example", PolicyMapEventArgs.builder()        
                .classNumbers(PolicyMapEventClassNumberArgs.builder()
                    .action_numbers(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .class_("MY_CLASS")
                    .execution_type("do-until-failure")
                    .number(10)
                    .build())
                .eventType("authentication-success")
                .matchType("match-all")
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      example:
        type: iosxe:PolicyMapEvent
        properties:
          classNumbers:
            - action_numbers:
                - authenticateUsingMethod: dot1x
                  authenticateUsingPriority: 10
                  authenticateUsingRetries: 2
                  authenticateUsingRetryTime: 0
                  number: 10
              class: MY_CLASS
              execution_type: do-until-failure
              number: 10
          eventType: authentication-success
          matchType: match-all
    

    Create PolicyMapEvent Resource

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

    Constructor syntax

    new PolicyMapEvent(name: string, args: PolicyMapEventArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyMapEvent(resource_name: str,
                       args: PolicyMapEventArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyMapEvent(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       event_type: Optional[str] = None,
                       class_numbers: Optional[Sequence[PolicyMapEventClassNumberArgs]] = None,
                       device: Optional[str] = None,
                       match_type: Optional[str] = None,
                       name: Optional[str] = None)
    func NewPolicyMapEvent(ctx *Context, name string, args PolicyMapEventArgs, opts ...ResourceOption) (*PolicyMapEvent, error)
    public PolicyMapEvent(string name, PolicyMapEventArgs args, CustomResourceOptions? opts = null)
    public PolicyMapEvent(String name, PolicyMapEventArgs args)
    public PolicyMapEvent(String name, PolicyMapEventArgs args, CustomResourceOptions options)
    
    type: iosxe:PolicyMapEvent
    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 PolicyMapEventArgs
    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 PolicyMapEventArgs
    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 PolicyMapEventArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyMapEventArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyMapEventArgs
    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 policyMapEventResource = new Iosxe.PolicyMapEvent("policyMapEventResource", new()
    {
        EventType = "string",
        ClassNumbers = new[]
        {
            new Iosxe.Inputs.PolicyMapEventClassNumberArgs
            {
                Number = 0,
                ActionNumbers = new[]
                {
                    new Iosxe.Inputs.PolicyMapEventClassNumberActionNumberArgs
                    {
                        Number = 0,
                        ActivateServiceTemplateConfigServiceTemplate = "string",
                        AuthenticateUsingMethod = "string",
                        AuthenticateUsingPriority = 0,
                        AuthenticateUsingRetries = 0,
                        AuthenticateUsingRetryTime = 0,
                        Authorize = false,
                        PauseReauthentication = false,
                        TerminateConfig = "string",
                    },
                },
                Class = "string",
                ExecutionType = "string",
            },
        },
        Device = "string",
        MatchType = "string",
        Name = "string",
    });
    
    example, err := iosxe.NewPolicyMapEvent(ctx, "policyMapEventResource", &iosxe.PolicyMapEventArgs{
    	EventType: pulumi.String("string"),
    	ClassNumbers: iosxe.PolicyMapEventClassNumberArray{
    		&iosxe.PolicyMapEventClassNumberArgs{
    			Number: pulumi.Int(0),
    			ActionNumbers: iosxe.PolicyMapEventClassNumberActionNumberArray{
    				&iosxe.PolicyMapEventClassNumberActionNumberArgs{
    					Number: pulumi.Int(0),
    					ActivateServiceTemplateConfigServiceTemplate: pulumi.String("string"),
    					AuthenticateUsingMethod:                      pulumi.String("string"),
    					AuthenticateUsingPriority:                    pulumi.Int(0),
    					AuthenticateUsingRetries:                     pulumi.Int(0),
    					AuthenticateUsingRetryTime:                   pulumi.Int(0),
    					Authorize:                                    pulumi.Bool(false),
    					PauseReauthentication:                        pulumi.Bool(false),
    					TerminateConfig:                              pulumi.String("string"),
    				},
    			},
    			Class:         pulumi.String("string"),
    			ExecutionType: pulumi.String("string"),
    		},
    	},
    	Device:    pulumi.String("string"),
    	MatchType: pulumi.String("string"),
    	Name:      pulumi.String("string"),
    })
    
    var policyMapEventResource = new PolicyMapEvent("policyMapEventResource", PolicyMapEventArgs.builder()
        .eventType("string")
        .classNumbers(PolicyMapEventClassNumberArgs.builder()
            .number(0)
            .actionNumbers(PolicyMapEventClassNumberActionNumberArgs.builder()
                .number(0)
                .activateServiceTemplateConfigServiceTemplate("string")
                .authenticateUsingMethod("string")
                .authenticateUsingPriority(0)
                .authenticateUsingRetries(0)
                .authenticateUsingRetryTime(0)
                .authorize(false)
                .pauseReauthentication(false)
                .terminateConfig("string")
                .build())
            .class_("string")
            .executionType("string")
            .build())
        .device("string")
        .matchType("string")
        .name("string")
        .build());
    
    policy_map_event_resource = iosxe.PolicyMapEvent("policyMapEventResource",
        event_type="string",
        class_numbers=[iosxe.PolicyMapEventClassNumberArgs(
            number=0,
            action_numbers=[iosxe.PolicyMapEventClassNumberActionNumberArgs(
                number=0,
                activate_service_template_config_service_template="string",
                authenticate_using_method="string",
                authenticate_using_priority=0,
                authenticate_using_retries=0,
                authenticate_using_retry_time=0,
                authorize=False,
                pause_reauthentication=False,
                terminate_config="string",
            )],
            class_="string",
            execution_type="string",
        )],
        device="string",
        match_type="string",
        name="string")
    
    const policyMapEventResource = new iosxe.PolicyMapEvent("policyMapEventResource", {
        eventType: "string",
        classNumbers: [{
            number: 0,
            actionNumbers: [{
                number: 0,
                activateServiceTemplateConfigServiceTemplate: "string",
                authenticateUsingMethod: "string",
                authenticateUsingPriority: 0,
                authenticateUsingRetries: 0,
                authenticateUsingRetryTime: 0,
                authorize: false,
                pauseReauthentication: false,
                terminateConfig: "string",
            }],
            "class": "string",
            executionType: "string",
        }],
        device: "string",
        matchType: "string",
        name: "string",
    });
    
    type: iosxe:PolicyMapEvent
    properties:
        classNumbers:
            - actionNumbers:
                - activateServiceTemplateConfigServiceTemplate: string
                  authenticateUsingMethod: string
                  authenticateUsingPriority: 0
                  authenticateUsingRetries: 0
                  authenticateUsingRetryTime: 0
                  authorize: false
                  number: 0
                  pauseReauthentication: false
                  terminateConfig: string
              class: string
              executionType: string
              number: 0
        device: string
        eventType: string
        matchType: string
        name: string
    

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

    EventType string
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    ClassNumbers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.PolicyMapEventClassNumber>
    class number, 1 for 1st class, 2 for 2nd...
    Device string
    A device name from the provider configuration.
    MatchType string
    • Choices: match-all, match-first
    Name string
    Name of the policy map
    EventType string
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    ClassNumbers []PolicyMapEventClassNumberArgs
    class number, 1 for 1st class, 2 for 2nd...
    Device string
    A device name from the provider configuration.
    MatchType string
    • Choices: match-all, match-first
    Name string
    Name of the policy map
    eventType String
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    classNumbers List<PolicyMapEventClassNumber>
    class number, 1 for 1st class, 2 for 2nd...
    device String
    A device name from the provider configuration.
    matchType String
    • Choices: match-all, match-first
    name String
    Name of the policy map
    eventType string
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    classNumbers PolicyMapEventClassNumber[]
    class number, 1 for 1st class, 2 for 2nd...
    device string
    A device name from the provider configuration.
    matchType string
    • Choices: match-all, match-first
    name string
    Name of the policy map
    event_type str
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    class_numbers Sequence[PolicyMapEventClassNumberArgs]
    class number, 1 for 1st class, 2 for 2nd...
    device str
    A device name from the provider configuration.
    match_type str
    • Choices: match-all, match-first
    name str
    Name of the policy map
    eventType String
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    classNumbers List<Property Map>
    class number, 1 for 1st class, 2 for 2nd...
    device String
    A device name from the provider configuration.
    matchType String
    • Choices: match-all, match-first
    name String
    Name of the policy map

    Outputs

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

    Get an existing PolicyMapEvent 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?: PolicyMapEventState, opts?: CustomResourceOptions): PolicyMapEvent
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            class_numbers: Optional[Sequence[PolicyMapEventClassNumberArgs]] = None,
            device: Optional[str] = None,
            event_type: Optional[str] = None,
            match_type: Optional[str] = None,
            name: Optional[str] = None) -> PolicyMapEvent
    func GetPolicyMapEvent(ctx *Context, name string, id IDInput, state *PolicyMapEventState, opts ...ResourceOption) (*PolicyMapEvent, error)
    public static PolicyMapEvent Get(string name, Input<string> id, PolicyMapEventState? state, CustomResourceOptions? opts = null)
    public static PolicyMapEvent get(String name, Output<String> id, PolicyMapEventState 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:
    ClassNumbers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.PolicyMapEventClassNumber>
    class number, 1 for 1st class, 2 for 2nd...
    Device string
    A device name from the provider configuration.
    EventType string
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    MatchType string
    • Choices: match-all, match-first
    Name string
    Name of the policy map
    ClassNumbers []PolicyMapEventClassNumberArgs
    class number, 1 for 1st class, 2 for 2nd...
    Device string
    A device name from the provider configuration.
    EventType string
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    MatchType string
    • Choices: match-all, match-first
    Name string
    Name of the policy map
    classNumbers List<PolicyMapEventClassNumber>
    class number, 1 for 1st class, 2 for 2nd...
    device String
    A device name from the provider configuration.
    eventType String
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    matchType String
    • Choices: match-all, match-first
    name String
    Name of the policy map
    classNumbers PolicyMapEventClassNumber[]
    class number, 1 for 1st class, 2 for 2nd...
    device string
    A device name from the provider configuration.
    eventType string
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    matchType string
    • Choices: match-all, match-first
    name string
    Name of the policy map
    class_numbers Sequence[PolicyMapEventClassNumberArgs]
    class number, 1 for 1st class, 2 for 2nd...
    device str
    A device name from the provider configuration.
    event_type str
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    match_type str
    • Choices: match-all, match-first
    name str
    Name of the policy map
    classNumbers List<Property Map>
    class number, 1 for 1st class, 2 for 2nd...
    device String
    A device name from the provider configuration.
    eventType String
    • Choices: aaa-available, absolute-timeout, agent-found, authentication-failure, authentication-success, authorization-failure, authorization-success, identity-update, inactivity-timeout, remote-authentication-failure, remote-authentication-success, remote-update, session-disconnected, session-started, tag-added, tag-removed, template-activated, template-activation-failed, template-deactivated, template-deactivation-failed, timer-expiry, violation
    matchType String
    • Choices: match-all, match-first
    name String
    Name of the policy map

    Supporting Types

    PolicyMapEventClassNumber, PolicyMapEventClassNumberArgs

    PolicyMapEventClassNumberActionNumber, PolicyMapEventClassNumberActionNumberArgs

    Import

     $ pulumi import iosxe:index/policyMapEvent:PolicyMapEvent example "Cisco-IOS-XE-native:native/policy/Cisco-IOS-XE-policy:policy-map=dot1x_policy/event=authentication-success"
    

    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