Docs Home
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
fortios.switchcontroller.Nacsettings
Explore with Pulumi AI
Configure integrated NAC settings for FortiSwitch. 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 Nacsettings Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Nacsettings(name: string, args?: NacsettingsArgs, opts?: CustomResourceOptions);@overload
def Nacsettings(resource_name: str,
args: Optional[NacsettingsArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Nacsettings(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_auth: Optional[str] = None,
bounce_nac_port: Optional[str] = None,
inactive_timer: Optional[int] = None,
link_down_flush: Optional[str] = None,
mode: Optional[str] = None,
name: Optional[str] = None,
onboarding_vlan: Optional[str] = None,
vdomparam: Optional[str] = None)func NewNacsettings(ctx *Context, name string, args *NacsettingsArgs, opts ...ResourceOption) (*Nacsettings, error)public Nacsettings(string name, NacsettingsArgs? args = null, CustomResourceOptions? opts = null)
public Nacsettings(String name, NacsettingsArgs args)
public Nacsettings(String name, NacsettingsArgs args, CustomResourceOptions options)
type: fortios:switchcontroller:Nacsettings
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 NacsettingsArgs
- 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 NacsettingsArgs
- 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 NacsettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NacsettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NacsettingsArgs
- 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 nacsettingsResource = new Fortios.Switchcontroller.Nacsettings("nacsettingsResource", new()
{
AutoAuth = "string",
BounceNacPort = "string",
InactiveTimer = 0,
LinkDownFlush = "string",
Mode = "string",
Name = "string",
OnboardingVlan = "string",
Vdomparam = "string",
});
example, err := switchcontroller.NewNacsettings(ctx, "nacsettingsResource", &switchcontroller.NacsettingsArgs{
AutoAuth: pulumi.String("string"),
BounceNacPort: pulumi.String("string"),
InactiveTimer: pulumi.Int(0),
LinkDownFlush: pulumi.String("string"),
Mode: pulumi.String("string"),
Name: pulumi.String("string"),
OnboardingVlan: pulumi.String("string"),
Vdomparam: pulumi.String("string"),
})
var nacsettingsResource = new Nacsettings("nacsettingsResource", NacsettingsArgs.builder()
.autoAuth("string")
.bounceNacPort("string")
.inactiveTimer(0)
.linkDownFlush("string")
.mode("string")
.name("string")
.onboardingVlan("string")
.vdomparam("string")
.build());
nacsettings_resource = fortios.switchcontroller.Nacsettings("nacsettingsResource",
auto_auth="string",
bounce_nac_port="string",
inactive_timer=0,
link_down_flush="string",
mode="string",
name="string",
onboarding_vlan="string",
vdomparam="string")
const nacsettingsResource = new fortios.switchcontroller.Nacsettings("nacsettingsResource", {
autoAuth: "string",
bounceNacPort: "string",
inactiveTimer: 0,
linkDownFlush: "string",
mode: "string",
name: "string",
onboardingVlan: "string",
vdomparam: "string",
});
type: fortios:switchcontroller:Nacsettings
properties:
autoAuth: string
bounceNacPort: string
inactiveTimer: 0
linkDownFlush: string
mode: string
name: string
onboardingVlan: string
vdomparam: string
Nacsettings 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 Nacsettings resource accepts the following input properties:
- Auto
Auth string - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - Bounce
Nac stringPort - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - Inactive
Timer int - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- Link
Down stringFlush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - Mode string
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - Name string
- NAC settings name.
- Onboarding
Vlan string - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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.
- Auto
Auth string - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - Bounce
Nac stringPort - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - Inactive
Timer int - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- Link
Down stringFlush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - Mode string
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - Name string
- NAC settings name.
- Onboarding
Vlan string - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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.
- auto
Auth String - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - bounce
Nac StringPort - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - inactive
Timer Integer - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- link
Down StringFlush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - mode String
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - name String
- NAC settings name.
- onboarding
Vlan String - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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.
- auto
Auth string - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - bounce
Nac stringPort - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - inactive
Timer number - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- link
Down stringFlush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - mode string
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - name string
- NAC settings name.
- onboarding
Vlan string - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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.
- auto_
auth str - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - bounce_
nac_ strport - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - inactive_
timer int - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- link_
down_ strflush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - mode str
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - name str
- NAC settings name.
- onboarding_
vlan str - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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.
- auto
Auth String - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - bounce
Nac StringPort - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - inactive
Timer Number - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- link
Down StringFlush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - mode String
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - name String
- NAC settings name.
- onboarding
Vlan String - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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 Nacsettings 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 Nacsettings Resource
Get an existing Nacsettings 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?: NacsettingsState, opts?: CustomResourceOptions): Nacsettings@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_auth: Optional[str] = None,
bounce_nac_port: Optional[str] = None,
inactive_timer: Optional[int] = None,
link_down_flush: Optional[str] = None,
mode: Optional[str] = None,
name: Optional[str] = None,
onboarding_vlan: Optional[str] = None,
vdomparam: Optional[str] = None) -> Nacsettingsfunc GetNacsettings(ctx *Context, name string, id IDInput, state *NacsettingsState, opts ...ResourceOption) (*Nacsettings, error)public static Nacsettings Get(string name, Input<string> id, NacsettingsState? state, CustomResourceOptions? opts = null)public static Nacsettings get(String name, Output<String> id, NacsettingsState 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.
- Auto
Auth string - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - Bounce
Nac stringPort - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - Inactive
Timer int - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- Link
Down stringFlush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - Mode string
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - Name string
- NAC settings name.
- Onboarding
Vlan string - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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.
- Auto
Auth string - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - Bounce
Nac stringPort - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - Inactive
Timer int - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- Link
Down stringFlush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - Mode string
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - Name string
- NAC settings name.
- Onboarding
Vlan string - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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.
- auto
Auth String - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - bounce
Nac StringPort - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - inactive
Timer Integer - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- link
Down StringFlush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - mode String
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - name String
- NAC settings name.
- onboarding
Vlan String - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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.
- auto
Auth string - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - bounce
Nac stringPort - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - inactive
Timer number - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- link
Down stringFlush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - mode string
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - name string
- NAC settings name.
- onboarding
Vlan string - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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.
- auto_
auth str - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - bounce_
nac_ strport - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - inactive_
timer int - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- link_
down_ strflush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - mode str
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - name str
- NAC settings name.
- onboarding_
vlan str - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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.
- auto
Auth String - Enable/disable NAC device auto authorization when discovered and nac-policy matched. Valid values:
disable,enable. - bounce
Nac StringPort - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. Valid values:
disable,enable. - inactive
Timer Number - Time interval(minutes, 0 = no expiry) to be included in the inactive NAC devices expiry calculation (mac age-out + inactive-time + periodic scan interval).
- link
Down StringFlush - Clear NAC devices on switch ports on link down event. Valid values:
disable,enable. - mode String
- Set NAC mode to be used on the FortiSwitch ports. Valid values:
local,global. - name String
- NAC settings name.
- onboarding
Vlan String - Default NAC Onboarding VLAN when NAC devices are discovered.
- 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 NacSettings can be imported using any of these accepted formats:
$ pulumi import fortios:switchcontroller/nacsettings:Nacsettings labelname {{name}}
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:switchcontroller/nacsettings:Nacsettings labelname {{name}}
$ 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
fortiosTerraform Provider.