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

iosxe.RadiusServer

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 Radius Server 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.RadiusServer;
    import com.pulumi.iosxe.RadiusServerArgs;
    import com.pulumi.iosxe.inputs.RadiusServerAttributeArgs;
    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 RadiusServer("example", RadiusServerArgs.builder()        
                .attributes(RadiusServerAttributeArgs.builder()
                    .attribute_31_parameters(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .number("31")
                    .build())
                .deadCriteriaTime(5)
                .deadCriteriaTries(3)
                .deadtime(3)
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      example:
        type: iosxe:RadiusServer
        properties:
          attributes:
            - attribute_31_parameters:
                - callingStationId: mac
                  idMacFormat: ietf
                  idMacLuCase: lower-case
              number: '31'
          deadCriteriaTime: 5
          deadCriteriaTries: 3
          deadtime: 3
    

    Create RadiusServer Resource

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

    Constructor syntax

    new RadiusServer(name: string, args?: RadiusServerArgs, opts?: CustomResourceOptions);
    @overload
    def RadiusServer(resource_name: str,
                     args: Optional[RadiusServerArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def RadiusServer(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     attributes: Optional[Sequence[RadiusServerAttributeArgs]] = None,
                     dead_criteria_time: Optional[int] = None,
                     dead_criteria_tries: Optional[int] = None,
                     deadtime: Optional[int] = None,
                     device: Optional[str] = None)
    func NewRadiusServer(ctx *Context, name string, args *RadiusServerArgs, opts ...ResourceOption) (*RadiusServer, error)
    public RadiusServer(string name, RadiusServerArgs? args = null, CustomResourceOptions? opts = null)
    public RadiusServer(String name, RadiusServerArgs args)
    public RadiusServer(String name, RadiusServerArgs args, CustomResourceOptions options)
    
    type: iosxe:RadiusServer
    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 RadiusServerArgs
    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 RadiusServerArgs
    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 RadiusServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RadiusServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RadiusServerArgs
    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 radiusServerResource = new Iosxe.RadiusServer("radiusServerResource", new()
    {
        Attributes = new[]
        {
            new Iosxe.Inputs.RadiusServerAttributeArgs
            {
                Number = "string",
                AccessRequestInclude = false,
                Attribute31Parameters = new[]
                {
                    new Iosxe.Inputs.RadiusServerAttributeAttribute31ParameterArgs
                    {
                        CallingStationId = "string",
                        IdMacFormat = "string",
                        IdMacLuCase = "string",
                        IdSendMacOnly = false,
                        IdSendNasPortDetail = false,
                    },
                },
                SendAttributes = new[]
                {
                    "string",
                },
            },
        },
        DeadCriteriaTime = 0,
        DeadCriteriaTries = 0,
        Deadtime = 0,
        Device = "string",
    });
    
    example, err := iosxe.NewRadiusServer(ctx, "radiusServerResource", &iosxe.RadiusServerArgs{
    	Attributes: iosxe.RadiusServerAttributeArray{
    		&iosxe.RadiusServerAttributeArgs{
    			Number:               pulumi.String("string"),
    			AccessRequestInclude: pulumi.Bool(false),
    			Attribute31Parameters: iosxe.RadiusServerAttributeAttribute31ParameterArray{
    				&iosxe.RadiusServerAttributeAttribute31ParameterArgs{
    					CallingStationId:    pulumi.String("string"),
    					IdMacFormat:         pulumi.String("string"),
    					IdMacLuCase:         pulumi.String("string"),
    					IdSendMacOnly:       pulumi.Bool(false),
    					IdSendNasPortDetail: pulumi.Bool(false),
    				},
    			},
    			SendAttributes: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	DeadCriteriaTime:  pulumi.Int(0),
    	DeadCriteriaTries: pulumi.Int(0),
    	Deadtime:          pulumi.Int(0),
    	Device:            pulumi.String("string"),
    })
    
    var radiusServerResource = new RadiusServer("radiusServerResource", RadiusServerArgs.builder()
        .attributes(RadiusServerAttributeArgs.builder()
            .number("string")
            .accessRequestInclude(false)
            .attribute31Parameters(RadiusServerAttributeAttribute31ParameterArgs.builder()
                .callingStationId("string")
                .idMacFormat("string")
                .idMacLuCase("string")
                .idSendMacOnly(false)
                .idSendNasPortDetail(false)
                .build())
            .sendAttributes("string")
            .build())
        .deadCriteriaTime(0)
        .deadCriteriaTries(0)
        .deadtime(0)
        .device("string")
        .build());
    
    radius_server_resource = iosxe.RadiusServer("radiusServerResource",
        attributes=[{
            "number": "string",
            "access_request_include": False,
            "attribute31_parameters": [{
                "calling_station_id": "string",
                "id_mac_format": "string",
                "id_mac_lu_case": "string",
                "id_send_mac_only": False,
                "id_send_nas_port_detail": False,
            }],
            "send_attributes": ["string"],
        }],
        dead_criteria_time=0,
        dead_criteria_tries=0,
        deadtime=0,
        device="string")
    
    const radiusServerResource = new iosxe.RadiusServer("radiusServerResource", {
        attributes: [{
            number: "string",
            accessRequestInclude: false,
            attribute31Parameters: [{
                callingStationId: "string",
                idMacFormat: "string",
                idMacLuCase: "string",
                idSendMacOnly: false,
                idSendNasPortDetail: false,
            }],
            sendAttributes: ["string"],
        }],
        deadCriteriaTime: 0,
        deadCriteriaTries: 0,
        deadtime: 0,
        device: "string",
    });
    
    type: iosxe:RadiusServer
    properties:
        attributes:
            - accessRequestInclude: false
              attribute31Parameters:
                - callingStationId: string
                  idMacFormat: string
                  idMacLuCase: string
                  idSendMacOnly: false
                  idSendNasPortDetail: false
              number: string
              sendAttributes:
                - string
        deadCriteriaTime: 0
        deadCriteriaTries: 0
        deadtime: 0
        device: string
    

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

    Attributes List<Lbrlabs.PulumiPackage.Iosxe.Inputs.RadiusServerAttribute>
    Customize selected radius attributes
    DeadCriteriaTime int
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    DeadCriteriaTries int
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    Deadtime int
    Time to stop using a server that does not respond - Range: 1-1440
    Device string
    A device name from the provider configuration.
    Attributes []RadiusServerAttributeArgs
    Customize selected radius attributes
    DeadCriteriaTime int
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    DeadCriteriaTries int
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    Deadtime int
    Time to stop using a server that does not respond - Range: 1-1440
    Device string
    A device name from the provider configuration.
    attributes List<RadiusServerAttribute>
    Customize selected radius attributes
    deadCriteriaTime Integer
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    deadCriteriaTries Integer
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    deadtime Integer
    Time to stop using a server that does not respond - Range: 1-1440
    device String
    A device name from the provider configuration.
    attributes RadiusServerAttribute[]
    Customize selected radius attributes
    deadCriteriaTime number
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    deadCriteriaTries number
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    deadtime number
    Time to stop using a server that does not respond - Range: 1-1440
    device string
    A device name from the provider configuration.
    attributes Sequence[RadiusServerAttributeArgs]
    Customize selected radius attributes
    dead_criteria_time int
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    dead_criteria_tries int
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    deadtime int
    Time to stop using a server that does not respond - Range: 1-1440
    device str
    A device name from the provider configuration.
    attributes List<Property Map>
    Customize selected radius attributes
    deadCriteriaTime Number
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    deadCriteriaTries Number
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    deadtime Number
    Time to stop using a server that does not respond - Range: 1-1440
    device String
    A device name from the provider configuration.

    Outputs

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

    Get an existing RadiusServer 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?: RadiusServerState, opts?: CustomResourceOptions): RadiusServer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            attributes: Optional[Sequence[RadiusServerAttributeArgs]] = None,
            dead_criteria_time: Optional[int] = None,
            dead_criteria_tries: Optional[int] = None,
            deadtime: Optional[int] = None,
            device: Optional[str] = None) -> RadiusServer
    func GetRadiusServer(ctx *Context, name string, id IDInput, state *RadiusServerState, opts ...ResourceOption) (*RadiusServer, error)
    public static RadiusServer Get(string name, Input<string> id, RadiusServerState? state, CustomResourceOptions? opts = null)
    public static RadiusServer get(String name, Output<String> id, RadiusServerState 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:
    Attributes List<Lbrlabs.PulumiPackage.Iosxe.Inputs.RadiusServerAttribute>
    Customize selected radius attributes
    DeadCriteriaTime int
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    DeadCriteriaTries int
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    Deadtime int
    Time to stop using a server that does not respond - Range: 1-1440
    Device string
    A device name from the provider configuration.
    Attributes []RadiusServerAttributeArgs
    Customize selected radius attributes
    DeadCriteriaTime int
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    DeadCriteriaTries int
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    Deadtime int
    Time to stop using a server that does not respond - Range: 1-1440
    Device string
    A device name from the provider configuration.
    attributes List<RadiusServerAttribute>
    Customize selected radius attributes
    deadCriteriaTime Integer
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    deadCriteriaTries Integer
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    deadtime Integer
    Time to stop using a server that does not respond - Range: 1-1440
    device String
    A device name from the provider configuration.
    attributes RadiusServerAttribute[]
    Customize selected radius attributes
    deadCriteriaTime number
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    deadCriteriaTries number
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    deadtime number
    Time to stop using a server that does not respond - Range: 1-1440
    device string
    A device name from the provider configuration.
    attributes Sequence[RadiusServerAttributeArgs]
    Customize selected radius attributes
    dead_criteria_time int
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    dead_criteria_tries int
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    deadtime int
    Time to stop using a server that does not respond - Range: 1-1440
    device str
    A device name from the provider configuration.
    attributes List<Property Map>
    Customize selected radius attributes
    deadCriteriaTime Number
    The time during which no properly formed response must be received from the RADIUS server - Range: 1-120
    deadCriteriaTries Number
    The number of times the router must fail to receive a response from the radius server to mark it as dead - Range: 1-100
    deadtime Number
    Time to stop using a server that does not respond - Range: 1-1440
    device String
    A device name from the provider configuration.

    Supporting Types

    RadiusServerAttribute, RadiusServerAttributeArgs

    RadiusServerAttributeAttribute31Parameter, RadiusServerAttributeAttribute31ParameterArgs

    Import

     $ pulumi import iosxe:index/radiusServer:RadiusServer example "Cisco-IOS-XE-native:native/radius-server"
    

    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