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

iosxe.Dot1x

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 Dot1x 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.Dot1x;
    import com.pulumi.iosxe.Dot1xArgs;
    import com.pulumi.iosxe.inputs.Dot1xCredentialArgs;
    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 Dot1x("example", Dot1xArgs.builder()        
                .authFailEapol(true)
                .credentials(Dot1xCredentialArgs.builder()
                    .anonymous_id("1")
                    .description("credential_profile_name")
                    .password("password123")
                    .password_type("0")
                    .pki_trustpoint("trustpoint1")
                    .profile_name("profile1")
                    .username("username1")
                    .build())
                .criticalEapolConfigBlock(true)
                .loggingVerbose(true)
                .supplicantControlledTransient(true)
                .supplicantForceMulticast(true)
                .systemAuthControl(true)
                .testTimeout(1000)
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      example:
        type: iosxe:Dot1x
        properties:
          authFailEapol: true
          credentials:
            - anonymous_id: '1'
              description: credential_profile_name
              password: password123
              password_type: '0'
              pki_trustpoint: trustpoint1
              profile_name: profile1
              username: username1
          criticalEapolConfigBlock: true
          loggingVerbose: true
          supplicantControlledTransient: true
          supplicantForceMulticast: true
          systemAuthControl: true
          testTimeout: 1000
    

    Create Dot1x Resource

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

    Constructor syntax

    new Dot1x(name: string, args?: Dot1xArgs, opts?: CustomResourceOptions);
    @overload
    def Dot1x(resource_name: str,
              args: Optional[Dot1xArgs] = None,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Dot1x(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              auth_fail_eapol: Optional[bool] = None,
              credentials: Optional[Sequence[Dot1xCredentialArgs]] = None,
              critical_eapol_config_block: Optional[bool] = None,
              critical_recovery_delay: Optional[int] = None,
              delete_mode: Optional[str] = None,
              device: Optional[str] = None,
              logging_verbose: Optional[bool] = None,
              supplicant_controlled_transient: Optional[bool] = None,
              supplicant_force_multicast: Optional[bool] = None,
              system_auth_control: Optional[bool] = None,
              test_timeout: Optional[int] = None)
    func NewDot1x(ctx *Context, name string, args *Dot1xArgs, opts ...ResourceOption) (*Dot1x, error)
    public Dot1x(string name, Dot1xArgs? args = null, CustomResourceOptions? opts = null)
    public Dot1x(String name, Dot1xArgs args)
    public Dot1x(String name, Dot1xArgs args, CustomResourceOptions options)
    
    type: iosxe:Dot1x
    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 Dot1xArgs
    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 Dot1xArgs
    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 Dot1xArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args Dot1xArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args Dot1xArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var dot1xResource = new Iosxe.Dot1x("dot1xResource", new()
    {
        AuthFailEapol = false,
        Credentials = new[]
        {
            new Iosxe.Inputs.Dot1xCredentialArgs
            {
                ProfileName = "string",
                AnonymousId = "string",
                Description = "string",
                Password = "string",
                PasswordType = "string",
                PkiTrustpoint = "string",
                Username = "string",
            },
        },
        CriticalEapolConfigBlock = false,
        CriticalRecoveryDelay = 0,
        DeleteMode = "string",
        Device = "string",
        LoggingVerbose = false,
        SupplicantControlledTransient = false,
        SupplicantForceMulticast = false,
        SystemAuthControl = false,
        TestTimeout = 0,
    });
    
    example, err := iosxe.NewDot1x(ctx, "dot1xResource", &iosxe.Dot1xArgs{
    	AuthFailEapol: pulumi.Bool(false),
    	Credentials: iosxe.Dot1xCredentialArray{
    		&iosxe.Dot1xCredentialArgs{
    			ProfileName:   pulumi.String("string"),
    			AnonymousId:   pulumi.String("string"),
    			Description:   pulumi.String("string"),
    			Password:      pulumi.String("string"),
    			PasswordType:  pulumi.String("string"),
    			PkiTrustpoint: pulumi.String("string"),
    			Username:      pulumi.String("string"),
    		},
    	},
    	CriticalEapolConfigBlock:      pulumi.Bool(false),
    	CriticalRecoveryDelay:         pulumi.Int(0),
    	DeleteMode:                    pulumi.String("string"),
    	Device:                        pulumi.String("string"),
    	LoggingVerbose:                pulumi.Bool(false),
    	SupplicantControlledTransient: pulumi.Bool(false),
    	SupplicantForceMulticast:      pulumi.Bool(false),
    	SystemAuthControl:             pulumi.Bool(false),
    	TestTimeout:                   pulumi.Int(0),
    })
    
    var dot1xResource = new Dot1x("dot1xResource", Dot1xArgs.builder()        
        .authFailEapol(false)
        .credentials(Dot1xCredentialArgs.builder()
            .profileName("string")
            .anonymousId("string")
            .description("string")
            .password("string")
            .passwordType("string")
            .pkiTrustpoint("string")
            .username("string")
            .build())
        .criticalEapolConfigBlock(false)
        .criticalRecoveryDelay(0)
        .deleteMode("string")
        .device("string")
        .loggingVerbose(false)
        .supplicantControlledTransient(false)
        .supplicantForceMulticast(false)
        .systemAuthControl(false)
        .testTimeout(0)
        .build());
    
    dot1x_resource = iosxe.Dot1x("dot1xResource",
        auth_fail_eapol=False,
        credentials=[iosxe.Dot1xCredentialArgs(
            profile_name="string",
            anonymous_id="string",
            description="string",
            password="string",
            password_type="string",
            pki_trustpoint="string",
            username="string",
        )],
        critical_eapol_config_block=False,
        critical_recovery_delay=0,
        delete_mode="string",
        device="string",
        logging_verbose=False,
        supplicant_controlled_transient=False,
        supplicant_force_multicast=False,
        system_auth_control=False,
        test_timeout=0)
    
    const dot1xResource = new iosxe.Dot1x("dot1xResource", {
        authFailEapol: false,
        credentials: [{
            profileName: "string",
            anonymousId: "string",
            description: "string",
            password: "string",
            passwordType: "string",
            pkiTrustpoint: "string",
            username: "string",
        }],
        criticalEapolConfigBlock: false,
        criticalRecoveryDelay: 0,
        deleteMode: "string",
        device: "string",
        loggingVerbose: false,
        supplicantControlledTransient: false,
        supplicantForceMulticast: false,
        systemAuthControl: false,
        testTimeout: 0,
    });
    
    type: iosxe:Dot1x
    properties:
        authFailEapol: false
        credentials:
            - anonymousId: string
              description: string
              password: string
              passwordType: string
              pkiTrustpoint: string
              profileName: string
              username: string
        criticalEapolConfigBlock: false
        criticalRecoveryDelay: 0
        deleteMode: string
        device: string
        loggingVerbose: false
        supplicantControlledTransient: false
        supplicantForceMulticast: false
        systemAuthControl: false
        testTimeout: 0
    

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

    AuthFailEapol bool
    Send EAPOL-Success on successful auth-fail Authorization
    Credentials List<Lbrlabs.PulumiPackage.Iosxe.Inputs.Dot1xCredential>
    Configure 802.1X credentials profiles
    CriticalEapolConfigBlock bool
    Block all EAPoL transaction on Critical Authentication
    CriticalRecoveryDelay int
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    LoggingVerbose bool
    Show verbose messages in system logs
    SupplicantControlledTransient bool
    Controlled access is only applied during authentication
    SupplicantForceMulticast bool
    Force 802.1X supplicant to send multicast packets
    SystemAuthControl bool
    Enable or Disable SysAuthControl
    TestTimeout int
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535
    AuthFailEapol bool
    Send EAPOL-Success on successful auth-fail Authorization
    Credentials []Dot1xCredentialArgs
    Configure 802.1X credentials profiles
    CriticalEapolConfigBlock bool
    Block all EAPoL transaction on Critical Authentication
    CriticalRecoveryDelay int
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    LoggingVerbose bool
    Show verbose messages in system logs
    SupplicantControlledTransient bool
    Controlled access is only applied during authentication
    SupplicantForceMulticast bool
    Force 802.1X supplicant to send multicast packets
    SystemAuthControl bool
    Enable or Disable SysAuthControl
    TestTimeout int
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535
    authFailEapol Boolean
    Send EAPOL-Success on successful auth-fail Authorization
    credentials List<Dot1xCredential>
    Configure 802.1X credentials profiles
    criticalEapolConfigBlock Boolean
    Block all EAPoL transaction on Critical Authentication
    criticalRecoveryDelay Integer
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    loggingVerbose Boolean
    Show verbose messages in system logs
    supplicantControlledTransient Boolean
    Controlled access is only applied during authentication
    supplicantForceMulticast Boolean
    Force 802.1X supplicant to send multicast packets
    systemAuthControl Boolean
    Enable or Disable SysAuthControl
    testTimeout Integer
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535
    authFailEapol boolean
    Send EAPOL-Success on successful auth-fail Authorization
    credentials Dot1xCredential[]
    Configure 802.1X credentials profiles
    criticalEapolConfigBlock boolean
    Block all EAPoL transaction on Critical Authentication
    criticalRecoveryDelay number
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    loggingVerbose boolean
    Show verbose messages in system logs
    supplicantControlledTransient boolean
    Controlled access is only applied during authentication
    supplicantForceMulticast boolean
    Force 802.1X supplicant to send multicast packets
    systemAuthControl boolean
    Enable or Disable SysAuthControl
    testTimeout number
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535
    auth_fail_eapol bool
    Send EAPOL-Success on successful auth-fail Authorization
    credentials Sequence[Dot1xCredentialArgs]
    Configure 802.1X credentials profiles
    critical_eapol_config_block bool
    Block all EAPoL transaction on Critical Authentication
    critical_recovery_delay int
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    logging_verbose bool
    Show verbose messages in system logs
    supplicant_controlled_transient bool
    Controlled access is only applied during authentication
    supplicant_force_multicast bool
    Force 802.1X supplicant to send multicast packets
    system_auth_control bool
    Enable or Disable SysAuthControl
    test_timeout int
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535
    authFailEapol Boolean
    Send EAPOL-Success on successful auth-fail Authorization
    credentials List<Property Map>
    Configure 802.1X credentials profiles
    criticalEapolConfigBlock Boolean
    Block all EAPoL transaction on Critical Authentication
    criticalRecoveryDelay Number
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    loggingVerbose Boolean
    Show verbose messages in system logs
    supplicantControlledTransient Boolean
    Controlled access is only applied during authentication
    supplicantForceMulticast Boolean
    Force 802.1X supplicant to send multicast packets
    systemAuthControl Boolean
    Enable or Disable SysAuthControl
    testTimeout Number
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535

    Outputs

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

    Get an existing Dot1x 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?: Dot1xState, opts?: CustomResourceOptions): Dot1x
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auth_fail_eapol: Optional[bool] = None,
            credentials: Optional[Sequence[Dot1xCredentialArgs]] = None,
            critical_eapol_config_block: Optional[bool] = None,
            critical_recovery_delay: Optional[int] = None,
            delete_mode: Optional[str] = None,
            device: Optional[str] = None,
            logging_verbose: Optional[bool] = None,
            supplicant_controlled_transient: Optional[bool] = None,
            supplicant_force_multicast: Optional[bool] = None,
            system_auth_control: Optional[bool] = None,
            test_timeout: Optional[int] = None) -> Dot1x
    func GetDot1x(ctx *Context, name string, id IDInput, state *Dot1xState, opts ...ResourceOption) (*Dot1x, error)
    public static Dot1x Get(string name, Input<string> id, Dot1xState? state, CustomResourceOptions? opts = null)
    public static Dot1x get(String name, Output<String> id, Dot1xState 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:
    AuthFailEapol bool
    Send EAPOL-Success on successful auth-fail Authorization
    Credentials List<Lbrlabs.PulumiPackage.Iosxe.Inputs.Dot1xCredential>
    Configure 802.1X credentials profiles
    CriticalEapolConfigBlock bool
    Block all EAPoL transaction on Critical Authentication
    CriticalRecoveryDelay int
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    LoggingVerbose bool
    Show verbose messages in system logs
    SupplicantControlledTransient bool
    Controlled access is only applied during authentication
    SupplicantForceMulticast bool
    Force 802.1X supplicant to send multicast packets
    SystemAuthControl bool
    Enable or Disable SysAuthControl
    TestTimeout int
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535
    AuthFailEapol bool
    Send EAPOL-Success on successful auth-fail Authorization
    Credentials []Dot1xCredentialArgs
    Configure 802.1X credentials profiles
    CriticalEapolConfigBlock bool
    Block all EAPoL transaction on Critical Authentication
    CriticalRecoveryDelay int
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    LoggingVerbose bool
    Show verbose messages in system logs
    SupplicantControlledTransient bool
    Controlled access is only applied during authentication
    SupplicantForceMulticast bool
    Force 802.1X supplicant to send multicast packets
    SystemAuthControl bool
    Enable or Disable SysAuthControl
    TestTimeout int
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535
    authFailEapol Boolean
    Send EAPOL-Success on successful auth-fail Authorization
    credentials List<Dot1xCredential>
    Configure 802.1X credentials profiles
    criticalEapolConfigBlock Boolean
    Block all EAPoL transaction on Critical Authentication
    criticalRecoveryDelay Integer
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    loggingVerbose Boolean
    Show verbose messages in system logs
    supplicantControlledTransient Boolean
    Controlled access is only applied during authentication
    supplicantForceMulticast Boolean
    Force 802.1X supplicant to send multicast packets
    systemAuthControl Boolean
    Enable or Disable SysAuthControl
    testTimeout Integer
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535
    authFailEapol boolean
    Send EAPOL-Success on successful auth-fail Authorization
    credentials Dot1xCredential[]
    Configure 802.1X credentials profiles
    criticalEapolConfigBlock boolean
    Block all EAPoL transaction on Critical Authentication
    criticalRecoveryDelay number
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    loggingVerbose boolean
    Show verbose messages in system logs
    supplicantControlledTransient boolean
    Controlled access is only applied during authentication
    supplicantForceMulticast boolean
    Force 802.1X supplicant to send multicast packets
    systemAuthControl boolean
    Enable or Disable SysAuthControl
    testTimeout number
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535
    auth_fail_eapol bool
    Send EAPOL-Success on successful auth-fail Authorization
    credentials Sequence[Dot1xCredentialArgs]
    Configure 802.1X credentials profiles
    critical_eapol_config_block bool
    Block all EAPoL transaction on Critical Authentication
    critical_recovery_delay int
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    logging_verbose bool
    Show verbose messages in system logs
    supplicant_controlled_transient bool
    Controlled access is only applied during authentication
    supplicant_force_multicast bool
    Force 802.1X supplicant to send multicast packets
    system_auth_control bool
    Enable or Disable SysAuthControl
    test_timeout int
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535
    authFailEapol Boolean
    Send EAPOL-Success on successful auth-fail Authorization
    credentials List<Property Map>
    Configure 802.1X credentials profiles
    criticalEapolConfigBlock Boolean
    Block all EAPoL transaction on Critical Authentication
    criticalRecoveryDelay Number
    Set 802.1x Critical Authentication Recovery Delay period - Range: 1-10000
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    loggingVerbose Boolean
    Show verbose messages in system logs
    supplicantControlledTransient Boolean
    Controlled access is only applied during authentication
    supplicantForceMulticast Boolean
    Force 802.1X supplicant to send multicast packets
    systemAuthControl Boolean
    Enable or Disable SysAuthControl
    testTimeout Number
    Timeout for device EAPOL capabilities test in seconds - Range: 1-65535

    Supporting Types

    Dot1xCredential, Dot1xCredentialArgs

    Import

     $ pulumi import iosxe:index/dot1x:Dot1x example "Cisco-IOS-XE-native:native/dot1x"
    

    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