Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. system/snmp
  6. Sysinfo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system/snmp.Sysinfo

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

SNMP system info configuration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.system.snmp.Sysinfo("trname", {
    status: "disable",
    trapHighCpuThreshold: 80,
    trapLogFullThreshold: 90,
    trapLowMemoryThreshold: 80,
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.snmp.Sysinfo("trname",
    status="disable",
    trap_high_cpu_threshold=80,
    trap_log_full_threshold=90,
    trap_low_memory_threshold=80)
Copy
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.NewSysinfo(ctx, "trname", &system.SysinfoArgs{
			Status:                 pulumi.String("disable"),
			TrapHighCpuThreshold:   pulumi.Int(80),
			TrapLogFullThreshold:   pulumi.Int(90),
			TrapLowMemoryThreshold: pulumi.Int(80),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.System.Snmp.Sysinfo("trname", new()
    {
        Status = "disable",
        TrapHighCpuThreshold = 80,
        TrapLogFullThreshold = 90,
        TrapLowMemoryThreshold = 80,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Sysinfo;
import com.pulumi.fortios.system.SysinfoArgs;
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 Sysinfo("trname", SysinfoArgs.builder()
            .status("disable")
            .trapHighCpuThreshold(80)
            .trapLogFullThreshold(90)
            .trapLowMemoryThreshold(80)
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:system/snmp:Sysinfo
    properties:
      status: disable
      trapHighCpuThreshold: 80
      trapLogFullThreshold: 90
      trapLowMemoryThreshold: 80
Copy

Create Sysinfo Resource

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

Constructor syntax

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

@overload
def Sysinfo(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            append_index: Optional[str] = None,
            contact_info: Optional[str] = None,
            description: Optional[str] = None,
            engine_id: Optional[str] = None,
            engine_id_type: Optional[str] = None,
            location: Optional[str] = None,
            status: Optional[str] = None,
            trap_free_memory_threshold: Optional[int] = None,
            trap_freeable_memory_threshold: Optional[int] = None,
            trap_high_cpu_threshold: Optional[int] = None,
            trap_log_full_threshold: Optional[int] = None,
            trap_low_memory_threshold: Optional[int] = None,
            vdomparam: Optional[str] = None)
func NewSysinfo(ctx *Context, name string, args *SysinfoArgs, opts ...ResourceOption) (*Sysinfo, error)
public Sysinfo(string name, SysinfoArgs? args = null, CustomResourceOptions? opts = null)
public Sysinfo(String name, SysinfoArgs args)
public Sysinfo(String name, SysinfoArgs args, CustomResourceOptions options)

type: fortios:system/snmp/sysinfo:Sysinfo
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 SysinfoArgs
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 SysinfoArgs
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 SysinfoArgs
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 SysinfoArgs
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. SysinfoArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

AppendIndex string
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
ContactInfo string
Contact information.
Description string
System description.
EngineId string
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
EngineIdType string
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
Location string
System location.
Status string
Enable/disable SNMP. Valid values: enable, disable.
TrapFreeMemoryThreshold int
Free memory usage when trap is sent.
TrapFreeableMemoryThreshold int
Freeable memory usage when trap is sent.
TrapHighCpuThreshold int
CPU usage when trap is sent.
TrapLogFullThreshold int
Log disk usage when trap is sent.
TrapLowMemoryThreshold int
Memory usage when trap is sent.
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.
AppendIndex string
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
ContactInfo string
Contact information.
Description string
System description.
EngineId string
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
EngineIdType string
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
Location string
System location.
Status string
Enable/disable SNMP. Valid values: enable, disable.
TrapFreeMemoryThreshold int
Free memory usage when trap is sent.
TrapFreeableMemoryThreshold int
Freeable memory usage when trap is sent.
TrapHighCpuThreshold int
CPU usage when trap is sent.
TrapLogFullThreshold int
Log disk usage when trap is sent.
TrapLowMemoryThreshold int
Memory usage when trap is sent.
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.
appendIndex String
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
contactInfo String
Contact information.
description String
System description.
engineId String
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
engineIdType String
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
location String
System location.
status String
Enable/disable SNMP. Valid values: enable, disable.
trapFreeMemoryThreshold Integer
Free memory usage when trap is sent.
trapFreeableMemoryThreshold Integer
Freeable memory usage when trap is sent.
trapHighCpuThreshold Integer
CPU usage when trap is sent.
trapLogFullThreshold Integer
Log disk usage when trap is sent.
trapLowMemoryThreshold Integer
Memory usage when trap is sent.
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.
appendIndex string
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
contactInfo string
Contact information.
description string
System description.
engineId string
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
engineIdType string
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
location string
System location.
status string
Enable/disable SNMP. Valid values: enable, disable.
trapFreeMemoryThreshold number
Free memory usage when trap is sent.
trapFreeableMemoryThreshold number
Freeable memory usage when trap is sent.
trapHighCpuThreshold number
CPU usage when trap is sent.
trapLogFullThreshold number
Log disk usage when trap is sent.
trapLowMemoryThreshold number
Memory usage when trap is sent.
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.
append_index str
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
contact_info str
Contact information.
description str
System description.
engine_id str
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
engine_id_type str
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
location str
System location.
status str
Enable/disable SNMP. Valid values: enable, disable.
trap_free_memory_threshold int
Free memory usage when trap is sent.
trap_freeable_memory_threshold int
Freeable memory usage when trap is sent.
trap_high_cpu_threshold int
CPU usage when trap is sent.
trap_log_full_threshold int
Log disk usage when trap is sent.
trap_low_memory_threshold int
Memory usage when trap is sent.
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.
appendIndex String
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
contactInfo String
Contact information.
description String
System description.
engineId String
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
engineIdType String
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
location String
System location.
status String
Enable/disable SNMP. Valid values: enable, disable.
trapFreeMemoryThreshold Number
Free memory usage when trap is sent.
trapFreeableMemoryThreshold Number
Freeable memory usage when trap is sent.
trapHighCpuThreshold Number
CPU usage when trap is sent.
trapLogFullThreshold Number
Log disk usage when trap is sent.
trapLowMemoryThreshold Number
Memory usage when trap is sent.
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 Sysinfo 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 Sysinfo Resource

Get an existing Sysinfo 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?: SysinfoState, opts?: CustomResourceOptions): Sysinfo
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        append_index: Optional[str] = None,
        contact_info: Optional[str] = None,
        description: Optional[str] = None,
        engine_id: Optional[str] = None,
        engine_id_type: Optional[str] = None,
        location: Optional[str] = None,
        status: Optional[str] = None,
        trap_free_memory_threshold: Optional[int] = None,
        trap_freeable_memory_threshold: Optional[int] = None,
        trap_high_cpu_threshold: Optional[int] = None,
        trap_log_full_threshold: Optional[int] = None,
        trap_low_memory_threshold: Optional[int] = None,
        vdomparam: Optional[str] = None) -> Sysinfo
func GetSysinfo(ctx *Context, name string, id IDInput, state *SysinfoState, opts ...ResourceOption) (*Sysinfo, error)
public static Sysinfo Get(string name, Input<string> id, SysinfoState? state, CustomResourceOptions? opts = null)
public static Sysinfo get(String name, Output<String> id, SysinfoState state, CustomResourceOptions options)
resources:  _:    type: fortios:system/snmp/sysinfo:Sysinfo    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:
AppendIndex string
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
ContactInfo string
Contact information.
Description string
System description.
EngineId string
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
EngineIdType string
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
Location string
System location.
Status string
Enable/disable SNMP. Valid values: enable, disable.
TrapFreeMemoryThreshold int
Free memory usage when trap is sent.
TrapFreeableMemoryThreshold int
Freeable memory usage when trap is sent.
TrapHighCpuThreshold int
CPU usage when trap is sent.
TrapLogFullThreshold int
Log disk usage when trap is sent.
TrapLowMemoryThreshold int
Memory usage when trap is sent.
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.
AppendIndex string
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
ContactInfo string
Contact information.
Description string
System description.
EngineId string
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
EngineIdType string
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
Location string
System location.
Status string
Enable/disable SNMP. Valid values: enable, disable.
TrapFreeMemoryThreshold int
Free memory usage when trap is sent.
TrapFreeableMemoryThreshold int
Freeable memory usage when trap is sent.
TrapHighCpuThreshold int
CPU usage when trap is sent.
TrapLogFullThreshold int
Log disk usage when trap is sent.
TrapLowMemoryThreshold int
Memory usage when trap is sent.
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.
appendIndex String
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
contactInfo String
Contact information.
description String
System description.
engineId String
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
engineIdType String
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
location String
System location.
status String
Enable/disable SNMP. Valid values: enable, disable.
trapFreeMemoryThreshold Integer
Free memory usage when trap is sent.
trapFreeableMemoryThreshold Integer
Freeable memory usage when trap is sent.
trapHighCpuThreshold Integer
CPU usage when trap is sent.
trapLogFullThreshold Integer
Log disk usage when trap is sent.
trapLowMemoryThreshold Integer
Memory usage when trap is sent.
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.
appendIndex string
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
contactInfo string
Contact information.
description string
System description.
engineId string
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
engineIdType string
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
location string
System location.
status string
Enable/disable SNMP. Valid values: enable, disable.
trapFreeMemoryThreshold number
Free memory usage when trap is sent.
trapFreeableMemoryThreshold number
Freeable memory usage when trap is sent.
trapHighCpuThreshold number
CPU usage when trap is sent.
trapLogFullThreshold number
Log disk usage when trap is sent.
trapLowMemoryThreshold number
Memory usage when trap is sent.
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.
append_index str
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
contact_info str
Contact information.
description str
System description.
engine_id str
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
engine_id_type str
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
location str
System location.
status str
Enable/disable SNMP. Valid values: enable, disable.
trap_free_memory_threshold int
Free memory usage when trap is sent.
trap_freeable_memory_threshold int
Freeable memory usage when trap is sent.
trap_high_cpu_threshold int
CPU usage when trap is sent.
trap_log_full_threshold int
Log disk usage when trap is sent.
trap_low_memory_threshold int
Memory usage when trap is sent.
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.
appendIndex String
Enable/disable allowance of appending VDOM or interface index in some RFC tables. Valid values: enable, disable.
contactInfo String
Contact information.
description String
System description.
engineId String
Local SNMP engineID string. On FortiOS versions 6.2.0-7.0.0: maximum 24 characters. On FortiOS versions >= 7.0.1: maximum 27 characters.
engineIdType String
Local SNMP engineID type (text/hex/mac). Valid values: text, hex, mac.
location String
System location.
status String
Enable/disable SNMP. Valid values: enable, disable.
trapFreeMemoryThreshold Number
Free memory usage when trap is sent.
trapFreeableMemoryThreshold Number
Freeable memory usage when trap is sent.
trapHighCpuThreshold Number
CPU usage when trap is sent.
trapLogFullThreshold Number
Log disk usage when trap is sent.
trapLowMemoryThreshold Number
Memory usage when trap is sent.
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

SystemSnmp Sysinfo can be imported using any of these accepted formats:

$ pulumi import fortios:system/snmp/sysinfo:Sysinfo labelname SystemSnmpSysinfo
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/snmp/sysinfo:Sysinfo labelname SystemSnmpSysinfo
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.
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios