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

fortios.system/snmp.getCommunity

Explore with Pulumi AI

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

    Use this data source to get information on an fortios systemsnmp community

    Using getCommunity

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCommunity(args: GetCommunityArgs, opts?: InvokeOptions): Promise<GetCommunityResult>
    function getCommunityOutput(args: GetCommunityOutputArgs, opts?: InvokeOptions): Output<GetCommunityResult>
    def get_community(fosid: Optional[int] = None,
                      vdomparam: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCommunityResult
    def get_community_output(fosid: Optional[pulumi.Input[int]] = None,
                      vdomparam: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCommunityResult]
    func LookupCommunity(ctx *Context, args *LookupCommunityArgs, opts ...InvokeOption) (*LookupCommunityResult, error)
    func LookupCommunityOutput(ctx *Context, args *LookupCommunityOutputArgs, opts ...InvokeOption) LookupCommunityResultOutput

    > Note: This function is named LookupCommunity in the Go SDK.

    public static class GetCommunity 
    {
        public static Task<GetCommunityResult> InvokeAsync(GetCommunityArgs args, InvokeOptions? opts = null)
        public static Output<GetCommunityResult> Invoke(GetCommunityInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCommunityResult> getCommunity(GetCommunityArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: fortios:system/snmp/getCommunity:getCommunity
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Fosid int
    Specify the fosid of the desired systemsnmp community.
    Vdomparam string
    Specifies the vdom to which the data source 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.
    Fosid int
    Specify the fosid of the desired systemsnmp community.
    Vdomparam string
    Specifies the vdom to which the data source 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.
    fosid Integer
    Specify the fosid of the desired systemsnmp community.
    vdomparam String
    Specifies the vdom to which the data source 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.
    fosid number
    Specify the fosid of the desired systemsnmp community.
    vdomparam string
    Specifies the vdom to which the data source 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.
    fosid int
    Specify the fosid of the desired systemsnmp community.
    vdomparam str
    Specifies the vdom to which the data source 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.
    fosid Number
    Specify the fosid of the desired systemsnmp community.
    vdomparam String
    Specifies the vdom to which the data source 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.

    getCommunity Result

    The following output properties are available:

    Events string
    SNMP trap events.
    Fosid int
    Community ID.
    Hosts List<Pulumiverse.Fortios.System.Snmp.Outputs.GetCommunityHost>
    Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
    Hosts6s List<Pulumiverse.Fortios.System.Snmp.Outputs.GetCommunityHosts6>
    Configure IPv6 SNMP managers. The structure of hosts6 block is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    MibView string
    SNMP access control MIB view.
    Name string
    VDOM name
    QueryV1Port int
    SNMP v1 query port (default = 161).
    QueryV1Status string
    Enable/disable SNMP v1 queries.
    QueryV2cPort int
    SNMP v2c query port (default = 161).
    QueryV2cStatus string
    Enable/disable SNMP v2c queries.
    Status string
    Enable/disable this SNMP community.
    TrapV1Lport int
    SNMP v1 trap local port (default = 162).
    TrapV1Rport int
    SNMP v1 trap remote port (default = 162).
    TrapV1Status string
    Enable/disable SNMP v1 traps.
    TrapV2cLport int
    SNMP v2c trap local port (default = 162).
    TrapV2cRport int
    SNMP v2c trap remote port (default = 162).
    TrapV2cStatus string
    Enable/disable SNMP v2c traps.
    Vdoms List<Pulumiverse.Fortios.System.Snmp.Outputs.GetCommunityVdom>
    SNMP access control VDOMs. The structure of vdoms block is documented below.
    Vdomparam string
    Events string
    SNMP trap events.
    Fosid int
    Community ID.
    Hosts []GetCommunityHost
    Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
    Hosts6s []GetCommunityHosts6
    Configure IPv6 SNMP managers. The structure of hosts6 block is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    MibView string
    SNMP access control MIB view.
    Name string
    VDOM name
    QueryV1Port int
    SNMP v1 query port (default = 161).
    QueryV1Status string
    Enable/disable SNMP v1 queries.
    QueryV2cPort int
    SNMP v2c query port (default = 161).
    QueryV2cStatus string
    Enable/disable SNMP v2c queries.
    Status string
    Enable/disable this SNMP community.
    TrapV1Lport int
    SNMP v1 trap local port (default = 162).
    TrapV1Rport int
    SNMP v1 trap remote port (default = 162).
    TrapV1Status string
    Enable/disable SNMP v1 traps.
    TrapV2cLport int
    SNMP v2c trap local port (default = 162).
    TrapV2cRport int
    SNMP v2c trap remote port (default = 162).
    TrapV2cStatus string
    Enable/disable SNMP v2c traps.
    Vdoms []GetCommunityVdom
    SNMP access control VDOMs. The structure of vdoms block is documented below.
    Vdomparam string
    events String
    SNMP trap events.
    fosid Integer
    Community ID.
    hosts List<GetCommunityHost>
    Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
    hosts6s List<GetCommunityHosts6>
    Configure IPv6 SNMP managers. The structure of hosts6 block is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    mibView String
    SNMP access control MIB view.
    name String
    VDOM name
    queryV1Port Integer
    SNMP v1 query port (default = 161).
    queryV1Status String
    Enable/disable SNMP v1 queries.
    queryV2cPort Integer
    SNMP v2c query port (default = 161).
    queryV2cStatus String
    Enable/disable SNMP v2c queries.
    status String
    Enable/disable this SNMP community.
    trapV1Lport Integer
    SNMP v1 trap local port (default = 162).
    trapV1Rport Integer
    SNMP v1 trap remote port (default = 162).
    trapV1Status String
    Enable/disable SNMP v1 traps.
    trapV2cLport Integer
    SNMP v2c trap local port (default = 162).
    trapV2cRport Integer
    SNMP v2c trap remote port (default = 162).
    trapV2cStatus String
    Enable/disable SNMP v2c traps.
    vdoms List<GetCommunityVdom>
    SNMP access control VDOMs. The structure of vdoms block is documented below.
    vdomparam String
    events string
    SNMP trap events.
    fosid number
    Community ID.
    hosts GetCommunityHost[]
    Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
    hosts6s GetCommunityHosts6[]
    Configure IPv6 SNMP managers. The structure of hosts6 block is documented below.
    id string
    The provider-assigned unique ID for this managed resource.
    mibView string
    SNMP access control MIB view.
    name string
    VDOM name
    queryV1Port number
    SNMP v1 query port (default = 161).
    queryV1Status string
    Enable/disable SNMP v1 queries.
    queryV2cPort number
    SNMP v2c query port (default = 161).
    queryV2cStatus string
    Enable/disable SNMP v2c queries.
    status string
    Enable/disable this SNMP community.
    trapV1Lport number
    SNMP v1 trap local port (default = 162).
    trapV1Rport number
    SNMP v1 trap remote port (default = 162).
    trapV1Status string
    Enable/disable SNMP v1 traps.
    trapV2cLport number
    SNMP v2c trap local port (default = 162).
    trapV2cRport number
    SNMP v2c trap remote port (default = 162).
    trapV2cStatus string
    Enable/disable SNMP v2c traps.
    vdoms GetCommunityVdom[]
    SNMP access control VDOMs. The structure of vdoms block is documented below.
    vdomparam string
    events str
    SNMP trap events.
    fosid int
    Community ID.
    hosts Sequence[GetCommunityHost]
    Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
    hosts6s Sequence[GetCommunityHosts6]
    Configure IPv6 SNMP managers. The structure of hosts6 block is documented below.
    id str
    The provider-assigned unique ID for this managed resource.
    mib_view str
    SNMP access control MIB view.
    name str
    VDOM name
    query_v1_port int
    SNMP v1 query port (default = 161).
    query_v1_status str
    Enable/disable SNMP v1 queries.
    query_v2c_port int
    SNMP v2c query port (default = 161).
    query_v2c_status str
    Enable/disable SNMP v2c queries.
    status str
    Enable/disable this SNMP community.
    trap_v1_lport int
    SNMP v1 trap local port (default = 162).
    trap_v1_rport int
    SNMP v1 trap remote port (default = 162).
    trap_v1_status str
    Enable/disable SNMP v1 traps.
    trap_v2c_lport int
    SNMP v2c trap local port (default = 162).
    trap_v2c_rport int
    SNMP v2c trap remote port (default = 162).
    trap_v2c_status str
    Enable/disable SNMP v2c traps.
    vdoms Sequence[GetCommunityVdom]
    SNMP access control VDOMs. The structure of vdoms block is documented below.
    vdomparam str
    events String
    SNMP trap events.
    fosid Number
    Community ID.
    hosts List<Property Map>
    Configure IPv4 SNMP managers (hosts). The structure of hosts block is documented below.
    hosts6s List<Property Map>
    Configure IPv6 SNMP managers. The structure of hosts6 block is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    mibView String
    SNMP access control MIB view.
    name String
    VDOM name
    queryV1Port Number
    SNMP v1 query port (default = 161).
    queryV1Status String
    Enable/disable SNMP v1 queries.
    queryV2cPort Number
    SNMP v2c query port (default = 161).
    queryV2cStatus String
    Enable/disable SNMP v2c queries.
    status String
    Enable/disable this SNMP community.
    trapV1Lport Number
    SNMP v1 trap local port (default = 162).
    trapV1Rport Number
    SNMP v1 trap remote port (default = 162).
    trapV1Status String
    Enable/disable SNMP v1 traps.
    trapV2cLport Number
    SNMP v2c trap local port (default = 162).
    trapV2cRport Number
    SNMP v2c trap remote port (default = 162).
    trapV2cStatus String
    Enable/disable SNMP v2c traps.
    vdoms List<Property Map>
    SNMP access control VDOMs. The structure of vdoms block is documented below.
    vdomparam String

    Supporting Types

    GetCommunityHost

    HaDirect string
    Enable/disable direct management of HA cluster members.
    HostType string
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    Id int
    Host6 entry ID.
    Ip string
    IPv4 address of the SNMP manager (host).
    SourceIp string
    Source IPv4 address for SNMP traps.
    HaDirect string
    Enable/disable direct management of HA cluster members.
    HostType string
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    Id int
    Host6 entry ID.
    Ip string
    IPv4 address of the SNMP manager (host).
    SourceIp string
    Source IPv4 address for SNMP traps.
    haDirect String
    Enable/disable direct management of HA cluster members.
    hostType String
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    id Integer
    Host6 entry ID.
    ip String
    IPv4 address of the SNMP manager (host).
    sourceIp String
    Source IPv4 address for SNMP traps.
    haDirect string
    Enable/disable direct management of HA cluster members.
    hostType string
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    id number
    Host6 entry ID.
    ip string
    IPv4 address of the SNMP manager (host).
    sourceIp string
    Source IPv4 address for SNMP traps.
    ha_direct str
    Enable/disable direct management of HA cluster members.
    host_type str
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    id int
    Host6 entry ID.
    ip str
    IPv4 address of the SNMP manager (host).
    source_ip str
    Source IPv4 address for SNMP traps.
    haDirect String
    Enable/disable direct management of HA cluster members.
    hostType String
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    id Number
    Host6 entry ID.
    ip String
    IPv4 address of the SNMP manager (host).
    sourceIp String
    Source IPv4 address for SNMP traps.

    GetCommunityHosts6

    HaDirect string
    Enable/disable direct management of HA cluster members.
    HostType string
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    Id int
    Host6 entry ID.
    Ipv6 string
    SNMP manager IPv6 address prefix.
    SourceIpv6 string
    Source IPv6 address for SNMP traps.
    HaDirect string
    Enable/disable direct management of HA cluster members.
    HostType string
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    Id int
    Host6 entry ID.
    Ipv6 string
    SNMP manager IPv6 address prefix.
    SourceIpv6 string
    Source IPv6 address for SNMP traps.
    haDirect String
    Enable/disable direct management of HA cluster members.
    hostType String
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    id Integer
    Host6 entry ID.
    ipv6 String
    SNMP manager IPv6 address prefix.
    sourceIpv6 String
    Source IPv6 address for SNMP traps.
    haDirect string
    Enable/disable direct management of HA cluster members.
    hostType string
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    id number
    Host6 entry ID.
    ipv6 string
    SNMP manager IPv6 address prefix.
    sourceIpv6 string
    Source IPv6 address for SNMP traps.
    ha_direct str
    Enable/disable direct management of HA cluster members.
    host_type str
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    id int
    Host6 entry ID.
    ipv6 str
    SNMP manager IPv6 address prefix.
    source_ipv6 str
    Source IPv6 address for SNMP traps.
    haDirect String
    Enable/disable direct management of HA cluster members.
    hostType String
    Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
    id Number
    Host6 entry ID.
    ipv6 String
    SNMP manager IPv6 address prefix.
    sourceIpv6 String
    Source IPv6 address for SNMP traps.

    GetCommunityVdom

    Name string
    VDOM name
    Name string
    VDOM name
    name String
    VDOM name
    name string
    VDOM name
    name str
    VDOM name
    name String
    VDOM name

    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