Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectSwitchcontrollerMacpolicy
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectSwitchcontrollerMacpolicy

Explore with Pulumi AI

fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

Configure MAC policy to be applied on the managed FortiSwitch devices through NAC device.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortimanager from "@pulumi/fortimanager";

const trname = new fortimanager.ObjectSwitchcontrollerMacpolicy("trname", {
    description: "This is a Terraform example",
    vlan: "1-A1",
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.ObjectSwitchcontrollerMacpolicy("trname",
    description="This is a Terraform example",
    vlan="1-A1")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewObjectSwitchcontrollerMacpolicy(ctx, "trname", &fortimanager.ObjectSwitchcontrollerMacpolicyArgs{
			Description: pulumi.String("This is a Terraform example"),
			Vlan:        pulumi.String("1-A1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.ObjectSwitchcontrollerMacpolicy("trname", new()
    {
        Description = "This is a Terraform example",
        Vlan = "1-A1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.ObjectSwitchcontrollerMacpolicy;
import com.pulumi.fortimanager.ObjectSwitchcontrollerMacpolicyArgs;
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 trname = new ObjectSwitchcontrollerMacpolicy("trname", ObjectSwitchcontrollerMacpolicyArgs.builder()
            .description("This is a Terraform example")
            .vlan("1-A1")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortimanager:ObjectSwitchcontrollerMacpolicy
    properties:
      description: This is a Terraform example
      vlan: 1-A1
Copy

Create ObjectSwitchcontrollerMacpolicy Resource

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

Constructor syntax

new ObjectSwitchcontrollerMacpolicy(name: string, args?: ObjectSwitchcontrollerMacpolicyArgs, opts?: CustomResourceOptions);
@overload
def ObjectSwitchcontrollerMacpolicy(resource_name: str,
                                    args: Optional[ObjectSwitchcontrollerMacpolicyArgs] = None,
                                    opts: Optional[ResourceOptions] = None)

@overload
def ObjectSwitchcontrollerMacpolicy(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    adom: Optional[str] = None,
                                    bounce_port_link: Optional[str] = None,
                                    description: Optional[str] = None,
                                    drop: Optional[str] = None,
                                    fmgcount: Optional[str] = None,
                                    name: Optional[str] = None,
                                    object_switchcontroller_macpolicy_id: Optional[str] = None,
                                    scopetype: Optional[str] = None,
                                    traffic_policy: Optional[str] = None,
                                    vlan: Optional[str] = None)
func NewObjectSwitchcontrollerMacpolicy(ctx *Context, name string, args *ObjectSwitchcontrollerMacpolicyArgs, opts ...ResourceOption) (*ObjectSwitchcontrollerMacpolicy, error)
public ObjectSwitchcontrollerMacpolicy(string name, ObjectSwitchcontrollerMacpolicyArgs? args = null, CustomResourceOptions? opts = null)
public ObjectSwitchcontrollerMacpolicy(String name, ObjectSwitchcontrollerMacpolicyArgs args)
public ObjectSwitchcontrollerMacpolicy(String name, ObjectSwitchcontrollerMacpolicyArgs args, CustomResourceOptions options)

type: fortimanager:ObjectSwitchcontrollerMacpolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ObjectSwitchcontrollerMacpolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ObjectSwitchcontrollerMacpolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ObjectSwitchcontrollerMacpolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ObjectSwitchcontrollerMacpolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ObjectSwitchcontrollerMacpolicyArgs
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 objectSwitchcontrollerMacpolicyResource = new Fortimanager.ObjectSwitchcontrollerMacpolicy("objectSwitchcontrollerMacpolicyResource", new()
{
    Adom = "string",
    BouncePortLink = "string",
    Description = "string",
    Drop = "string",
    Fmgcount = "string",
    Name = "string",
    ObjectSwitchcontrollerMacpolicyId = "string",
    Scopetype = "string",
    TrafficPolicy = "string",
    Vlan = "string",
});
Copy
example, err := fortimanager.NewObjectSwitchcontrollerMacpolicy(ctx, "objectSwitchcontrollerMacpolicyResource", &fortimanager.ObjectSwitchcontrollerMacpolicyArgs{
Adom: pulumi.String("string"),
BouncePortLink: pulumi.String("string"),
Description: pulumi.String("string"),
Drop: pulumi.String("string"),
Fmgcount: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectSwitchcontrollerMacpolicyId: pulumi.String("string"),
Scopetype: pulumi.String("string"),
TrafficPolicy: pulumi.String("string"),
Vlan: pulumi.String("string"),
})
Copy
var objectSwitchcontrollerMacpolicyResource = new ObjectSwitchcontrollerMacpolicy("objectSwitchcontrollerMacpolicyResource", ObjectSwitchcontrollerMacpolicyArgs.builder()
    .adom("string")
    .bouncePortLink("string")
    .description("string")
    .drop("string")
    .fmgcount("string")
    .name("string")
    .objectSwitchcontrollerMacpolicyId("string")
    .scopetype("string")
    .trafficPolicy("string")
    .vlan("string")
    .build());
Copy
object_switchcontroller_macpolicy_resource = fortimanager.ObjectSwitchcontrollerMacpolicy("objectSwitchcontrollerMacpolicyResource",
    adom="string",
    bounce_port_link="string",
    description="string",
    drop="string",
    fmgcount="string",
    name="string",
    object_switchcontroller_macpolicy_id="string",
    scopetype="string",
    traffic_policy="string",
    vlan="string")
Copy
const objectSwitchcontrollerMacpolicyResource = new fortimanager.ObjectSwitchcontrollerMacpolicy("objectSwitchcontrollerMacpolicyResource", {
    adom: "string",
    bouncePortLink: "string",
    description: "string",
    drop: "string",
    fmgcount: "string",
    name: "string",
    objectSwitchcontrollerMacpolicyId: "string",
    scopetype: "string",
    trafficPolicy: "string",
    vlan: "string",
});
Copy
type: fortimanager:ObjectSwitchcontrollerMacpolicy
properties:
    adom: string
    bouncePortLink: string
    description: string
    drop: string
    fmgcount: string
    name: string
    objectSwitchcontrollerMacpolicyId: string
    scopetype: string
    trafficPolicy: string
    vlan: string
Copy

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

Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
BouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
Description string
Description for the MAC policy.
Drop string
Drop. Valid values: disable, enable.
Fmgcount string
Enable/disable packet count on the NAC device. Valid values: disable, enable.
Name string
MAC policy name.
ObjectSwitchcontrollerMacpolicyId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
TrafficPolicy string
Traffic policy to be applied when using this MAC policy.
Vlan string
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
BouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
Description string
Description for the MAC policy.
Drop string
Drop. Valid values: disable, enable.
Fmgcount string
Enable/disable packet count on the NAC device. Valid values: disable, enable.
Name string
MAC policy name.
ObjectSwitchcontrollerMacpolicyId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
TrafficPolicy string
Traffic policy to be applied when using this MAC policy.
Vlan string
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
bouncePortLink String
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
description String
Description for the MAC policy.
drop String
Drop. Valid values: disable, enable.
fmgcount String
Enable/disable packet count on the NAC device. Valid values: disable, enable.
name String
MAC policy name.
objectSwitchcontrollerMacpolicyId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
trafficPolicy String
Traffic policy to be applied when using this MAC policy.
vlan String
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
bouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
description string
Description for the MAC policy.
drop string
Drop. Valid values: disable, enable.
fmgcount string
Enable/disable packet count on the NAC device. Valid values: disable, enable.
name string
MAC policy name.
objectSwitchcontrollerMacpolicyId string
an identifier for the resource with format {{name}}.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
trafficPolicy string
Traffic policy to be applied when using this MAC policy.
vlan string
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
bounce_port_link str
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
description str
Description for the MAC policy.
drop str
Drop. Valid values: disable, enable.
fmgcount str
Enable/disable packet count on the NAC device. Valid values: disable, enable.
name str
MAC policy name.
object_switchcontroller_macpolicy_id str
an identifier for the resource with format {{name}}.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
traffic_policy str
Traffic policy to be applied when using this MAC policy.
vlan str
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
bouncePortLink String
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
description String
Description for the MAC policy.
drop String
Drop. Valid values: disable, enable.
fmgcount String
Enable/disable packet count on the NAC device. Valid values: disable, enable.
name String
MAC policy name.
objectSwitchcontrollerMacpolicyId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
trafficPolicy String
Traffic policy to be applied when using this MAC policy.
vlan String
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.

Outputs

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

Get an existing ObjectSwitchcontrollerMacpolicy 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?: ObjectSwitchcontrollerMacpolicyState, opts?: CustomResourceOptions): ObjectSwitchcontrollerMacpolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        bounce_port_link: Optional[str] = None,
        description: Optional[str] = None,
        drop: Optional[str] = None,
        fmgcount: Optional[str] = None,
        name: Optional[str] = None,
        object_switchcontroller_macpolicy_id: Optional[str] = None,
        scopetype: Optional[str] = None,
        traffic_policy: Optional[str] = None,
        vlan: Optional[str] = None) -> ObjectSwitchcontrollerMacpolicy
func GetObjectSwitchcontrollerMacpolicy(ctx *Context, name string, id IDInput, state *ObjectSwitchcontrollerMacpolicyState, opts ...ResourceOption) (*ObjectSwitchcontrollerMacpolicy, error)
public static ObjectSwitchcontrollerMacpolicy Get(string name, Input<string> id, ObjectSwitchcontrollerMacpolicyState? state, CustomResourceOptions? opts = null)
public static ObjectSwitchcontrollerMacpolicy get(String name, Output<String> id, ObjectSwitchcontrollerMacpolicyState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:ObjectSwitchcontrollerMacpolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
BouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
Description string
Description for the MAC policy.
Drop string
Drop. Valid values: disable, enable.
Fmgcount string
Enable/disable packet count on the NAC device. Valid values: disable, enable.
Name string
MAC policy name.
ObjectSwitchcontrollerMacpolicyId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
TrafficPolicy string
Traffic policy to be applied when using this MAC policy.
Vlan string
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
BouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
Description string
Description for the MAC policy.
Drop string
Drop. Valid values: disable, enable.
Fmgcount string
Enable/disable packet count on the NAC device. Valid values: disable, enable.
Name string
MAC policy name.
ObjectSwitchcontrollerMacpolicyId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
TrafficPolicy string
Traffic policy to be applied when using this MAC policy.
Vlan string
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
bouncePortLink String
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
description String
Description for the MAC policy.
drop String
Drop. Valid values: disable, enable.
fmgcount String
Enable/disable packet count on the NAC device. Valid values: disable, enable.
name String
MAC policy name.
objectSwitchcontrollerMacpolicyId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
trafficPolicy String
Traffic policy to be applied when using this MAC policy.
vlan String
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
bouncePortLink string
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
description string
Description for the MAC policy.
drop string
Drop. Valid values: disable, enable.
fmgcount string
Enable/disable packet count on the NAC device. Valid values: disable, enable.
name string
MAC policy name.
objectSwitchcontrollerMacpolicyId string
an identifier for the resource with format {{name}}.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
trafficPolicy string
Traffic policy to be applied when using this MAC policy.
vlan string
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
bounce_port_link str
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
description str
Description for the MAC policy.
drop str
Drop. Valid values: disable, enable.
fmgcount str
Enable/disable packet count on the NAC device. Valid values: disable, enable.
name str
MAC policy name.
object_switchcontroller_macpolicy_id str
an identifier for the resource with format {{name}}.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
traffic_policy str
Traffic policy to be applied when using this MAC policy.
vlan str
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
bouncePortLink String
Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. Valid values: disable, enable.
description String
Description for the MAC policy.
drop String
Drop. Valid values: disable, enable.
fmgcount String
Enable/disable packet count on the NAC device. Valid values: disable, enable.
name String
MAC policy name.
objectSwitchcontrollerMacpolicyId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
trafficPolicy String
Traffic policy to be applied when using this MAC policy.
vlan String
Ingress traffic VLAN assignment for the MAC address matching this MAC policy.

Import

ObjectSwitchController MacPolicy can be imported using any of these accepted formats:

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/objectSwitchcontrollerMacpolicy:ObjectSwitchcontrollerMacpolicy labelname {{name}}
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

-> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

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

Package Details

Repository
fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes
This Pulumi package is based on the fortimanager Terraform Provider.
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager