1. Packages
  2. Fortios
  3. API Docs
  4. switchcontroller
  5. Nacdevice
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.switchcontroller.Nacdevice

Explore with Pulumi AI

fortios logo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

    Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy. Applies to FortiOS Version 6.4.0,6.4.1,6.4.2,6.4.10,6.4.11,6.4.12,6.4.13,6.4.14,6.4.15,7.0.0.

    Create Nacdevice Resource

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

    Constructor syntax

    new Nacdevice(name: string, args?: NacdeviceArgs, opts?: CustomResourceOptions);
    @overload
    def Nacdevice(resource_name: str,
                  args: Optional[NacdeviceArgs] = None,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Nacdevice(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  fosid: Optional[int] = None,
                  last_known_port: Optional[str] = None,
                  last_known_switch: Optional[str] = None,
                  last_seen: Optional[int] = None,
                  mac: Optional[str] = None,
                  mac_policy: Optional[str] = None,
                  matched_nac_policy: Optional[str] = None,
                  port_policy: Optional[str] = None,
                  status: Optional[str] = None,
                  vdomparam: Optional[str] = None)
    func NewNacdevice(ctx *Context, name string, args *NacdeviceArgs, opts ...ResourceOption) (*Nacdevice, error)
    public Nacdevice(string name, NacdeviceArgs? args = null, CustomResourceOptions? opts = null)
    public Nacdevice(String name, NacdeviceArgs args)
    public Nacdevice(String name, NacdeviceArgs args, CustomResourceOptions options)
    
    type: fortios:switchcontroller:Nacdevice
    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 NacdeviceArgs
    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 NacdeviceArgs
    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 NacdeviceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NacdeviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NacdeviceArgs
    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 nacdeviceResource = new Fortios.Switchcontroller.Nacdevice("nacdeviceResource", new()
    {
        Description = "string",
        Fosid = 0,
        LastKnownPort = "string",
        LastKnownSwitch = "string",
        LastSeen = 0,
        Mac = "string",
        MacPolicy = "string",
        MatchedNacPolicy = "string",
        PortPolicy = "string",
        Status = "string",
        Vdomparam = "string",
    });
    
    example, err := switchcontroller.NewNacdevice(ctx, "nacdeviceResource", &switchcontroller.NacdeviceArgs{
    	Description:      pulumi.String("string"),
    	Fosid:            pulumi.Int(0),
    	LastKnownPort:    pulumi.String("string"),
    	LastKnownSwitch:  pulumi.String("string"),
    	LastSeen:         pulumi.Int(0),
    	Mac:              pulumi.String("string"),
    	MacPolicy:        pulumi.String("string"),
    	MatchedNacPolicy: pulumi.String("string"),
    	PortPolicy:       pulumi.String("string"),
    	Status:           pulumi.String("string"),
    	Vdomparam:        pulumi.String("string"),
    })
    
    var nacdeviceResource = new Nacdevice("nacdeviceResource", NacdeviceArgs.builder()
        .description("string")
        .fosid(0)
        .lastKnownPort("string")
        .lastKnownSwitch("string")
        .lastSeen(0)
        .mac("string")
        .macPolicy("string")
        .matchedNacPolicy("string")
        .portPolicy("string")
        .status("string")
        .vdomparam("string")
        .build());
    
    nacdevice_resource = fortios.switchcontroller.Nacdevice("nacdeviceResource",
        description="string",
        fosid=0,
        last_known_port="string",
        last_known_switch="string",
        last_seen=0,
        mac="string",
        mac_policy="string",
        matched_nac_policy="string",
        port_policy="string",
        status="string",
        vdomparam="string")
    
    const nacdeviceResource = new fortios.switchcontroller.Nacdevice("nacdeviceResource", {
        description: "string",
        fosid: 0,
        lastKnownPort: "string",
        lastKnownSwitch: "string",
        lastSeen: 0,
        mac: "string",
        macPolicy: "string",
        matchedNacPolicy: "string",
        portPolicy: "string",
        status: "string",
        vdomparam: "string",
    });
    
    type: fortios:switchcontroller:Nacdevice
    properties:
        description: string
        fosid: 0
        lastKnownPort: string
        lastKnownSwitch: string
        lastSeen: 0
        mac: string
        macPolicy: string
        matchedNacPolicy: string
        portPolicy: string
        status: string
        vdomparam: string
    

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

    Description string
    Description for the learned NAC device.
    Fosid int
    Device ID.
    LastKnownPort string
    Managed FortiSwitch port where NAC device is last learned.
    LastKnownSwitch string
    Managed FortiSwitch where NAC device is last learned.
    LastSeen int
    Device last seen.
    Mac string
    MAC address of the learned NAC device.
    MacPolicy string
    MAC policy to be applied on this learned NAC device.
    MatchedNacPolicy string
    Matched NAC policy for the learned NAC device.
    PortPolicy string
    Port policy to be applied on this learned NAC device.
    Status string
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Description string
    Description for the learned NAC device.
    Fosid int
    Device ID.
    LastKnownPort string
    Managed FortiSwitch port where NAC device is last learned.
    LastKnownSwitch string
    Managed FortiSwitch where NAC device is last learned.
    LastSeen int
    Device last seen.
    Mac string
    MAC address of the learned NAC device.
    MacPolicy string
    MAC policy to be applied on this learned NAC device.
    MatchedNacPolicy string
    Matched NAC policy for the learned NAC device.
    PortPolicy string
    Port policy to be applied on this learned NAC device.
    Status string
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    description String
    Description for the learned NAC device.
    fosid Integer
    Device ID.
    lastKnownPort String
    Managed FortiSwitch port where NAC device is last learned.
    lastKnownSwitch String
    Managed FortiSwitch where NAC device is last learned.
    lastSeen Integer
    Device last seen.
    mac String
    MAC address of the learned NAC device.
    macPolicy String
    MAC policy to be applied on this learned NAC device.
    matchedNacPolicy String
    Matched NAC policy for the learned NAC device.
    portPolicy String
    Port policy to be applied on this learned NAC device.
    status String
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    description string
    Description for the learned NAC device.
    fosid number
    Device ID.
    lastKnownPort string
    Managed FortiSwitch port where NAC device is last learned.
    lastKnownSwitch string
    Managed FortiSwitch where NAC device is last learned.
    lastSeen number
    Device last seen.
    mac string
    MAC address of the learned NAC device.
    macPolicy string
    MAC policy to be applied on this learned NAC device.
    matchedNacPolicy string
    Matched NAC policy for the learned NAC device.
    portPolicy string
    Port policy to be applied on this learned NAC device.
    status string
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    description str
    Description for the learned NAC device.
    fosid int
    Device ID.
    last_known_port str
    Managed FortiSwitch port where NAC device is last learned.
    last_known_switch str
    Managed FortiSwitch where NAC device is last learned.
    last_seen int
    Device last seen.
    mac str
    MAC address of the learned NAC device.
    mac_policy str
    MAC policy to be applied on this learned NAC device.
    matched_nac_policy str
    Matched NAC policy for the learned NAC device.
    port_policy str
    Port policy to be applied on this learned NAC device.
    status str
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    description String
    Description for the learned NAC device.
    fosid Number
    Device ID.
    lastKnownPort String
    Managed FortiSwitch port where NAC device is last learned.
    lastKnownSwitch String
    Managed FortiSwitch where NAC device is last learned.
    lastSeen Number
    Device last seen.
    mac String
    MAC address of the learned NAC device.
    macPolicy String
    MAC policy to be applied on this learned NAC device.
    matchedNacPolicy String
    Matched NAC policy for the learned NAC device.
    portPolicy String
    Port policy to be applied on this learned NAC device.
    status String
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

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

    Get an existing Nacdevice 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?: NacdeviceState, opts?: CustomResourceOptions): Nacdevice
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            fosid: Optional[int] = None,
            last_known_port: Optional[str] = None,
            last_known_switch: Optional[str] = None,
            last_seen: Optional[int] = None,
            mac: Optional[str] = None,
            mac_policy: Optional[str] = None,
            matched_nac_policy: Optional[str] = None,
            port_policy: Optional[str] = None,
            status: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Nacdevice
    func GetNacdevice(ctx *Context, name string, id IDInput, state *NacdeviceState, opts ...ResourceOption) (*Nacdevice, error)
    public static Nacdevice Get(string name, Input<string> id, NacdeviceState? state, CustomResourceOptions? opts = null)
    public static Nacdevice get(String name, Output<String> id, NacdeviceState 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:
    Description string
    Description for the learned NAC device.
    Fosid int
    Device ID.
    LastKnownPort string
    Managed FortiSwitch port where NAC device is last learned.
    LastKnownSwitch string
    Managed FortiSwitch where NAC device is last learned.
    LastSeen int
    Device last seen.
    Mac string
    MAC address of the learned NAC device.
    MacPolicy string
    MAC policy to be applied on this learned NAC device.
    MatchedNacPolicy string
    Matched NAC policy for the learned NAC device.
    PortPolicy string
    Port policy to be applied on this learned NAC device.
    Status string
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Description string
    Description for the learned NAC device.
    Fosid int
    Device ID.
    LastKnownPort string
    Managed FortiSwitch port where NAC device is last learned.
    LastKnownSwitch string
    Managed FortiSwitch where NAC device is last learned.
    LastSeen int
    Device last seen.
    Mac string
    MAC address of the learned NAC device.
    MacPolicy string
    MAC policy to be applied on this learned NAC device.
    MatchedNacPolicy string
    Matched NAC policy for the learned NAC device.
    PortPolicy string
    Port policy to be applied on this learned NAC device.
    Status string
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    description String
    Description for the learned NAC device.
    fosid Integer
    Device ID.
    lastKnownPort String
    Managed FortiSwitch port where NAC device is last learned.
    lastKnownSwitch String
    Managed FortiSwitch where NAC device is last learned.
    lastSeen Integer
    Device last seen.
    mac String
    MAC address of the learned NAC device.
    macPolicy String
    MAC policy to be applied on this learned NAC device.
    matchedNacPolicy String
    Matched NAC policy for the learned NAC device.
    portPolicy String
    Port policy to be applied on this learned NAC device.
    status String
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    description string
    Description for the learned NAC device.
    fosid number
    Device ID.
    lastKnownPort string
    Managed FortiSwitch port where NAC device is last learned.
    lastKnownSwitch string
    Managed FortiSwitch where NAC device is last learned.
    lastSeen number
    Device last seen.
    mac string
    MAC address of the learned NAC device.
    macPolicy string
    MAC policy to be applied on this learned NAC device.
    matchedNacPolicy string
    Matched NAC policy for the learned NAC device.
    portPolicy string
    Port policy to be applied on this learned NAC device.
    status string
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    description str
    Description for the learned NAC device.
    fosid int
    Device ID.
    last_known_port str
    Managed FortiSwitch port where NAC device is last learned.
    last_known_switch str
    Managed FortiSwitch where NAC device is last learned.
    last_seen int
    Device last seen.
    mac str
    MAC address of the learned NAC device.
    mac_policy str
    MAC policy to be applied on this learned NAC device.
    matched_nac_policy str
    Matched NAC policy for the learned NAC device.
    port_policy str
    Port policy to be applied on this learned NAC device.
    status str
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    description String
    Description for the learned NAC device.
    fosid Number
    Device ID.
    lastKnownPort String
    Managed FortiSwitch port where NAC device is last learned.
    lastKnownSwitch String
    Managed FortiSwitch where NAC device is last learned.
    lastSeen Number
    Device last seen.
    mac String
    MAC address of the learned NAC device.
    macPolicy String
    MAC policy to be applied on this learned NAC device.
    matchedNacPolicy String
    Matched NAC policy for the learned NAC device.
    portPolicy String
    Port policy to be applied on this learned NAC device.
    status String
    Status of the learned NAC device. Set enable to authorize the NAC device. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Import

    SwitchController NacDevice can be imported using any of these accepted formats:

    $ pulumi import fortios:switchcontroller/nacdevice:Nacdevice labelname {{fosid}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/nacdevice:Nacdevice labelname {{fosid}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse