@pulumi/sdwan
Version:
A Pulumi package for managing resources on Cisco Catalyst SD-WAN.. Based on terraform-provider-sdwan: version v0.4.1
833 lines (832 loc) • 23.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This resource can manage a System OMP Feature.
* - Minimum SD-WAN Manager version: `20.12.0`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sdwan from "@pulumi/sdwan";
*
* const example = new sdwan.SystemOmpFeature("example", {
* name: "Example",
* description: "My Example",
* featureProfileId: "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
* gracefulRestart: true,
* overlayAs: 10,
* pathsAdvertisedPerPrefix: 4,
* ecmpLimit: 4,
* shutdown: false,
* ompAdminDistanceIpv4: 10,
* ompAdminDistanceIpv6: 20,
* advertisementInterval: 1,
* gracefulRestartTimer: 43200,
* eorTimer: 300,
* holdtime: 60,
* advertiseIpv4Bgp: false,
* advertiseIpv4Ospf: false,
* advertiseIpv4OspfV3: false,
* advertiseIpv4Connected: false,
* advertiseIpv4Static: false,
* advertiseIpv4Eigrp: false,
* advertiseIpv4Lisp: false,
* advertiseIpv4Isis: false,
* advertiseIpv6Bgp: true,
* advertiseIpv6Ospf: true,
* advertiseIpv6Connected: true,
* advertiseIpv6Static: true,
* advertiseIpv6Eigrp: true,
* advertiseIpv6Lisp: true,
* advertiseIpv6Isis: true,
* ignoreRegionPathLength: false,
* transportGateway: "prefer",
* siteTypes: ["type-1"],
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Expected import identifier with the format: "system_omp_feature_id,feature_profile_id"
*
* ```sh
* $ pulumi import sdwan:index/systemOmpFeature:SystemOmpFeature example "f6b2c44c-693c-4763-b010-895aa3d236bd,f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"
* ```
*/
export declare class SystemOmpFeature extends pulumi.CustomResource {
/**
* Get an existing SystemOmpFeature resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SystemOmpFeatureState, opts?: pulumi.CustomResourceOptions): SystemOmpFeature;
/**
* Returns true if the given object is an instance of SystemOmpFeature. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is SystemOmpFeature;
/**
* BGP - Default value: `false`
*/
readonly advertiseIpv4Bgp: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv4BgpVariable: pulumi.Output<string | undefined>;
/**
* Connected - Default value: `true`
*/
readonly advertiseIpv4Connected: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv4ConnectedVariable: pulumi.Output<string | undefined>;
/**
* EIGRP - Default value: `false`
*/
readonly advertiseIpv4Eigrp: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv4EigrpVariable: pulumi.Output<string | undefined>;
/**
* ISIS - Default value: `false`
*/
readonly advertiseIpv4Isis: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv4IsisVariable: pulumi.Output<string | undefined>;
/**
* LISP - Default value: `false`
*/
readonly advertiseIpv4Lisp: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv4LispVariable: pulumi.Output<string | undefined>;
/**
* OSPF - Default value: `false`
*/
readonly advertiseIpv4Ospf: pulumi.Output<boolean | undefined>;
/**
* OSPFV3 - Default value: `false`
*/
readonly advertiseIpv4OspfV3: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv4OspfV3Variable: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly advertiseIpv4OspfVariable: pulumi.Output<string | undefined>;
/**
* Static - Default value: `true`
*/
readonly advertiseIpv4Static: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv4StaticVariable: pulumi.Output<string | undefined>;
/**
* BGP - Default value: `false`
*/
readonly advertiseIpv6Bgp: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv6BgpVariable: pulumi.Output<string | undefined>;
/**
* Connected - Default value: `false`
*/
readonly advertiseIpv6Connected: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv6ConnectedVariable: pulumi.Output<string | undefined>;
/**
* EIGRP - Default value: `false`
*/
readonly advertiseIpv6Eigrp: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv6EigrpVariable: pulumi.Output<string | undefined>;
/**
* ISIS - Default value: `false`
*/
readonly advertiseIpv6Isis: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv6IsisVariable: pulumi.Output<string | undefined>;
/**
* LISP - Default value: `false`
*/
readonly advertiseIpv6Lisp: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv6LispVariable: pulumi.Output<string | undefined>;
/**
* OSPF - Default value: `false`
*/
readonly advertiseIpv6Ospf: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv6OspfVariable: pulumi.Output<string | undefined>;
/**
* Static - Default value: `false`
*/
readonly advertiseIpv6Static: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly advertiseIpv6StaticVariable: pulumi.Output<string | undefined>;
/**
* Advertisement Interval (seconds) - Range: `0`-`65535` - Default value: `1`
*/
readonly advertisementInterval: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly advertisementIntervalVariable: pulumi.Output<string | undefined>;
/**
* The description of the Feature
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Set maximum number of OMP paths to install in cEdge route table - Range: `1`-`0` - Default value: `4`
*/
readonly ecmpLimit: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly ecmpLimitVariable: pulumi.Output<string | undefined>;
/**
* EOR Timer - Range: `1`-`3600` - Default value: `300`
*/
readonly eorTimer: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly eorTimerVariable: pulumi.Output<string | undefined>;
/**
* Feature Profile ID
*/
readonly featureProfileId: pulumi.Output<string>;
/**
* Graceful Restart for OMP - Default value: `true`
*/
readonly gracefulRestart: pulumi.Output<boolean | undefined>;
/**
* Graceful Restart Timer (seconds) - Range: `1`-`604800` - Default value: `43200`
*/
readonly gracefulRestartTimer: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly gracefulRestartTimerVariable: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly gracefulRestartVariable: pulumi.Output<string | undefined>;
/**
* Hold Time (seconds) - Default value: `60`
*/
readonly holdtime: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly holdtimeVariable: pulumi.Output<string | undefined>;
/**
* Treat hierarchical and direct (secondary region) paths equally - Default value: `false`
*/
readonly ignoreRegionPathLength: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly ignoreRegionPathLengthVariable: pulumi.Output<string | undefined>;
/**
* The name of the Feature
*/
readonly name: pulumi.Output<string>;
/**
* OMP Admin Distance IPv4 - Range: `1`-`255` - Default value: `251`
*/
readonly ompAdminDistanceIpv4: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly ompAdminDistanceIpv4Variable: pulumi.Output<string | undefined>;
/**
* OMP Admin Distance IPv6 - Range: `1`-`255` - Default value: `251`
*/
readonly ompAdminDistanceIpv6: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly ompAdminDistanceIpv6Variable: pulumi.Output<string | undefined>;
/**
* Overlay AS Number - Range: `1`-`4294967295`
*/
readonly overlayAs: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly overlayAsVariable: pulumi.Output<string | undefined>;
/**
* Number of Paths Advertised per Prefix - Range: `1`-`16` - Default value: `4`
*/
readonly pathsAdvertisedPerPrefix: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly pathsAdvertisedPerPrefixVariable: pulumi.Output<string | undefined>;
/**
* Shutdown - Default value: `false`
*/
readonly shutdown: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly shutdownVariable: pulumi.Output<string | undefined>;
/**
* Site Types
*/
readonly siteTypes: pulumi.Output<string[] | undefined>;
/**
* Variable name
*/
readonly siteTypesVariable: pulumi.Output<string | undefined>;
/**
* Transport Gateway Path Behavior - Choices: `prefer`, `ecmp-with-direct-path`
*/
readonly transportGateway: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly transportGatewayVariable: pulumi.Output<string | undefined>;
/**
* The version of the Feature
*/
readonly version: pulumi.Output<number>;
/**
* Create a SystemOmpFeature resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: SystemOmpFeatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SystemOmpFeature resources.
*/
export interface SystemOmpFeatureState {
/**
* BGP - Default value: `false`
*/
advertiseIpv4Bgp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4BgpVariable?: pulumi.Input<string>;
/**
* Connected - Default value: `true`
*/
advertiseIpv4Connected?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4ConnectedVariable?: pulumi.Input<string>;
/**
* EIGRP - Default value: `false`
*/
advertiseIpv4Eigrp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4EigrpVariable?: pulumi.Input<string>;
/**
* ISIS - Default value: `false`
*/
advertiseIpv4Isis?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4IsisVariable?: pulumi.Input<string>;
/**
* LISP - Default value: `false`
*/
advertiseIpv4Lisp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4LispVariable?: pulumi.Input<string>;
/**
* OSPF - Default value: `false`
*/
advertiseIpv4Ospf?: pulumi.Input<boolean>;
/**
* OSPFV3 - Default value: `false`
*/
advertiseIpv4OspfV3?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4OspfV3Variable?: pulumi.Input<string>;
/**
* Variable name
*/
advertiseIpv4OspfVariable?: pulumi.Input<string>;
/**
* Static - Default value: `true`
*/
advertiseIpv4Static?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4StaticVariable?: pulumi.Input<string>;
/**
* BGP - Default value: `false`
*/
advertiseIpv6Bgp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6BgpVariable?: pulumi.Input<string>;
/**
* Connected - Default value: `false`
*/
advertiseIpv6Connected?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6ConnectedVariable?: pulumi.Input<string>;
/**
* EIGRP - Default value: `false`
*/
advertiseIpv6Eigrp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6EigrpVariable?: pulumi.Input<string>;
/**
* ISIS - Default value: `false`
*/
advertiseIpv6Isis?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6IsisVariable?: pulumi.Input<string>;
/**
* LISP - Default value: `false`
*/
advertiseIpv6Lisp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6LispVariable?: pulumi.Input<string>;
/**
* OSPF - Default value: `false`
*/
advertiseIpv6Ospf?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6OspfVariable?: pulumi.Input<string>;
/**
* Static - Default value: `false`
*/
advertiseIpv6Static?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6StaticVariable?: pulumi.Input<string>;
/**
* Advertisement Interval (seconds) - Range: `0`-`65535` - Default value: `1`
*/
advertisementInterval?: pulumi.Input<number>;
/**
* Variable name
*/
advertisementIntervalVariable?: pulumi.Input<string>;
/**
* The description of the Feature
*/
description?: pulumi.Input<string>;
/**
* Set maximum number of OMP paths to install in cEdge route table - Range: `1`-`0` - Default value: `4`
*/
ecmpLimit?: pulumi.Input<number>;
/**
* Variable name
*/
ecmpLimitVariable?: pulumi.Input<string>;
/**
* EOR Timer - Range: `1`-`3600` - Default value: `300`
*/
eorTimer?: pulumi.Input<number>;
/**
* Variable name
*/
eorTimerVariable?: pulumi.Input<string>;
/**
* Feature Profile ID
*/
featureProfileId?: pulumi.Input<string>;
/**
* Graceful Restart for OMP - Default value: `true`
*/
gracefulRestart?: pulumi.Input<boolean>;
/**
* Graceful Restart Timer (seconds) - Range: `1`-`604800` - Default value: `43200`
*/
gracefulRestartTimer?: pulumi.Input<number>;
/**
* Variable name
*/
gracefulRestartTimerVariable?: pulumi.Input<string>;
/**
* Variable name
*/
gracefulRestartVariable?: pulumi.Input<string>;
/**
* Hold Time (seconds) - Default value: `60`
*/
holdtime?: pulumi.Input<number>;
/**
* Variable name
*/
holdtimeVariable?: pulumi.Input<string>;
/**
* Treat hierarchical and direct (secondary region) paths equally - Default value: `false`
*/
ignoreRegionPathLength?: pulumi.Input<boolean>;
/**
* Variable name
*/
ignoreRegionPathLengthVariable?: pulumi.Input<string>;
/**
* The name of the Feature
*/
name?: pulumi.Input<string>;
/**
* OMP Admin Distance IPv4 - Range: `1`-`255` - Default value: `251`
*/
ompAdminDistanceIpv4?: pulumi.Input<number>;
/**
* Variable name
*/
ompAdminDistanceIpv4Variable?: pulumi.Input<string>;
/**
* OMP Admin Distance IPv6 - Range: `1`-`255` - Default value: `251`
*/
ompAdminDistanceIpv6?: pulumi.Input<number>;
/**
* Variable name
*/
ompAdminDistanceIpv6Variable?: pulumi.Input<string>;
/**
* Overlay AS Number - Range: `1`-`4294967295`
*/
overlayAs?: pulumi.Input<number>;
/**
* Variable name
*/
overlayAsVariable?: pulumi.Input<string>;
/**
* Number of Paths Advertised per Prefix - Range: `1`-`16` - Default value: `4`
*/
pathsAdvertisedPerPrefix?: pulumi.Input<number>;
/**
* Variable name
*/
pathsAdvertisedPerPrefixVariable?: pulumi.Input<string>;
/**
* Shutdown - Default value: `false`
*/
shutdown?: pulumi.Input<boolean>;
/**
* Variable name
*/
shutdownVariable?: pulumi.Input<string>;
/**
* Site Types
*/
siteTypes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Variable name
*/
siteTypesVariable?: pulumi.Input<string>;
/**
* Transport Gateway Path Behavior - Choices: `prefer`, `ecmp-with-direct-path`
*/
transportGateway?: pulumi.Input<string>;
/**
* Variable name
*/
transportGatewayVariable?: pulumi.Input<string>;
/**
* The version of the Feature
*/
version?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a SystemOmpFeature resource.
*/
export interface SystemOmpFeatureArgs {
/**
* BGP - Default value: `false`
*/
advertiseIpv4Bgp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4BgpVariable?: pulumi.Input<string>;
/**
* Connected - Default value: `true`
*/
advertiseIpv4Connected?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4ConnectedVariable?: pulumi.Input<string>;
/**
* EIGRP - Default value: `false`
*/
advertiseIpv4Eigrp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4EigrpVariable?: pulumi.Input<string>;
/**
* ISIS - Default value: `false`
*/
advertiseIpv4Isis?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4IsisVariable?: pulumi.Input<string>;
/**
* LISP - Default value: `false`
*/
advertiseIpv4Lisp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4LispVariable?: pulumi.Input<string>;
/**
* OSPF - Default value: `false`
*/
advertiseIpv4Ospf?: pulumi.Input<boolean>;
/**
* OSPFV3 - Default value: `false`
*/
advertiseIpv4OspfV3?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4OspfV3Variable?: pulumi.Input<string>;
/**
* Variable name
*/
advertiseIpv4OspfVariable?: pulumi.Input<string>;
/**
* Static - Default value: `true`
*/
advertiseIpv4Static?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv4StaticVariable?: pulumi.Input<string>;
/**
* BGP - Default value: `false`
*/
advertiseIpv6Bgp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6BgpVariable?: pulumi.Input<string>;
/**
* Connected - Default value: `false`
*/
advertiseIpv6Connected?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6ConnectedVariable?: pulumi.Input<string>;
/**
* EIGRP - Default value: `false`
*/
advertiseIpv6Eigrp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6EigrpVariable?: pulumi.Input<string>;
/**
* ISIS - Default value: `false`
*/
advertiseIpv6Isis?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6IsisVariable?: pulumi.Input<string>;
/**
* LISP - Default value: `false`
*/
advertiseIpv6Lisp?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6LispVariable?: pulumi.Input<string>;
/**
* OSPF - Default value: `false`
*/
advertiseIpv6Ospf?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6OspfVariable?: pulumi.Input<string>;
/**
* Static - Default value: `false`
*/
advertiseIpv6Static?: pulumi.Input<boolean>;
/**
* Variable name
*/
advertiseIpv6StaticVariable?: pulumi.Input<string>;
/**
* Advertisement Interval (seconds) - Range: `0`-`65535` - Default value: `1`
*/
advertisementInterval?: pulumi.Input<number>;
/**
* Variable name
*/
advertisementIntervalVariable?: pulumi.Input<string>;
/**
* The description of the Feature
*/
description?: pulumi.Input<string>;
/**
* Set maximum number of OMP paths to install in cEdge route table - Range: `1`-`0` - Default value: `4`
*/
ecmpLimit?: pulumi.Input<number>;
/**
* Variable name
*/
ecmpLimitVariable?: pulumi.Input<string>;
/**
* EOR Timer - Range: `1`-`3600` - Default value: `300`
*/
eorTimer?: pulumi.Input<number>;
/**
* Variable name
*/
eorTimerVariable?: pulumi.Input<string>;
/**
* Feature Profile ID
*/
featureProfileId: pulumi.Input<string>;
/**
* Graceful Restart for OMP - Default value: `true`
*/
gracefulRestart?: pulumi.Input<boolean>;
/**
* Graceful Restart Timer (seconds) - Range: `1`-`604800` - Default value: `43200`
*/
gracefulRestartTimer?: pulumi.Input<number>;
/**
* Variable name
*/
gracefulRestartTimerVariable?: pulumi.Input<string>;
/**
* Variable name
*/
gracefulRestartVariable?: pulumi.Input<string>;
/**
* Hold Time (seconds) - Default value: `60`
*/
holdtime?: pulumi.Input<number>;
/**
* Variable name
*/
holdtimeVariable?: pulumi.Input<string>;
/**
* Treat hierarchical and direct (secondary region) paths equally - Default value: `false`
*/
ignoreRegionPathLength?: pulumi.Input<boolean>;
/**
* Variable name
*/
ignoreRegionPathLengthVariable?: pulumi.Input<string>;
/**
* The name of the Feature
*/
name?: pulumi.Input<string>;
/**
* OMP Admin Distance IPv4 - Range: `1`-`255` - Default value: `251`
*/
ompAdminDistanceIpv4?: pulumi.Input<number>;
/**
* Variable name
*/
ompAdminDistanceIpv4Variable?: pulumi.Input<string>;
/**
* OMP Admin Distance IPv6 - Range: `1`-`255` - Default value: `251`
*/
ompAdminDistanceIpv6?: pulumi.Input<number>;
/**
* Variable name
*/
ompAdminDistanceIpv6Variable?: pulumi.Input<string>;
/**
* Overlay AS Number - Range: `1`-`4294967295`
*/
overlayAs?: pulumi.Input<number>;
/**
* Variable name
*/
overlayAsVariable?: pulumi.Input<string>;
/**
* Number of Paths Advertised per Prefix - Range: `1`-`16` - Default value: `4`
*/
pathsAdvertisedPerPrefix?: pulumi.Input<number>;
/**
* Variable name
*/
pathsAdvertisedPerPrefixVariable?: pulumi.Input<string>;
/**
* Shutdown - Default value: `false`
*/
shutdown?: pulumi.Input<boolean>;
/**
* Variable name
*/
shutdownVariable?: pulumi.Input<string>;
/**
* Site Types
*/
siteTypes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Variable name
*/
siteTypesVariable?: pulumi.Input<string>;
/**
* Transport Gateway Path Behavior - Choices: `prefer`, `ecmp-with-direct-path`
*/
transportGateway?: pulumi.Input<string>;
/**
* Variable name
*/
transportGatewayVariable?: pulumi.Input<string>;
}