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

fortios.router/ospf.Neighbor

Explore with Pulumi AI

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

    OSPF neighbor configuration are used when OSPF runs on non-broadcast media

    The provider supports the definition of Neighbor in Router Ospf fortios.router.Ospf, and also allows the definition of separate Neighbor resources fortios.router/ospf.Neighbor, but do not use a fortios.router.Ospf with in-line Neighbor in conjunction with any fortios.router/ospf.Neighbor resources, otherwise conflicts and overwrite will occur.

    Create Neighbor Resource

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

    Constructor syntax

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

@overload
def Neighbor(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             cost: Optional[int] = None,
             fosid: Optional[int] = None,
             ip: Optional[str] = None,
             poll_interval: Optional[int] = None,
             priority: Optional[int] = None,
             vdomparam: Optional[str] = None)
    func NewNeighbor(ctx *Context, name string, args *NeighborArgs, opts ...ResourceOption) (*Neighbor, error)
    public Neighbor(string name, NeighborArgs? args = null, CustomResourceOptions? opts = null)
    public Neighbor(String name, NeighborArgs args)
public Neighbor(String name, NeighborArgs args, CustomResourceOptions options)

    type: fortios:router/ospf/neighbor:Neighbor
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 NeighborArgs
    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 NeighborArgs
    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 NeighborArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NeighborArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NeighborArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Cost int
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    Fosid int
    Neighbor entry ID.
    Ip string
    Interface IP address of the neighbor.
    PollInterval int
    Poll interval time in seconds.
    Priority int
    Priority.
    Vdomparam 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.
    Cost int
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    Fosid int
    Neighbor entry ID.
    Ip string
    Interface IP address of the neighbor.
    PollInterval int
    Poll interval time in seconds.
    Priority int
    Priority.
    Vdomparam 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.
    cost Integer
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    fosid Integer
    Neighbor entry ID.
    ip String
    Interface IP address of the neighbor.
    pollInterval Integer
    Poll interval time in seconds.
    priority Integer
    Priority.
    vdomparam 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.
    cost number
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    fosid number
    Neighbor entry ID.
    ip string
    Interface IP address of the neighbor.
    pollInterval number
    Poll interval time in seconds.
    priority number
    Priority.
    vdomparam 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.
    cost int
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    fosid int
    Neighbor entry ID.
    ip str
    Interface IP address of the neighbor.
    poll_interval int
    Poll interval time in seconds.
    priority int
    Priority.
    vdomparam 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.
    cost Number
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    fosid Number
    Neighbor entry ID.
    ip String
    Interface IP address of the neighbor.
    pollInterval Number
    Poll interval time in seconds.
    priority Number
    Priority.
    vdomparam 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 Neighbor 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 Neighbor Resource

    Get an existing Neighbor 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?: NeighborState, opts?: CustomResourceOptions): Neighbor
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cost: Optional[int] = None,
        fosid: Optional[int] = None,
        ip: Optional[str] = None,
        poll_interval: Optional[int] = None,
        priority: Optional[int] = None,
        vdomparam: Optional[str] = None) -> Neighbor
    func GetNeighbor(ctx *Context, name string, id IDInput, state *NeighborState, opts ...ResourceOption) (*Neighbor, error)
    public static Neighbor Get(string name, Input<string> id, NeighborState? state, CustomResourceOptions? opts = null)
    public static Neighbor get(String name, Output<String> id, NeighborState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Cost int
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    Fosid int
    Neighbor entry ID.
    Ip string
    Interface IP address of the neighbor.
    PollInterval int
    Poll interval time in seconds.
    Priority int
    Priority.
    Vdomparam 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.
    Cost int
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    Fosid int
    Neighbor entry ID.
    Ip string
    Interface IP address of the neighbor.
    PollInterval int
    Poll interval time in seconds.
    Priority int
    Priority.
    Vdomparam 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.
    cost Integer
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    fosid Integer
    Neighbor entry ID.
    ip String
    Interface IP address of the neighbor.
    pollInterval Integer
    Poll interval time in seconds.
    priority Integer
    Priority.
    vdomparam 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.
    cost number
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    fosid number
    Neighbor entry ID.
    ip string
    Interface IP address of the neighbor.
    pollInterval number
    Poll interval time in seconds.
    priority number
    Priority.
    vdomparam 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.
    cost int
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    fosid int
    Neighbor entry ID.
    ip str
    Interface IP address of the neighbor.
    poll_interval int
    Poll interval time in seconds.
    priority int
    Priority.
    vdomparam 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.
    cost Number
    Cost of the interface, value range from 0 to 65535, 0 means auto-cost.
    fosid Number
    Neighbor entry ID.
    ip String
    Interface IP address of the neighbor.
    pollInterval Number
    Poll interval time in seconds.
    priority Number
    Priority.
    vdomparam 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

    Routerospf Neighbor can be imported using any of these accepted formats:

    $ pulumi import fortios:router/ospf/neighbor:Neighbor labelname {{fosid}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:router/ospf/neighbor:Neighbor labelname {{fosid}}

    $ 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 logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios