fortios.system.Fabricvpn
Explore with Pulumi AI
Setup for self orchestrated fabric auto discovery VPN. Applies to FortiOS Version >= 7.2.4
.
Create Fabricvpn Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Fabricvpn(name: string, args?: FabricvpnArgs, opts?: CustomResourceOptions);
@overload
def Fabricvpn(resource_name: str,
args: Optional[FabricvpnArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Fabricvpn(resource_name: str,
opts: Optional[ResourceOptions] = None,
advertised_subnets: Optional[Sequence[FabricvpnAdvertisedSubnetArgs]] = None,
bgp_as: Optional[int] = None,
branch_name: Optional[str] = None,
dynamic_sort_subtable: Optional[str] = None,
get_all_tables: Optional[str] = None,
health_checks: Optional[str] = None,
loopback_address_block: Optional[str] = None,
loopback_advertised_subnet: Optional[int] = None,
loopback_interface: Optional[str] = None,
overlays: Optional[Sequence[FabricvpnOverlayArgs]] = None,
policy_rule: Optional[str] = None,
psksecret: Optional[str] = None,
sdwan_zone: Optional[str] = None,
status: Optional[str] = None,
sync_mode: Optional[str] = None,
vdomparam: Optional[str] = None,
vpn_role: Optional[str] = None)
func NewFabricvpn(ctx *Context, name string, args *FabricvpnArgs, opts ...ResourceOption) (*Fabricvpn, error)
public Fabricvpn(string name, FabricvpnArgs? args = null, CustomResourceOptions? opts = null)
public Fabricvpn(String name, FabricvpnArgs args)
public Fabricvpn(String name, FabricvpnArgs args, CustomResourceOptions options)
type: fortios:system:Fabricvpn
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 FabricvpnArgs
- 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 FabricvpnArgs
- 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 FabricvpnArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FabricvpnArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FabricvpnArgs
- 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 fabricvpnResource = new Fortios.System.Fabricvpn("fabricvpnResource", new()
{
AdvertisedSubnets = new[]
{
new Fortios.System.Inputs.FabricvpnAdvertisedSubnetArgs
{
Access = "string",
BgpNetwork = 0,
FirewallAddress = "string",
Id = 0,
Policies = 0,
Prefix = "string",
},
},
BgpAs = 0,
BranchName = "string",
DynamicSortSubtable = "string",
GetAllTables = "string",
HealthChecks = "string",
LoopbackAddressBlock = "string",
LoopbackAdvertisedSubnet = 0,
LoopbackInterface = "string",
Overlays = new[]
{
new Fortios.System.Inputs.FabricvpnOverlayArgs
{
BgpNeighbor = "string",
BgpNeighborGroup = "string",
BgpNeighborRange = 0,
BgpNetwork = 0,
Interface = "string",
IpsecPhase1 = "string",
Name = "string",
OverlayPolicy = 0,
OverlayTunnelBlock = "string",
RemoteGw = "string",
RoutePolicy = 0,
SdwanMember = 0,
},
},
PolicyRule = "string",
Psksecret = "string",
SdwanZone = "string",
Status = "string",
SyncMode = "string",
Vdomparam = "string",
VpnRole = "string",
});
example, err := system.NewFabricvpn(ctx, "fabricvpnResource", &system.FabricvpnArgs{
AdvertisedSubnets: system.FabricvpnAdvertisedSubnetArray{
&system.FabricvpnAdvertisedSubnetArgs{
Access: pulumi.String("string"),
BgpNetwork: pulumi.Int(0),
FirewallAddress: pulumi.String("string"),
Id: pulumi.Int(0),
Policies: pulumi.Int(0),
Prefix: pulumi.String("string"),
},
},
BgpAs: pulumi.Int(0),
BranchName: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
GetAllTables: pulumi.String("string"),
HealthChecks: pulumi.String("string"),
LoopbackAddressBlock: pulumi.String("string"),
LoopbackAdvertisedSubnet: pulumi.Int(0),
LoopbackInterface: pulumi.String("string"),
Overlays: system.FabricvpnOverlayArray{
&system.FabricvpnOverlayArgs{
BgpNeighbor: pulumi.String("string"),
BgpNeighborGroup: pulumi.String("string"),
BgpNeighborRange: pulumi.Int(0),
BgpNetwork: pulumi.Int(0),
Interface: pulumi.String("string"),
IpsecPhase1: pulumi.String("string"),
Name: pulumi.String("string"),
OverlayPolicy: pulumi.Int(0),
OverlayTunnelBlock: pulumi.String("string"),
RemoteGw: pulumi.String("string"),
RoutePolicy: pulumi.Int(0),
SdwanMember: pulumi.Int(0),
},
},
PolicyRule: pulumi.String("string"),
Psksecret: pulumi.String("string"),
SdwanZone: pulumi.String("string"),
Status: pulumi.String("string"),
SyncMode: pulumi.String("string"),
Vdomparam: pulumi.String("string"),
VpnRole: pulumi.String("string"),
})
var fabricvpnResource = new Fabricvpn("fabricvpnResource", FabricvpnArgs.builder()
.advertisedSubnets(FabricvpnAdvertisedSubnetArgs.builder()
.access("string")
.bgpNetwork(0)
.firewallAddress("string")
.id(0)
.policies(0)
.prefix("string")
.build())
.bgpAs(0)
.branchName("string")
.dynamicSortSubtable("string")
.getAllTables("string")
.healthChecks("string")
.loopbackAddressBlock("string")
.loopbackAdvertisedSubnet(0)
.loopbackInterface("string")
.overlays(FabricvpnOverlayArgs.builder()
.bgpNeighbor("string")
.bgpNeighborGroup("string")
.bgpNeighborRange(0)
.bgpNetwork(0)
.interface_("string")
.ipsecPhase1("string")
.name("string")
.overlayPolicy(0)
.overlayTunnelBlock("string")
.remoteGw("string")
.routePolicy(0)
.sdwanMember(0)
.build())
.policyRule("string")
.psksecret("string")
.sdwanZone("string")
.status("string")
.syncMode("string")
.vdomparam("string")
.vpnRole("string")
.build());
fabricvpn_resource = fortios.system.Fabricvpn("fabricvpnResource",
advertised_subnets=[fortios.system.FabricvpnAdvertisedSubnetArgs(
access="string",
bgp_network=0,
firewall_address="string",
id=0,
policies=0,
prefix="string",
)],
bgp_as=0,
branch_name="string",
dynamic_sort_subtable="string",
get_all_tables="string",
health_checks="string",
loopback_address_block="string",
loopback_advertised_subnet=0,
loopback_interface="string",
overlays=[fortios.system.FabricvpnOverlayArgs(
bgp_neighbor="string",
bgp_neighbor_group="string",
bgp_neighbor_range=0,
bgp_network=0,
interface="string",
ipsec_phase1="string",
name="string",
overlay_policy=0,
overlay_tunnel_block="string",
remote_gw="string",
route_policy=0,
sdwan_member=0,
)],
policy_rule="string",
psksecret="string",
sdwan_zone="string",
status="string",
sync_mode="string",
vdomparam="string",
vpn_role="string")
const fabricvpnResource = new fortios.system.Fabricvpn("fabricvpnResource", {
advertisedSubnets: [{
access: "string",
bgpNetwork: 0,
firewallAddress: "string",
id: 0,
policies: 0,
prefix: "string",
}],
bgpAs: 0,
branchName: "string",
dynamicSortSubtable: "string",
getAllTables: "string",
healthChecks: "string",
loopbackAddressBlock: "string",
loopbackAdvertisedSubnet: 0,
loopbackInterface: "string",
overlays: [{
bgpNeighbor: "string",
bgpNeighborGroup: "string",
bgpNeighborRange: 0,
bgpNetwork: 0,
"interface": "string",
ipsecPhase1: "string",
name: "string",
overlayPolicy: 0,
overlayTunnelBlock: "string",
remoteGw: "string",
routePolicy: 0,
sdwanMember: 0,
}],
policyRule: "string",
psksecret: "string",
sdwanZone: "string",
status: "string",
syncMode: "string",
vdomparam: "string",
vpnRole: "string",
});
type: fortios:system:Fabricvpn
properties:
advertisedSubnets:
- access: string
bgpNetwork: 0
firewallAddress: string
id: 0
policies: 0
prefix: string
bgpAs: 0
branchName: string
dynamicSortSubtable: string
getAllTables: string
healthChecks: string
loopbackAddressBlock: string
loopbackAdvertisedSubnet: 0
loopbackInterface: string
overlays:
- bgpNeighbor: string
bgpNeighborGroup: string
bgpNeighborRange: 0
bgpNetwork: 0
interface: string
ipsecPhase1: string
name: string
overlayPolicy: 0
overlayTunnelBlock: string
remoteGw: string
routePolicy: 0
sdwanMember: 0
policyRule: string
psksecret: string
sdwanZone: string
status: string
syncMode: string
vdomparam: string
vpnRole: string
Fabricvpn Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Fabricvpn resource accepts the following input properties:
- Advertised
Subnets List<Pulumiverse.Fortios. System. Inputs. Fabricvpn Advertised Subnet> - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - Bgp
As int - BGP Router AS number, valid from 1 to 4294967295.
- Branch
Name string - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Health
Checks string - Underlying health checks.
- Loopback
Address stringBlock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- Loopback
Advertised intSubnet - Loopback advertised subnet reference.
- Loopback
Interface string - Loopback interface.
- Overlays
List<Pulumiverse.
Fortios. System. Inputs. Fabricvpn Overlay> - Local overlay interfaces table. The structure of
overlays
block is documented below. - Policy
Rule string - Policy creation rule. Valid values:
health-check
,manual
,auto
. - Psksecret string
- Pre-shared secret for ADVPN.
- Sdwan
Zone string - Reference to created SD-WAN zone.
- Status string
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - Sync
Mode string - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- Vpn
Role string - Fabric VPN role. Valid values:
hub
,spoke
.
- Advertised
Subnets []FabricvpnAdvertised Subnet Args - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - Bgp
As int - BGP Router AS number, valid from 1 to 4294967295.
- Branch
Name string - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Health
Checks string - Underlying health checks.
- Loopback
Address stringBlock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- Loopback
Advertised intSubnet - Loopback advertised subnet reference.
- Loopback
Interface string - Loopback interface.
- Overlays
[]Fabricvpn
Overlay Args - Local overlay interfaces table. The structure of
overlays
block is documented below. - Policy
Rule string - Policy creation rule. Valid values:
health-check
,manual
,auto
. - Psksecret string
- Pre-shared secret for ADVPN.
- Sdwan
Zone string - Reference to created SD-WAN zone.
- Status string
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - Sync
Mode string - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- Vpn
Role string - Fabric VPN role. Valid values:
hub
,spoke
.
- advertised
Subnets List<FabricvpnAdvertised Subnet> - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - bgp
As Integer - BGP Router AS number, valid from 1 to 4294967295.
- branch
Name String - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- health
Checks String - Underlying health checks.
- loopback
Address StringBlock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- loopback
Advertised IntegerSubnet - Loopback advertised subnet reference.
- loopback
Interface String - Loopback interface.
- overlays
List<Fabricvpn
Overlay> - Local overlay interfaces table. The structure of
overlays
block is documented below. - policy
Rule String - Policy creation rule. Valid values:
health-check
,manual
,auto
. - psksecret String
- Pre-shared secret for ADVPN.
- sdwan
Zone String - Reference to created SD-WAN zone.
- status String
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - sync
Mode String - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- vpn
Role String - Fabric VPN role. Valid values:
hub
,spoke
.
- advertised
Subnets FabricvpnAdvertised Subnet[] - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - bgp
As number - BGP Router AS number, valid from 1 to 4294967295.
- branch
Name string - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- health
Checks string - Underlying health checks.
- loopback
Address stringBlock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- loopback
Advertised numberSubnet - Loopback advertised subnet reference.
- loopback
Interface string - Loopback interface.
- overlays
Fabricvpn
Overlay[] - Local overlay interfaces table. The structure of
overlays
block is documented below. - policy
Rule string - Policy creation rule. Valid values:
health-check
,manual
,auto
. - psksecret string
- Pre-shared secret for ADVPN.
- sdwan
Zone string - Reference to created SD-WAN zone.
- status string
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - sync
Mode string - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- vpn
Role string - Fabric VPN role. Valid values:
hub
,spoke
.
- advertised_
subnets Sequence[FabricvpnAdvertised Subnet Args] - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - bgp_
as int - BGP Router AS number, valid from 1 to 4294967295.
- branch_
name str - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- health_
checks str - Underlying health checks.
- loopback_
address_ strblock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- loopback_
advertised_ intsubnet - Loopback advertised subnet reference.
- loopback_
interface str - Loopback interface.
- overlays
Sequence[Fabricvpn
Overlay Args] - Local overlay interfaces table. The structure of
overlays
block is documented below. - policy_
rule str - Policy creation rule. Valid values:
health-check
,manual
,auto
. - psksecret str
- Pre-shared secret for ADVPN.
- sdwan_
zone str - Reference to created SD-WAN zone.
- status str
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - sync_
mode str - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- vpn_
role str - Fabric VPN role. Valid values:
hub
,spoke
.
- advertised
Subnets List<Property Map> - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - bgp
As Number - BGP Router AS number, valid from 1 to 4294967295.
- branch
Name String - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- health
Checks String - Underlying health checks.
- loopback
Address StringBlock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- loopback
Advertised NumberSubnet - Loopback advertised subnet reference.
- loopback
Interface String - Loopback interface.
- overlays List<Property Map>
- Local overlay interfaces table. The structure of
overlays
block is documented below. - policy
Rule String - Policy creation rule. Valid values:
health-check
,manual
,auto
. - psksecret String
- Pre-shared secret for ADVPN.
- sdwan
Zone String - Reference to created SD-WAN zone.
- status String
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - sync
Mode String - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- vpn
Role String - Fabric VPN role. Valid values:
hub
,spoke
.
Outputs
All input properties are implicitly available as output properties. Additionally, the Fabricvpn 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 Fabricvpn Resource
Get an existing Fabricvpn 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?: FabricvpnState, opts?: CustomResourceOptions): Fabricvpn
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
advertised_subnets: Optional[Sequence[FabricvpnAdvertisedSubnetArgs]] = None,
bgp_as: Optional[int] = None,
branch_name: Optional[str] = None,
dynamic_sort_subtable: Optional[str] = None,
get_all_tables: Optional[str] = None,
health_checks: Optional[str] = None,
loopback_address_block: Optional[str] = None,
loopback_advertised_subnet: Optional[int] = None,
loopback_interface: Optional[str] = None,
overlays: Optional[Sequence[FabricvpnOverlayArgs]] = None,
policy_rule: Optional[str] = None,
psksecret: Optional[str] = None,
sdwan_zone: Optional[str] = None,
status: Optional[str] = None,
sync_mode: Optional[str] = None,
vdomparam: Optional[str] = None,
vpn_role: Optional[str] = None) -> Fabricvpn
func GetFabricvpn(ctx *Context, name string, id IDInput, state *FabricvpnState, opts ...ResourceOption) (*Fabricvpn, error)
public static Fabricvpn Get(string name, Input<string> id, FabricvpnState? state, CustomResourceOptions? opts = null)
public static Fabricvpn get(String name, Output<String> id, FabricvpnState 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.
- Advertised
Subnets List<Pulumiverse.Fortios. System. Inputs. Fabricvpn Advertised Subnet> - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - Bgp
As int - BGP Router AS number, valid from 1 to 4294967295.
- Branch
Name string - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Health
Checks string - Underlying health checks.
- Loopback
Address stringBlock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- Loopback
Advertised intSubnet - Loopback advertised subnet reference.
- Loopback
Interface string - Loopback interface.
- Overlays
List<Pulumiverse.
Fortios. System. Inputs. Fabricvpn Overlay> - Local overlay interfaces table. The structure of
overlays
block is documented below. - Policy
Rule string - Policy creation rule. Valid values:
health-check
,manual
,auto
. - Psksecret string
- Pre-shared secret for ADVPN.
- Sdwan
Zone string - Reference to created SD-WAN zone.
- Status string
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - Sync
Mode string - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- Vpn
Role string - Fabric VPN role. Valid values:
hub
,spoke
.
- Advertised
Subnets []FabricvpnAdvertised Subnet Args - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - Bgp
As int - BGP Router AS number, valid from 1 to 4294967295.
- Branch
Name string - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- Health
Checks string - Underlying health checks.
- Loopback
Address stringBlock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- Loopback
Advertised intSubnet - Loopback advertised subnet reference.
- Loopback
Interface string - Loopback interface.
- Overlays
[]Fabricvpn
Overlay Args - Local overlay interfaces table. The structure of
overlays
block is documented below. - Policy
Rule string - Policy creation rule. Valid values:
health-check
,manual
,auto
. - Psksecret string
- Pre-shared secret for ADVPN.
- Sdwan
Zone string - Reference to created SD-WAN zone.
- Status string
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - Sync
Mode string - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- Vpn
Role string - Fabric VPN role. Valid values:
hub
,spoke
.
- advertised
Subnets List<FabricvpnAdvertised Subnet> - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - bgp
As Integer - BGP Router AS number, valid from 1 to 4294967295.
- branch
Name String - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- health
Checks String - Underlying health checks.
- loopback
Address StringBlock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- loopback
Advertised IntegerSubnet - Loopback advertised subnet reference.
- loopback
Interface String - Loopback interface.
- overlays
List<Fabricvpn
Overlay> - Local overlay interfaces table. The structure of
overlays
block is documented below. - policy
Rule String - Policy creation rule. Valid values:
health-check
,manual
,auto
. - psksecret String
- Pre-shared secret for ADVPN.
- sdwan
Zone String - Reference to created SD-WAN zone.
- status String
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - sync
Mode String - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- vpn
Role String - Fabric VPN role. Valid values:
hub
,spoke
.
- advertised
Subnets FabricvpnAdvertised Subnet[] - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - bgp
As number - BGP Router AS number, valid from 1 to 4294967295.
- branch
Name string - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- health
Checks string - Underlying health checks.
- loopback
Address stringBlock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- loopback
Advertised numberSubnet - Loopback advertised subnet reference.
- loopback
Interface string - Loopback interface.
- overlays
Fabricvpn
Overlay[] - Local overlay interfaces table. The structure of
overlays
block is documented below. - policy
Rule string - Policy creation rule. Valid values:
health-check
,manual
,auto
. - psksecret string
- Pre-shared secret for ADVPN.
- sdwan
Zone string - Reference to created SD-WAN zone.
- status string
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - sync
Mode string - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- vpn
Role string - Fabric VPN role. Valid values:
hub
,spoke
.
- advertised_
subnets Sequence[FabricvpnAdvertised Subnet Args] - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - bgp_
as int - BGP Router AS number, valid from 1 to 4294967295.
- branch_
name str - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- health_
checks str - Underlying health checks.
- loopback_
address_ strblock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- loopback_
advertised_ intsubnet - Loopback advertised subnet reference.
- loopback_
interface str - Loopback interface.
- overlays
Sequence[Fabricvpn
Overlay Args] - Local overlay interfaces table. The structure of
overlays
block is documented below. - policy_
rule str - Policy creation rule. Valid values:
health-check
,manual
,auto
. - psksecret str
- Pre-shared secret for ADVPN.
- sdwan_
zone str - Reference to created SD-WAN zone.
- status str
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - sync_
mode str - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- vpn_
role str - Fabric VPN role. Valid values:
hub
,spoke
.
- advertised
Subnets List<Property Map> - Local advertised subnets. The structure of
advertised_subnets
block is documented below. - bgp
As Number - BGP Router AS number, valid from 1 to 4294967295.
- branch
Name String - Branch name.
- 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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
- health
Checks String - Underlying health checks.
- loopback
Address StringBlock - IPv4 address and subnet mask for hub's loopback address, syntax: X.X.X.X/24.
- loopback
Advertised NumberSubnet - Loopback advertised subnet reference.
- loopback
Interface String - Loopback interface.
- overlays List<Property Map>
- Local overlay interfaces table. The structure of
overlays
block is documented below. - policy
Rule String - Policy creation rule. Valid values:
health-check
,manual
,auto
. - psksecret String
- Pre-shared secret for ADVPN.
- sdwan
Zone String - Reference to created SD-WAN zone.
- status String
- Enable/disable Fabric VPN. Valid values:
enable
,disable
. - sync
Mode String - Setting synchronised by fabric or manual. Valid values:
enable
,disable
. - 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.
- vpn
Role String - Fabric VPN role. Valid values:
hub
,spoke
.
Supporting Types
FabricvpnAdvertisedSubnet, FabricvpnAdvertisedSubnetArgs
- Access string
- Access policy direction. Valid values:
inbound
,bidirectional
. - Bgp
Network int - Underlying BGP network.
- Firewall
Address string - Underlying firewall address.
- Id int
- ID.
- Policies int
- Underlying policies.
- Prefix string
- Network prefix.
- Access string
- Access policy direction. Valid values:
inbound
,bidirectional
. - Bgp
Network int - Underlying BGP network.
- Firewall
Address string - Underlying firewall address.
- Id int
- ID.
- Policies int
- Underlying policies.
- Prefix string
- Network prefix.
- access String
- Access policy direction. Valid values:
inbound
,bidirectional
. - bgp
Network Integer - Underlying BGP network.
- firewall
Address String - Underlying firewall address.
- id Integer
- ID.
- policies Integer
- Underlying policies.
- prefix String
- Network prefix.
- access string
- Access policy direction. Valid values:
inbound
,bidirectional
. - bgp
Network number - Underlying BGP network.
- firewall
Address string - Underlying firewall address.
- id number
- ID.
- policies number
- Underlying policies.
- prefix string
- Network prefix.
- access str
- Access policy direction. Valid values:
inbound
,bidirectional
. - bgp_
network int - Underlying BGP network.
- firewall_
address str - Underlying firewall address.
- id int
- ID.
- policies int
- Underlying policies.
- prefix str
- Network prefix.
- access String
- Access policy direction. Valid values:
inbound
,bidirectional
. - bgp
Network Number - Underlying BGP network.
- firewall
Address String - Underlying firewall address.
- id Number
- ID.
- policies Number
- Underlying policies.
- prefix String
- Network prefix.
FabricvpnOverlay, FabricvpnOverlayArgs
- Bgp
Neighbor string - Underlying BGP neighbor entry.
- Bgp
Neighbor stringGroup - Underlying BGP neighbor group entry.
- Bgp
Neighbor intRange - Underlying BGP neighbor range entry.
- Bgp
Network int - Underlying BGP network.
- Interface string
- Underlying interface name.
- Ipsec
Phase1 string - IPsec interface.
- Name string
- Overlay name.
- Overlay
Policy int - The overlay policy to allow ADVPN thru traffic.
- Overlay
Tunnel stringBlock - IPv4 address and subnet mask for the overlay tunnel , syntax: X.X.X.X/24.
- Remote
Gw string - IP address of the hub gateway (Set by hub).
- Route
Policy int - Underlying router policy.
- Sdwan
Member int - Reference to SD-WAN member entry.
- Bgp
Neighbor string - Underlying BGP neighbor entry.
- Bgp
Neighbor stringGroup - Underlying BGP neighbor group entry.
- Bgp
Neighbor intRange - Underlying BGP neighbor range entry.
- Bgp
Network int - Underlying BGP network.
- Interface string
- Underlying interface name.
- Ipsec
Phase1 string - IPsec interface.
- Name string
- Overlay name.
- Overlay
Policy int - The overlay policy to allow ADVPN thru traffic.
- Overlay
Tunnel stringBlock - IPv4 address and subnet mask for the overlay tunnel , syntax: X.X.X.X/24.
- Remote
Gw string - IP address of the hub gateway (Set by hub).
- Route
Policy int - Underlying router policy.
- Sdwan
Member int - Reference to SD-WAN member entry.
- bgp
Neighbor String - Underlying BGP neighbor entry.
- bgp
Neighbor StringGroup - Underlying BGP neighbor group entry.
- bgp
Neighbor IntegerRange - Underlying BGP neighbor range entry.
- bgp
Network Integer - Underlying BGP network.
- interface_ String
- Underlying interface name.
- ipsec
Phase1 String - IPsec interface.
- name String
- Overlay name.
- overlay
Policy Integer - The overlay policy to allow ADVPN thru traffic.
- overlay
Tunnel StringBlock - IPv4 address and subnet mask for the overlay tunnel , syntax: X.X.X.X/24.
- remote
Gw String - IP address of the hub gateway (Set by hub).
- route
Policy Integer - Underlying router policy.
- sdwan
Member Integer - Reference to SD-WAN member entry.
- bgp
Neighbor string - Underlying BGP neighbor entry.
- bgp
Neighbor stringGroup - Underlying BGP neighbor group entry.
- bgp
Neighbor numberRange - Underlying BGP neighbor range entry.
- bgp
Network number - Underlying BGP network.
- interface string
- Underlying interface name.
- ipsec
Phase1 string - IPsec interface.
- name string
- Overlay name.
- overlay
Policy number - The overlay policy to allow ADVPN thru traffic.
- overlay
Tunnel stringBlock - IPv4 address and subnet mask for the overlay tunnel , syntax: X.X.X.X/24.
- remote
Gw string - IP address of the hub gateway (Set by hub).
- route
Policy number - Underlying router policy.
- sdwan
Member number - Reference to SD-WAN member entry.
- bgp_
neighbor str - Underlying BGP neighbor entry.
- bgp_
neighbor_ strgroup - Underlying BGP neighbor group entry.
- bgp_
neighbor_ intrange - Underlying BGP neighbor range entry.
- bgp_
network int - Underlying BGP network.
- interface str
- Underlying interface name.
- ipsec_
phase1 str - IPsec interface.
- name str
- Overlay name.
- overlay_
policy int - The overlay policy to allow ADVPN thru traffic.
- overlay_
tunnel_ strblock - IPv4 address and subnet mask for the overlay tunnel , syntax: X.X.X.X/24.
- remote_
gw str - IP address of the hub gateway (Set by hub).
- route_
policy int - Underlying router policy.
- sdwan_
member int - Reference to SD-WAN member entry.
- bgp
Neighbor String - Underlying BGP neighbor entry.
- bgp
Neighbor StringGroup - Underlying BGP neighbor group entry.
- bgp
Neighbor NumberRange - Underlying BGP neighbor range entry.
- bgp
Network Number - Underlying BGP network.
- interface String
- Underlying interface name.
- ipsec
Phase1 String - IPsec interface.
- name String
- Overlay name.
- overlay
Policy Number - The overlay policy to allow ADVPN thru traffic.
- overlay
Tunnel StringBlock - IPv4 address and subnet mask for the overlay tunnel , syntax: X.X.X.X/24.
- remote
Gw String - IP address of the hub gateway (Set by hub).
- route
Policy Number - Underlying router policy.
- sdwan
Member Number - Reference to SD-WAN member entry.
Import
System FabricVpn can be imported using any of these accepted formats:
$ pulumi import fortios:system/fabricvpn:Fabricvpn labelname SystemFabricVpn
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:system/fabricvpn:Fabricvpn labelname SystemFabricVpn
$ 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.