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

fortios.router/bgp.getNeighborlist

Explore with Pulumi AI

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

Provides a list of fortios.router/bgp.Neighbor.

Example Usage

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

const sample1 = fortios.router.bgp.getNeighborlist({});
export const output1 = sample1.then(sample1 => sample1.iplists);
Copy
import pulumi
import pulumi_fortios as fortios

sample1 = fortios.router.bgp.get_neighborlist()
pulumi.export("output1", sample1.iplists)
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/router"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		sample1, err := router.GetNeighborlist(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("output1", sample1.Iplists)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumi.Fortios;

return await Deployment.RunAsync(() => 
{
    var sample1 = Fortios.Router.Bgp.GetNeighborlist.Invoke();

    return new Dictionary<string, object?>
    {
        ["output1"] = sample1.Apply(getNeighborlistResult => getNeighborlistResult.Iplists),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.router_bgp.Router_bgpFunctions;
import com.pulumi.fortios.router.inputs.GetNeighborlistArgs;
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) {
        final var sample1 = Router/bgpFunctions.getNeighborlist();

        ctx.export("output1", sample1.applyValue(getNeighborlistResult -> getNeighborlistResult.iplists()));
    }
}
Copy
variables:
  sample1:
    fn::invoke:
      Function: fortios:router/bgp:getNeighborlist
      Arguments: {}
outputs:
  output1: ${sample1.iplists}
Copy

Using getNeighborlist

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 getNeighborlist(args: GetNeighborlistArgs, opts?: InvokeOptions): Promise<GetNeighborlistResult>
function getNeighborlistOutput(args: GetNeighborlistOutputArgs, opts?: InvokeOptions): Output<GetNeighborlistResult>
Copy
def get_neighborlist(filter: Optional[str] = None,
                     vdomparam: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetNeighborlistResult
def get_neighborlist_output(filter: Optional[pulumi.Input[str]] = None,
                     vdomparam: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetNeighborlistResult]
Copy
func GetNeighborlist(ctx *Context, args *GetNeighborlistArgs, opts ...InvokeOption) (*GetNeighborlistResult, error)
func GetNeighborlistOutput(ctx *Context, args *GetNeighborlistOutputArgs, opts ...InvokeOption) GetNeighborlistResultOutput
Copy

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

public static class GetNeighborlist 
{
    public static Task<GetNeighborlistResult> InvokeAsync(GetNeighborlistArgs args, InvokeOptions? opts = null)
    public static Output<GetNeighborlistResult> Invoke(GetNeighborlistInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNeighborlistResult> getNeighborlist(GetNeighborlistArgs args, InvokeOptions options)
public static Output<GetNeighborlistResult> getNeighborlist(GetNeighborlistArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: fortios:router/bgp/getNeighborlist:getNeighborlist
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Filter string
A filter used to scope the list. See Filter results of datasource.
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.
Filter string
A filter used to scope the list. See Filter results of datasource.
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.
filter String
A filter used to scope the list. See Filter results of datasource.
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.
filter string
A filter used to scope the list. See Filter results of datasource.
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.
filter str
A filter used to scope the list. See Filter results of datasource.
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.
filter String
A filter used to scope the list. See Filter results of datasource.
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.

getNeighborlist Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Iplists List<string>
A list of the fortios.router/bgp.Neighbor.
Filter string
Vdomparam string
Id string
The provider-assigned unique ID for this managed resource.
Iplists []string
A list of the fortios.router/bgp.Neighbor.
Filter string
Vdomparam string
id String
The provider-assigned unique ID for this managed resource.
iplists List<String>
A list of the fortios.router/bgp.Neighbor.
filter String
vdomparam String
id string
The provider-assigned unique ID for this managed resource.
iplists string[]
A list of the fortios.router/bgp.Neighbor.
filter string
vdomparam string
id str
The provider-assigned unique ID for this managed resource.
iplists Sequence[str]
A list of the fortios.router/bgp.Neighbor.
filter str
vdomparam str
id String
The provider-assigned unique ID for this managed resource.
iplists List<String>
A list of the fortios.router/bgp.Neighbor.
filter String
vdomparam String

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