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

fortios.switchcontroller.Snmpsysinfo

Explore with Pulumi AI

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

Configure FortiSwitch SNMP system information globally. Applies to FortiOS Version >= 6.2.4.

Create Snmpsysinfo Resource

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

Constructor syntax

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

@overload
def Snmpsysinfo(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                contact_info: Optional[str] = None,
                description: Optional[str] = None,
                engine_id: Optional[str] = None,
                location: Optional[str] = None,
                status: Optional[str] = None,
                vdomparam: Optional[str] = None)
func NewSnmpsysinfo(ctx *Context, name string, args *SnmpsysinfoArgs, opts ...ResourceOption) (*Snmpsysinfo, error)
public Snmpsysinfo(string name, SnmpsysinfoArgs? args = null, CustomResourceOptions? opts = null)
public Snmpsysinfo(String name, SnmpsysinfoArgs args)
public Snmpsysinfo(String name, SnmpsysinfoArgs args, CustomResourceOptions options)

type: fortios:switchcontroller:Snmpsysinfo
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 SnmpsysinfoArgs
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 SnmpsysinfoArgs
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 SnmpsysinfoArgs
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 SnmpsysinfoArgs
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. SnmpsysinfoArgs
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 snmpsysinfoResource = new Fortios.Switchcontroller.Snmpsysinfo("snmpsysinfoResource", new()
{
    ContactInfo = "string",
    Description = "string",
    EngineId = "string",
    Location = "string",
    Status = "string",
    Vdomparam = "string",
});
Copy
example, err := switchcontroller.NewSnmpsysinfo(ctx, "snmpsysinfoResource", &switchcontroller.SnmpsysinfoArgs{
	ContactInfo: pulumi.String("string"),
	Description: pulumi.String("string"),
	EngineId:    pulumi.String("string"),
	Location:    pulumi.String("string"),
	Status:      pulumi.String("string"),
	Vdomparam:   pulumi.String("string"),
})
Copy
var snmpsysinfoResource = new Snmpsysinfo("snmpsysinfoResource", SnmpsysinfoArgs.builder()
    .contactInfo("string")
    .description("string")
    .engineId("string")
    .location("string")
    .status("string")
    .vdomparam("string")
    .build());
Copy
snmpsysinfo_resource = fortios.switchcontroller.Snmpsysinfo("snmpsysinfoResource",
    contact_info="string",
    description="string",
    engine_id="string",
    location="string",
    status="string",
    vdomparam="string")
Copy
const snmpsysinfoResource = new fortios.switchcontroller.Snmpsysinfo("snmpsysinfoResource", {
    contactInfo: "string",
    description: "string",
    engineId: "string",
    location: "string",
    status: "string",
    vdomparam: "string",
});
Copy
type: fortios:switchcontroller:Snmpsysinfo
properties:
    contactInfo: string
    description: string
    engineId: string
    location: string
    status: string
    vdomparam: string
Copy

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

ContactInfo string
Contact information.
Description string
System description.
EngineId string
Local SNMP engine ID string (max 24 char).
Location string
System location.
Status string
Enable/disable SNMP. Valid values: disable, enable.
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.
ContactInfo string
Contact information.
Description string
System description.
EngineId string
Local SNMP engine ID string (max 24 char).
Location string
System location.
Status string
Enable/disable SNMP. Valid values: disable, enable.
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.
contactInfo String
Contact information.
description String
System description.
engineId String
Local SNMP engine ID string (max 24 char).
location String
System location.
status String
Enable/disable SNMP. Valid values: disable, enable.
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.
contactInfo string
Contact information.
description string
System description.
engineId string
Local SNMP engine ID string (max 24 char).
location string
System location.
status string
Enable/disable SNMP. Valid values: disable, enable.
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.
contact_info str
Contact information.
description str
System description.
engine_id str
Local SNMP engine ID string (max 24 char).
location str
System location.
status str
Enable/disable SNMP. Valid values: disable, enable.
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.
contactInfo String
Contact information.
description String
System description.
engineId String
Local SNMP engine ID string (max 24 char).
location String
System location.
status String
Enable/disable SNMP. Valid values: disable, enable.
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 Snmpsysinfo 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 Snmpsysinfo Resource

Get an existing Snmpsysinfo 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?: SnmpsysinfoState, opts?: CustomResourceOptions): Snmpsysinfo
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        contact_info: Optional[str] = None,
        description: Optional[str] = None,
        engine_id: Optional[str] = None,
        location: Optional[str] = None,
        status: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Snmpsysinfo
func GetSnmpsysinfo(ctx *Context, name string, id IDInput, state *SnmpsysinfoState, opts ...ResourceOption) (*Snmpsysinfo, error)
public static Snmpsysinfo Get(string name, Input<string> id, SnmpsysinfoState? state, CustomResourceOptions? opts = null)
public static Snmpsysinfo get(String name, Output<String> id, SnmpsysinfoState state, CustomResourceOptions options)
resources:  _:    type: fortios:switchcontroller:Snmpsysinfo    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:
ContactInfo string
Contact information.
Description string
System description.
EngineId string
Local SNMP engine ID string (max 24 char).
Location string
System location.
Status string
Enable/disable SNMP. Valid values: disable, enable.
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.
ContactInfo string
Contact information.
Description string
System description.
EngineId string
Local SNMP engine ID string (max 24 char).
Location string
System location.
Status string
Enable/disable SNMP. Valid values: disable, enable.
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.
contactInfo String
Contact information.
description String
System description.
engineId String
Local SNMP engine ID string (max 24 char).
location String
System location.
status String
Enable/disable SNMP. Valid values: disable, enable.
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.
contactInfo string
Contact information.
description string
System description.
engineId string
Local SNMP engine ID string (max 24 char).
location string
System location.
status string
Enable/disable SNMP. Valid values: disable, enable.
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.
contact_info str
Contact information.
description str
System description.
engine_id str
Local SNMP engine ID string (max 24 char).
location str
System location.
status str
Enable/disable SNMP. Valid values: disable, enable.
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.
contactInfo String
Contact information.
description String
System description.
engineId String
Local SNMP engine ID string (max 24 char).
location String
System location.
status String
Enable/disable SNMP. Valid values: disable, enable.
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 SnmpSysinfo can be imported using any of these accepted formats:

$ pulumi import fortios:switchcontroller/snmpsysinfo:Snmpsysinfo labelname SwitchControllerSnmpSysinfo
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:switchcontroller/snmpsysinfo:Snmpsysinfo labelname SwitchControllerSnmpSysinfo
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