1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Hamonitor
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.system.Hamonitor

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    Configure HA monitor.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.system.Hamonitor("trname", {
        monitorVlan: "disable",
        vlanHbInterval: 5,
        vlanHbLostThreshold: 3,
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.system.Hamonitor("trname",
        monitor_vlan="disable",
        vlan_hb_interval=5,
        vlan_hb_lost_threshold=3)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := system.NewHamonitor(ctx, "trname", &system.HamonitorArgs{
    			MonitorVlan:         pulumi.String("disable"),
    			VlanHbInterval:      pulumi.Int(5),
    			VlanHbLostThreshold: pulumi.Int(3),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Fortios = Pulumiverse.Fortios;
    
    return await Deployment.RunAsync(() => 
    {
        var trname = new Fortios.System.Hamonitor("trname", new()
        {
            MonitorVlan = "disable",
            VlanHbInterval = 5,
            VlanHbLostThreshold = 3,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.system.Hamonitor;
    import com.pulumi.fortios.system.HamonitorArgs;
    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 Hamonitor("trname", HamonitorArgs.builder()        
                .monitorVlan("disable")
                .vlanHbInterval(5)
                .vlanHbLostThreshold(3)
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:system:Hamonitor
        properties:
          monitorVlan: disable
          vlanHbInterval: 5
          vlanHbLostThreshold: 3
    

    Create Hamonitor Resource

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

    Constructor syntax

    new Hamonitor(name: string, args?: HamonitorArgs, opts?: CustomResourceOptions);
    @overload
    def Hamonitor(resource_name: str,
                  args: Optional[HamonitorArgs] = None,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Hamonitor(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  monitor_vlan: Optional[str] = None,
                  vdomparam: Optional[str] = None,
                  vlan_hb_interval: Optional[int] = None,
                  vlan_hb_lost_threshold: Optional[int] = None)
    func NewHamonitor(ctx *Context, name string, args *HamonitorArgs, opts ...ResourceOption) (*Hamonitor, error)
    public Hamonitor(string name, HamonitorArgs? args = null, CustomResourceOptions? opts = null)
    public Hamonitor(String name, HamonitorArgs args)
    public Hamonitor(String name, HamonitorArgs args, CustomResourceOptions options)
    
    type: fortios:system:Hamonitor
    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 HamonitorArgs
    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 HamonitorArgs
    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 HamonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HamonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HamonitorArgs
    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 hamonitorResource = new Fortios.System.Hamonitor("hamonitorResource", new()
    {
        MonitorVlan = "string",
        Vdomparam = "string",
        VlanHbInterval = 0,
        VlanHbLostThreshold = 0,
    });
    
    example, err := system.NewHamonitor(ctx, "hamonitorResource", &system.HamonitorArgs{
    	MonitorVlan:         pulumi.String("string"),
    	Vdomparam:           pulumi.String("string"),
    	VlanHbInterval:      pulumi.Int(0),
    	VlanHbLostThreshold: pulumi.Int(0),
    })
    
    var hamonitorResource = new Hamonitor("hamonitorResource", HamonitorArgs.builder()
        .monitorVlan("string")
        .vdomparam("string")
        .vlanHbInterval(0)
        .vlanHbLostThreshold(0)
        .build());
    
    hamonitor_resource = fortios.system.Hamonitor("hamonitorResource",
        monitor_vlan="string",
        vdomparam="string",
        vlan_hb_interval=0,
        vlan_hb_lost_threshold=0)
    
    const hamonitorResource = new fortios.system.Hamonitor("hamonitorResource", {
        monitorVlan: "string",
        vdomparam: "string",
        vlanHbInterval: 0,
        vlanHbLostThreshold: 0,
    });
    
    type: fortios:system:Hamonitor
    properties:
        monitorVlan: string
        vdomparam: string
        vlanHbInterval: 0
        vlanHbLostThreshold: 0
    

    Hamonitor Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Hamonitor resource accepts the following input properties:

    MonitorVlan string
    Enable/disable monitor VLAN interfaces. 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.
    VlanHbInterval int
    Configure heartbeat interval (seconds).
    VlanHbLostThreshold int
    VLAN lost heartbeat threshold (1 - 60).
    MonitorVlan string
    Enable/disable monitor VLAN interfaces. 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.
    VlanHbInterval int
    Configure heartbeat interval (seconds).
    VlanHbLostThreshold int
    VLAN lost heartbeat threshold (1 - 60).
    monitorVlan String
    Enable/disable monitor VLAN interfaces. 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.
    vlanHbInterval Integer
    Configure heartbeat interval (seconds).
    vlanHbLostThreshold Integer
    VLAN lost heartbeat threshold (1 - 60).
    monitorVlan string
    Enable/disable monitor VLAN interfaces. 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.
    vlanHbInterval number
    Configure heartbeat interval (seconds).
    vlanHbLostThreshold number
    VLAN lost heartbeat threshold (1 - 60).
    monitor_vlan str
    Enable/disable monitor VLAN interfaces. 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.
    vlan_hb_interval int
    Configure heartbeat interval (seconds).
    vlan_hb_lost_threshold int
    VLAN lost heartbeat threshold (1 - 60).
    monitorVlan String
    Enable/disable monitor VLAN interfaces. 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.
    vlanHbInterval Number
    Configure heartbeat interval (seconds).
    vlanHbLostThreshold Number
    VLAN lost heartbeat threshold (1 - 60).

    Outputs

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

    Get an existing Hamonitor 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?: HamonitorState, opts?: CustomResourceOptions): Hamonitor
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            monitor_vlan: Optional[str] = None,
            vdomparam: Optional[str] = None,
            vlan_hb_interval: Optional[int] = None,
            vlan_hb_lost_threshold: Optional[int] = None) -> Hamonitor
    func GetHamonitor(ctx *Context, name string, id IDInput, state *HamonitorState, opts ...ResourceOption) (*Hamonitor, error)
    public static Hamonitor Get(string name, Input<string> id, HamonitorState? state, CustomResourceOptions? opts = null)
    public static Hamonitor get(String name, Output<String> id, HamonitorState 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:
    MonitorVlan string
    Enable/disable monitor VLAN interfaces. 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.
    VlanHbInterval int
    Configure heartbeat interval (seconds).
    VlanHbLostThreshold int
    VLAN lost heartbeat threshold (1 - 60).
    MonitorVlan string
    Enable/disable monitor VLAN interfaces. 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.
    VlanHbInterval int
    Configure heartbeat interval (seconds).
    VlanHbLostThreshold int
    VLAN lost heartbeat threshold (1 - 60).
    monitorVlan String
    Enable/disable monitor VLAN interfaces. 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.
    vlanHbInterval Integer
    Configure heartbeat interval (seconds).
    vlanHbLostThreshold Integer
    VLAN lost heartbeat threshold (1 - 60).
    monitorVlan string
    Enable/disable monitor VLAN interfaces. 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.
    vlanHbInterval number
    Configure heartbeat interval (seconds).
    vlanHbLostThreshold number
    VLAN lost heartbeat threshold (1 - 60).
    monitor_vlan str
    Enable/disable monitor VLAN interfaces. 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.
    vlan_hb_interval int
    Configure heartbeat interval (seconds).
    vlan_hb_lost_threshold int
    VLAN lost heartbeat threshold (1 - 60).
    monitorVlan String
    Enable/disable monitor VLAN interfaces. 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.
    vlanHbInterval Number
    Configure heartbeat interval (seconds).
    vlanHbLostThreshold Number
    VLAN lost heartbeat threshold (1 - 60).

    Import

    System HaMonitor can be imported using any of these accepted formats:

    $ pulumi import fortios:system/hamonitor:Hamonitor labelname SystemHaMonitor
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/hamonitor:Hamonitor labelname SystemHaMonitor
    

    $ 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.5 published on Tuesday, Apr 9, 2024 by pulumiverse