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

fortios.router.getCommunitylist

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

Use this data source to get information on an fortios router communitylist

Using getCommunitylist

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 getCommunitylist(args: GetCommunitylistArgs, opts?: InvokeOptions): Promise<GetCommunitylistResult>
function getCommunitylistOutput(args: GetCommunitylistOutputArgs, opts?: InvokeOptions): Output<GetCommunitylistResult>
Copy
def get_communitylist(name: Optional[str] = None,
                      vdomparam: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCommunitylistResult
def get_communitylist_output(name: Optional[pulumi.Input[str]] = None,
                      vdomparam: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCommunitylistResult]
Copy
func LookupCommunitylist(ctx *Context, args *LookupCommunitylistArgs, opts ...InvokeOption) (*LookupCommunitylistResult, error)
func LookupCommunitylistOutput(ctx *Context, args *LookupCommunitylistOutputArgs, opts ...InvokeOption) LookupCommunitylistResultOutput
Copy

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

public static class GetCommunitylist 
{
    public static Task<GetCommunitylistResult> InvokeAsync(GetCommunitylistArgs args, InvokeOptions? opts = null)
    public static Output<GetCommunitylistResult> Invoke(GetCommunitylistInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCommunitylistResult> getCommunitylist(GetCommunitylistArgs args, InvokeOptions options)
public static Output<GetCommunitylistResult> getCommunitylist(GetCommunitylistArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: fortios:router/getCommunitylist:getCommunitylist
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Specify the name of the desired router communitylist.
Vdomparam Changes to this property will trigger replacement. 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.
Name This property is required. string
Specify the name of the desired router communitylist.
Vdomparam Changes to this property will trigger replacement. 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.
name This property is required. String
Specify the name of the desired router communitylist.
vdomparam Changes to this property will trigger replacement. 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.
name This property is required. string
Specify the name of the desired router communitylist.
vdomparam Changes to this property will trigger replacement. 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.
name This property is required. str
Specify the name of the desired router communitylist.
vdomparam Changes to this property will trigger replacement. 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.
name This property is required. String
Specify the name of the desired router communitylist.
vdomparam Changes to this property will trigger replacement. 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.

getCommunitylist Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Name string
Community list name.
Rules List<Pulumiverse.Fortios.Router.Outputs.GetCommunitylistRule>
Community list rule. The structure of rule block is documented below.
Type string
Community list type (standard or expanded).
Vdomparam string
Id string
The provider-assigned unique ID for this managed resource.
Name string
Community list name.
Rules []GetCommunitylistRule
Community list rule. The structure of rule block is documented below.
Type string
Community list type (standard or expanded).
Vdomparam string
id String
The provider-assigned unique ID for this managed resource.
name String
Community list name.
rules List<GetCommunitylistRule>
Community list rule. The structure of rule block is documented below.
type String
Community list type (standard or expanded).
vdomparam String
id string
The provider-assigned unique ID for this managed resource.
name string
Community list name.
rules GetCommunitylistRule[]
Community list rule. The structure of rule block is documented below.
type string
Community list type (standard or expanded).
vdomparam string
id str
The provider-assigned unique ID for this managed resource.
name str
Community list name.
rules Sequence[GetCommunitylistRule]
Community list rule. The structure of rule block is documented below.
type str
Community list type (standard or expanded).
vdomparam str
id String
The provider-assigned unique ID for this managed resource.
name String
Community list name.
rules List<Property Map>
Community list rule. The structure of rule block is documented below.
type String
Community list type (standard or expanded).
vdomparam String

Supporting Types

GetCommunitylistRule

Action This property is required. string
Permit or deny route-based operations, based on the route's COMMUNITY attribute.
Id This property is required. int
ID.
Match This property is required. string
Community specifications for matching a reserved community.
Regexp This property is required. string
Ordered list of COMMUNITY attributes as a regular expression.
Action This property is required. string
Permit or deny route-based operations, based on the route's COMMUNITY attribute.
Id This property is required. int
ID.
Match This property is required. string
Community specifications for matching a reserved community.
Regexp This property is required. string
Ordered list of COMMUNITY attributes as a regular expression.
action This property is required. String
Permit or deny route-based operations, based on the route's COMMUNITY attribute.
id This property is required. Integer
ID.
match This property is required. String
Community specifications for matching a reserved community.
regexp This property is required. String
Ordered list of COMMUNITY attributes as a regular expression.
action This property is required. string
Permit or deny route-based operations, based on the route's COMMUNITY attribute.
id This property is required. number
ID.
match This property is required. string
Community specifications for matching a reserved community.
regexp This property is required. string
Ordered list of COMMUNITY attributes as a regular expression.
action This property is required. str
Permit or deny route-based operations, based on the route's COMMUNITY attribute.
id This property is required. int
ID.
match This property is required. str
Community specifications for matching a reserved community.
regexp This property is required. str
Ordered list of COMMUNITY attributes as a regular expression.
action This property is required. String
Permit or deny route-based operations, based on the route's COMMUNITY attribute.
id This property is required. Number
ID.
match This property is required. String
Community specifications for matching a reserved community.
regexp This property is required. String
Ordered list of COMMUNITY attributes as a regular expression.

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