Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. WantempSystemSdwanNeighbor
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.WantempSystemSdwanNeighbor

Explore with Pulumi AI

fortimanager logo
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

    Create SD-WAN neighbor from BGP neighbor table to control route advertisements according to SLA status.

    This resource is a sub resource for variable neighbor of resource fortimanager.WantempSystemSdwan. Conflict and overwrite may occur if use both of them.

    Create WantempSystemSdwanNeighbor Resource

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

    Constructor syntax

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

@overload
def WantempSystemSdwanNeighbor(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               ip: Optional[str] = None,
                               wanprof: Optional[str] = None,
                               adom: Optional[str] = None,
                               health_check: Optional[str] = None,
                               member: Optional[str] = None,
                               minimum_sla_meet_members: Optional[float] = None,
                               mode: Optional[str] = None,
                               role: Optional[str] = None,
                               scopetype: Optional[str] = None,
                               service_id: Optional[str] = None,
                               sla_id: Optional[float] = None,
                               wantemp_system_sdwan_neighbor_id: Optional[str] = None)
    func NewWantempSystemSdwanNeighbor(ctx *Context, name string, args WantempSystemSdwanNeighborArgs, opts ...ResourceOption) (*WantempSystemSdwanNeighbor, error)
    public WantempSystemSdwanNeighbor(string name, WantempSystemSdwanNeighborArgs args, CustomResourceOptions? opts = null)
    public WantempSystemSdwanNeighbor(String name, WantempSystemSdwanNeighborArgs args)
public WantempSystemSdwanNeighbor(String name, WantempSystemSdwanNeighborArgs args, CustomResourceOptions options)

    type: fortimanager:WantempSystemSdwanNeighbor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WantempSystemSdwanNeighborArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WantempSystemSdwanNeighborInitArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WantempSystemSdwanNeighborArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WantempSystemSdwanNeighborArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WantempSystemSdwanNeighborArgs
    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 wantempSystemSdwanNeighborResource = new Fortimanager.WantempSystemSdwanNeighbor("wantempSystemSdwanNeighborResource", new()
{
    Ip = "string",
    Wanprof = "string",
    Adom = "string",
    HealthCheck = "string",
    Member = "string",
    MinimumSlaMeetMembers = 0,
    Mode = "string",
    Role = "string",
    Scopetype = "string",
    ServiceId = "string",
    SlaId = 0,
    WantempSystemSdwanNeighborId = "string",
});

    example, err := fortimanager.NewWantempSystemSdwanNeighbor(ctx, "wantempSystemSdwanNeighborResource", &fortimanager.WantempSystemSdwanNeighborArgs{
Ip: pulumi.String("string"),
Wanprof: pulumi.String("string"),
Adom: pulumi.String("string"),
HealthCheck: pulumi.String("string"),
Member: pulumi.String("string"),
MinimumSlaMeetMembers: pulumi.Float64(0),
Mode: pulumi.String("string"),
Role: pulumi.String("string"),
Scopetype: pulumi.String("string"),
ServiceId: pulumi.String("string"),
SlaId: pulumi.Float64(0),
WantempSystemSdwanNeighborId: pulumi.String("string"),
})

    var wantempSystemSdwanNeighborResource = new WantempSystemSdwanNeighbor("wantempSystemSdwanNeighborResource", WantempSystemSdwanNeighborArgs.builder()
    .ip("string")
    .wanprof("string")
    .adom("string")
    .healthCheck("string")
    .member("string")
    .minimumSlaMeetMembers(0)
    .mode("string")
    .role("string")
    .scopetype("string")
    .serviceId("string")
    .slaId(0)
    .wantempSystemSdwanNeighborId("string")
    .build());

    wantemp_system_sdwan_neighbor_resource = fortimanager.WantempSystemSdwanNeighbor("wantempSystemSdwanNeighborResource",
    ip="string",
    wanprof="string",
    adom="string",
    health_check="string",
    member="string",
    minimum_sla_meet_members=0,
    mode="string",
    role="string",
    scopetype="string",
    service_id="string",
    sla_id=0,
    wantemp_system_sdwan_neighbor_id="string")

    const wantempSystemSdwanNeighborResource = new fortimanager.WantempSystemSdwanNeighbor("wantempSystemSdwanNeighborResource", {
    ip: "string",
    wanprof: "string",
    adom: "string",
    healthCheck: "string",
    member: "string",
    minimumSlaMeetMembers: 0,
    mode: "string",
    role: "string",
    scopetype: "string",
    serviceId: "string",
    slaId: 0,
    wantempSystemSdwanNeighborId: "string",
});

    type: fortimanager:WantempSystemSdwanNeighbor
properties:
    adom: string
    healthCheck: string
    ip: string
    member: string
    minimumSlaMeetMembers: 0
    mode: string
    role: string
    scopetype: string
    serviceId: string
    slaId: 0
    wanprof: string
    wantempSystemSdwanNeighborId: string

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

    Ip string
    IP/IPv6 address of neighbor.
    Wanprof string
    Wanprof.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    HealthCheck string
    SD-WAN health-check name.
    Member string
    Member sequence number.
    MinimumSlaMeetMembers double
    Minimum number of members which meet SLA when the neighbor is preferred.
    Mode string
    What metric to select the neighbor. Valid values: sla, speedtest.
    Role string
    Role of neighbor. Valid values: primary, secondary, standalone.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServiceId string
    SD-WAN service ID to work with the neighbor.
    SlaId double
    SLA ID.
    WantempSystemSdwanNeighborId string
    an identifier for the resource with format {{ip}}.
    Ip string
    IP/IPv6 address of neighbor.
    Wanprof string
    Wanprof.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    HealthCheck string
    SD-WAN health-check name.
    Member string
    Member sequence number.
    MinimumSlaMeetMembers float64
    Minimum number of members which meet SLA when the neighbor is preferred.
    Mode string
    What metric to select the neighbor. Valid values: sla, speedtest.
    Role string
    Role of neighbor. Valid values: primary, secondary, standalone.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServiceId string
    SD-WAN service ID to work with the neighbor.
    SlaId float64
    SLA ID.
    WantempSystemSdwanNeighborId string
    an identifier for the resource with format {{ip}}.
    ip String
    IP/IPv6 address of neighbor.
    wanprof String
    Wanprof.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    healthCheck String
    SD-WAN health-check name.
    member String
    Member sequence number.
    minimumSlaMeetMembers Double
    Minimum number of members which meet SLA when the neighbor is preferred.
    mode String
    What metric to select the neighbor. Valid values: sla, speedtest.
    role String
    Role of neighbor. Valid values: primary, secondary, standalone.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serviceId String
    SD-WAN service ID to work with the neighbor.
    slaId Double
    SLA ID.
    wantempSystemSdwanNeighborId String
    an identifier for the resource with format {{ip}}.
    ip string
    IP/IPv6 address of neighbor.
    wanprof string
    Wanprof.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    healthCheck string
    SD-WAN health-check name.
    member string
    Member sequence number.
    minimumSlaMeetMembers number
    Minimum number of members which meet SLA when the neighbor is preferred.
    mode string
    What metric to select the neighbor. Valid values: sla, speedtest.
    role string
    Role of neighbor. Valid values: primary, secondary, standalone.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serviceId string
    SD-WAN service ID to work with the neighbor.
    slaId number
    SLA ID.
    wantempSystemSdwanNeighborId string
    an identifier for the resource with format {{ip}}.
    ip str
    IP/IPv6 address of neighbor.
    wanprof str
    Wanprof.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    health_check str
    SD-WAN health-check name.
    member str
    Member sequence number.
    minimum_sla_meet_members float
    Minimum number of members which meet SLA when the neighbor is preferred.
    mode str
    What metric to select the neighbor. Valid values: sla, speedtest.
    role str
    Role of neighbor. Valid values: primary, secondary, standalone.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    service_id str
    SD-WAN service ID to work with the neighbor.
    sla_id float
    SLA ID.
    wantemp_system_sdwan_neighbor_id str
    an identifier for the resource with format {{ip}}.
    ip String
    IP/IPv6 address of neighbor.
    wanprof String
    Wanprof.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    healthCheck String
    SD-WAN health-check name.
    member String
    Member sequence number.
    minimumSlaMeetMembers Number
    Minimum number of members which meet SLA when the neighbor is preferred.
    mode String
    What metric to select the neighbor. Valid values: sla, speedtest.
    role String
    Role of neighbor. Valid values: primary, secondary, standalone.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serviceId String
    SD-WAN service ID to work with the neighbor.
    slaId Number
    SLA ID.
    wantempSystemSdwanNeighborId String
    an identifier for the resource with format {{ip}}.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WantempSystemSdwanNeighbor 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 WantempSystemSdwanNeighbor Resource

    Get an existing WantempSystemSdwanNeighbor 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?: WantempSystemSdwanNeighborState, opts?: CustomResourceOptions): WantempSystemSdwanNeighbor
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        health_check: Optional[str] = None,
        ip: Optional[str] = None,
        member: Optional[str] = None,
        minimum_sla_meet_members: Optional[float] = None,
        mode: Optional[str] = None,
        role: Optional[str] = None,
        scopetype: Optional[str] = None,
        service_id: Optional[str] = None,
        sla_id: Optional[float] = None,
        wanprof: Optional[str] = None,
        wantemp_system_sdwan_neighbor_id: Optional[str] = None) -> WantempSystemSdwanNeighbor
    func GetWantempSystemSdwanNeighbor(ctx *Context, name string, id IDInput, state *WantempSystemSdwanNeighborState, opts ...ResourceOption) (*WantempSystemSdwanNeighbor, error)
    public static WantempSystemSdwanNeighbor Get(string name, Input<string> id, WantempSystemSdwanNeighborState? state, CustomResourceOptions? opts = null)
    public static WantempSystemSdwanNeighbor get(String name, Output<String> id, WantempSystemSdwanNeighborState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:WantempSystemSdwanNeighbor    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    HealthCheck string
    SD-WAN health-check name.
    Ip string
    IP/IPv6 address of neighbor.
    Member string
    Member sequence number.
    MinimumSlaMeetMembers double
    Minimum number of members which meet SLA when the neighbor is preferred.
    Mode string
    What metric to select the neighbor. Valid values: sla, speedtest.
    Role string
    Role of neighbor. Valid values: primary, secondary, standalone.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServiceId string
    SD-WAN service ID to work with the neighbor.
    SlaId double
    SLA ID.
    Wanprof string
    Wanprof.
    WantempSystemSdwanNeighborId string
    an identifier for the resource with format {{ip}}.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    HealthCheck string
    SD-WAN health-check name.
    Ip string
    IP/IPv6 address of neighbor.
    Member string
    Member sequence number.
    MinimumSlaMeetMembers float64
    Minimum number of members which meet SLA when the neighbor is preferred.
    Mode string
    What metric to select the neighbor. Valid values: sla, speedtest.
    Role string
    Role of neighbor. Valid values: primary, secondary, standalone.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServiceId string
    SD-WAN service ID to work with the neighbor.
    SlaId float64
    SLA ID.
    Wanprof string
    Wanprof.
    WantempSystemSdwanNeighborId string
    an identifier for the resource with format {{ip}}.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    healthCheck String
    SD-WAN health-check name.
    ip String
    IP/IPv6 address of neighbor.
    member String
    Member sequence number.
    minimumSlaMeetMembers Double
    Minimum number of members which meet SLA when the neighbor is preferred.
    mode String
    What metric to select the neighbor. Valid values: sla, speedtest.
    role String
    Role of neighbor. Valid values: primary, secondary, standalone.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serviceId String
    SD-WAN service ID to work with the neighbor.
    slaId Double
    SLA ID.
    wanprof String
    Wanprof.
    wantempSystemSdwanNeighborId String
    an identifier for the resource with format {{ip}}.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    healthCheck string
    SD-WAN health-check name.
    ip string
    IP/IPv6 address of neighbor.
    member string
    Member sequence number.
    minimumSlaMeetMembers number
    Minimum number of members which meet SLA when the neighbor is preferred.
    mode string
    What metric to select the neighbor. Valid values: sla, speedtest.
    role string
    Role of neighbor. Valid values: primary, secondary, standalone.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serviceId string
    SD-WAN service ID to work with the neighbor.
    slaId number
    SLA ID.
    wanprof string
    Wanprof.
    wantempSystemSdwanNeighborId string
    an identifier for the resource with format {{ip}}.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    health_check str
    SD-WAN health-check name.
    ip str
    IP/IPv6 address of neighbor.
    member str
    Member sequence number.
    minimum_sla_meet_members float
    Minimum number of members which meet SLA when the neighbor is preferred.
    mode str
    What metric to select the neighbor. Valid values: sla, speedtest.
    role str
    Role of neighbor. Valid values: primary, secondary, standalone.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    service_id str
    SD-WAN service ID to work with the neighbor.
    sla_id float
    SLA ID.
    wanprof str
    Wanprof.
    wantemp_system_sdwan_neighbor_id str
    an identifier for the resource with format {{ip}}.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    healthCheck String
    SD-WAN health-check name.
    ip String
    IP/IPv6 address of neighbor.
    member String
    Member sequence number.
    minimumSlaMeetMembers Number
    Minimum number of members which meet SLA when the neighbor is preferred.
    mode String
    What metric to select the neighbor. Valid values: sla, speedtest.
    role String
    Role of neighbor. Valid values: primary, secondary, standalone.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serviceId String
    SD-WAN service ID to work with the neighbor.
    slaId Number
    SLA ID.
    wanprof String
    Wanprof.
    wantempSystemSdwanNeighborId String
    an identifier for the resource with format {{ip}}.

    Import

    Wantemp SystemSdwanNeighbor can be imported using any of these accepted formats:

    Set import_options = [“wanprof=YOUR_VALUE”] in the provider section.

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/wantempSystemSdwanNeighbor:WantempSystemSdwanNeighbor labelname {{ip}}

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
    fortinetdev/terraform-provider-fortimanager