fortios.router.Bfd
Explore with Pulumi AI
Configure BFD.
Create Bfd Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Bfd(name: string, args?: BfdArgs, opts?: CustomResourceOptions);
@overload
def Bfd(resource_name: str,
args: Optional[BfdArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Bfd(resource_name: str,
opts: Optional[ResourceOptions] = None,
dynamic_sort_subtable: Optional[str] = None,
get_all_tables: Optional[str] = None,
multihop_templates: Optional[Sequence[BfdMultihopTemplateArgs]] = None,
neighbors: Optional[Sequence[BfdNeighborArgs]] = None,
vdomparam: Optional[str] = None)
func NewBfd(ctx *Context, name string, args *BfdArgs, opts ...ResourceOption) (*Bfd, error)
public Bfd(string name, BfdArgs? args = null, CustomResourceOptions? opts = null)
type: fortios:router:Bfd
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 BfdArgs
- 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 BfdArgs
- 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 BfdArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BfdArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BfdArgs
- 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 bfdResource = new Fortios.Router.Bfd("bfdResource", new()
{
DynamicSortSubtable = "string",
GetAllTables = "string",
MultihopTemplates = new[]
{
new Fortios.Router.Inputs.BfdMultihopTemplateArgs
{
AuthMode = "string",
BfdDesiredMinTx = 0,
BfdDetectMult = 0,
BfdRequiredMinRx = 0,
Dst = "string",
Id = 0,
Md5Key = "string",
Src = "string",
},
},
Neighbors = new[]
{
new Fortios.Router.Inputs.BfdNeighborArgs
{
Interface = "string",
Ip = "string",
},
},
Vdomparam = "string",
});
example, err := router.NewBfd(ctx, "bfdResource", &router.BfdArgs{
DynamicSortSubtable: pulumi.String("string"),
GetAllTables: pulumi.String("string"),
MultihopTemplates: router.BfdMultihopTemplateArray{
&router.BfdMultihopTemplateArgs{
AuthMode: pulumi.String("string"),
BfdDesiredMinTx: pulumi.Int(0),
BfdDetectMult: pulumi.Int(0),
BfdRequiredMinRx: pulumi.Int(0),
Dst: pulumi.String("string"),
Id: pulumi.Int(0),
Md5Key: pulumi.String("string"),
Src: pulumi.String("string"),
},
},
Neighbors: router.BfdNeighborArray{
&router.BfdNeighborArgs{
Interface: pulumi.String("string"),
Ip: pulumi.String("string"),
},
},
Vdomparam: pulumi.String("string"),
})
var bfdResource = new Bfd("bfdResource", BfdArgs.builder()
.dynamicSortSubtable("string")
.getAllTables("string")
.multihopTemplates(BfdMultihopTemplateArgs.builder()
.authMode("string")
.bfdDesiredMinTx(0)
.bfdDetectMult(0)
.bfdRequiredMinRx(0)
.dst("string")
.id(0)
.md5Key("string")
.src("string")
.build())
.neighbors(BfdNeighborArgs.builder()
.interface_("string")
.ip("string")
.build())
.vdomparam("string")
.build());
bfd_resource = fortios.router.Bfd("bfdResource",
dynamic_sort_subtable="string",
get_all_tables="string",
multihop_templates=[{
"auth_mode": "string",
"bfd_desired_min_tx": 0,
"bfd_detect_mult": 0,
"bfd_required_min_rx": 0,
"dst": "string",
"id": 0,
"md5_key": "string",
"src": "string",
}],
neighbors=[{
"interface": "string",
"ip": "string",
}],
vdomparam="string")
const bfdResource = new fortios.router.Bfd("bfdResource", {
dynamicSortSubtable: "string",
getAllTables: "string",
multihopTemplates: [{
authMode: "string",
bfdDesiredMinTx: 0,
bfdDetectMult: 0,
bfdRequiredMinRx: 0,
dst: "string",
id: 0,
md5Key: "string",
src: "string",
}],
neighbors: [{
"interface": "string",
ip: "string",
}],
vdomparam: "string",
});
type: fortios:router:Bfd
properties:
dynamicSortSubtable: string
getAllTables: string
multihopTemplates:
- authMode: string
bfdDesiredMinTx: 0
bfdDetectMult: 0
bfdRequiredMinRx: 0
dst: string
id: 0
md5Key: string
src: string
neighbors:
- interface: string
ip: string
vdomparam: string
Bfd 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 Bfd resource accepts the following input properties:
- Dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Multihop
Templates List<Pulumiverse.Fortios. Router. Inputs. Bfd Multihop Template> - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - Neighbors
List<Pulumiverse.
Fortios. Router. Inputs. Bfd Neighbor> - neighbor The structure of
neighbor
block is documented below. - 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.
- Dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Multihop
Templates []BfdMultihop Template Args - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - Neighbors
[]Bfd
Neighbor Args - neighbor The structure of
neighbor
block is documented below. - 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.
- dynamic
Sort StringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- multihop
Templates List<BfdMultihop Template> - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - neighbors
List<Bfd
Neighbor> - neighbor The structure of
neighbor
block is documented below. - 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.
- dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- multihop
Templates BfdMultihop Template[] - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - neighbors
Bfd
Neighbor[] - neighbor The structure of
neighbor
block is documented below. - 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.
- dynamic_
sort_ strsubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- get_
all_ strtables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- multihop_
templates Sequence[BfdMultihop Template Args] - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - neighbors
Sequence[Bfd
Neighbor Args] - neighbor The structure of
neighbor
block is documented below. - 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.
- dynamic
Sort StringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- multihop
Templates List<Property Map> - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - neighbors List<Property Map>
- neighbor The structure of
neighbor
block is documented below. - 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 Bfd 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 Bfd Resource
Get an existing Bfd 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?: BfdState, opts?: CustomResourceOptions): Bfd
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
dynamic_sort_subtable: Optional[str] = None,
get_all_tables: Optional[str] = None,
multihop_templates: Optional[Sequence[BfdMultihopTemplateArgs]] = None,
neighbors: Optional[Sequence[BfdNeighborArgs]] = None,
vdomparam: Optional[str] = None) -> Bfd
func GetBfd(ctx *Context, name string, id IDInput, state *BfdState, opts ...ResourceOption) (*Bfd, error)
public static Bfd Get(string name, Input<string> id, BfdState? state, CustomResourceOptions? opts = null)
public static Bfd get(String name, Output<String> id, BfdState 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.
- Dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Multihop
Templates List<Pulumiverse.Fortios. Router. Inputs. Bfd Multihop Template> - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - Neighbors
List<Pulumiverse.
Fortios. Router. Inputs. Bfd Neighbor> - neighbor The structure of
neighbor
block is documented below. - 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.
- Dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Multihop
Templates []BfdMultihop Template Args - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - Neighbors
[]Bfd
Neighbor Args - neighbor The structure of
neighbor
block is documented below. - 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.
- dynamic
Sort StringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- multihop
Templates List<BfdMultihop Template> - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - neighbors
List<Bfd
Neighbor> - neighbor The structure of
neighbor
block is documented below. - 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.
- dynamic
Sort stringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- multihop
Templates BfdMultihop Template[] - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - neighbors
Bfd
Neighbor[] - neighbor The structure of
neighbor
block is documented below. - 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.
- dynamic_
sort_ strsubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- get_
all_ strtables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- multihop_
templates Sequence[BfdMultihop Template Args] - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - neighbors
Sequence[Bfd
Neighbor Args] - neighbor The structure of
neighbor
block is documented below. - 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.
- dynamic
Sort StringSubtable - Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- multihop
Templates List<Property Map> - BFD multi-hop template table. The structure of
multihop_template
block is documented below. - neighbors List<Property Map>
- neighbor The structure of
neighbor
block is documented below. - 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.
Supporting Types
BfdMultihopTemplate, BfdMultihopTemplateArgs
- Auth
Mode string - Authentication mode. Valid values:
none
,md5
. - Bfd
Desired intMin Tx - BFD desired minimal transmit interval (milliseconds).
- Bfd
Detect intMult - BFD detection multiplier.
- Bfd
Required intMin Rx - BFD required minimal receive interval (milliseconds).
- Dst string
- Destination prefix.
- Id int
- ID.
- Md5Key string
- MD5 key of key ID 1.
- Src string
- Source prefix.
- Auth
Mode string - Authentication mode. Valid values:
none
,md5
. - Bfd
Desired intMin Tx - BFD desired minimal transmit interval (milliseconds).
- Bfd
Detect intMult - BFD detection multiplier.
- Bfd
Required intMin Rx - BFD required minimal receive interval (milliseconds).
- Dst string
- Destination prefix.
- Id int
- ID.
- Md5Key string
- MD5 key of key ID 1.
- Src string
- Source prefix.
- auth
Mode String - Authentication mode. Valid values:
none
,md5
. - bfd
Desired IntegerMin Tx - BFD desired minimal transmit interval (milliseconds).
- bfd
Detect IntegerMult - BFD detection multiplier.
- bfd
Required IntegerMin Rx - BFD required minimal receive interval (milliseconds).
- dst String
- Destination prefix.
- id Integer
- ID.
- md5Key String
- MD5 key of key ID 1.
- src String
- Source prefix.
- auth
Mode string - Authentication mode. Valid values:
none
,md5
. - bfd
Desired numberMin Tx - BFD desired minimal transmit interval (milliseconds).
- bfd
Detect numberMult - BFD detection multiplier.
- bfd
Required numberMin Rx - BFD required minimal receive interval (milliseconds).
- dst string
- Destination prefix.
- id number
- ID.
- md5Key string
- MD5 key of key ID 1.
- src string
- Source prefix.
- auth_
mode str - Authentication mode. Valid values:
none
,md5
. - bfd_
desired_ intmin_ tx - BFD desired minimal transmit interval (milliseconds).
- bfd_
detect_ intmult - BFD detection multiplier.
- bfd_
required_ intmin_ rx - BFD required minimal receive interval (milliseconds).
- dst str
- Destination prefix.
- id int
- ID.
- md5_
key str - MD5 key of key ID 1.
- src str
- Source prefix.
- auth
Mode String - Authentication mode. Valid values:
none
,md5
. - bfd
Desired NumberMin Tx - BFD desired minimal transmit interval (milliseconds).
- bfd
Detect NumberMult - BFD detection multiplier.
- bfd
Required NumberMin Rx - BFD required minimal receive interval (milliseconds).
- dst String
- Destination prefix.
- id Number
- ID.
- md5Key String
- MD5 key of key ID 1.
- src String
- Source prefix.
BfdNeighbor, BfdNeighborArgs
- interface_ String
- Interface name.
- ip String
- IPv4 address of the BFD neighbor.
Import
Router Bfd can be imported using any of these accepted formats:
$ pulumi import fortios:router/bfd:Bfd labelname RouterBfd
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:router/bfd:Bfd labelname RouterBfd
$ 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.