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

fortios.switchcontroller.Macsyncsettings

Explore with Pulumi AI

Configure global MAC synchronization settings. Applies to FortiOS Version <= 6.2.0.

Create Macsyncsettings Resource

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

Constructor syntax

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

@overload
def Macsyncsettings(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    mac_sync_interval: Optional[int] = None,
                    vdomparam: Optional[str] = None)
func NewMacsyncsettings(ctx *Context, name string, args *MacsyncsettingsArgs, opts ...ResourceOption) (*Macsyncsettings, error)
public Macsyncsettings(string name, MacsyncsettingsArgs? args = null, CustomResourceOptions? opts = null)
public Macsyncsettings(String name, MacsyncsettingsArgs args)
public Macsyncsettings(String name, MacsyncsettingsArgs args, CustomResourceOptions options)
type: fortios:switchcontroller:Macsyncsettings
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 MacsyncsettingsArgs
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 MacsyncsettingsArgs
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 MacsyncsettingsArgs
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 MacsyncsettingsArgs
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. MacsyncsettingsArgs
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 macsyncsettingsResource = new Fortios.Switchcontroller.Macsyncsettings("macsyncsettingsResource", new()
{
    MacSyncInterval = 0,
    Vdomparam = "string",
});
Copy
example, err := switchcontroller.NewMacsyncsettings(ctx, "macsyncsettingsResource", &switchcontroller.MacsyncsettingsArgs{
	MacSyncInterval: pulumi.Int(0),
	Vdomparam:       pulumi.String("string"),
})
Copy
var macsyncsettingsResource = new Macsyncsettings("macsyncsettingsResource", MacsyncsettingsArgs.builder()
    .macSyncInterval(0)
    .vdomparam("string")
    .build());
Copy
macsyncsettings_resource = fortios.switchcontroller.Macsyncsettings("macsyncsettingsResource",
    mac_sync_interval=0,
    vdomparam="string")
Copy
const macsyncsettingsResource = new fortios.switchcontroller.Macsyncsettings("macsyncsettingsResource", {
    macSyncInterval: 0,
    vdomparam: "string",
});
Copy
type: fortios:switchcontroller:Macsyncsettings
properties:
    macSyncInterval: 0
    vdomparam: string
Copy

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

MacSyncInterval int
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
Vdomparam Changes to this property will trigger replacement. 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.
MacSyncInterval int
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
Vdomparam Changes to this property will trigger replacement. 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.
macSyncInterval Integer
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
vdomparam Changes to this property will trigger replacement. 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.
macSyncInterval number
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
vdomparam Changes to this property will trigger replacement. 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.
mac_sync_interval int
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
vdomparam Changes to this property will trigger replacement. 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.
macSyncInterval Number
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
vdomparam Changes to this property will trigger replacement. 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 Macsyncsettings 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 Macsyncsettings Resource

Get an existing Macsyncsettings 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?: MacsyncsettingsState, opts?: CustomResourceOptions): Macsyncsettings
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        mac_sync_interval: Optional[int] = None,
        vdomparam: Optional[str] = None) -> Macsyncsettings
func GetMacsyncsettings(ctx *Context, name string, id IDInput, state *MacsyncsettingsState, opts ...ResourceOption) (*Macsyncsettings, error)
public static Macsyncsettings Get(string name, Input<string> id, MacsyncsettingsState? state, CustomResourceOptions? opts = null)
public static Macsyncsettings get(String name, Output<String> id, MacsyncsettingsState state, CustomResourceOptions options)
resources:  _:    type: fortios:switchcontroller:Macsyncsettings    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:
MacSyncInterval int
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
Vdomparam Changes to this property will trigger replacement. 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.
MacSyncInterval int
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
Vdomparam Changes to this property will trigger replacement. 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.
macSyncInterval Integer
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
vdomparam Changes to this property will trigger replacement. 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.
macSyncInterval number
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
vdomparam Changes to this property will trigger replacement. 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.
mac_sync_interval int
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
vdomparam Changes to this property will trigger replacement. 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.
macSyncInterval Number
Time interval between MAC synchronizations (30 - 1800 sec, default = 60, 0 = disable MAC synchronization).
vdomparam Changes to this property will trigger replacement. 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 MacSyncSettings can be imported using any of these accepted formats:

$ pulumi import fortios:switchcontroller/macsyncsettings:Macsyncsettings labelname SwitchControllerMacSyncSettings
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:switchcontroller/macsyncsettings:Macsyncsettings labelname SwitchControllerMacSyncSettings
Copy

$ 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.