@pulumi/sdwan
Version:
A Pulumi package for managing resources on Cisco Catalyst SD-WAN.. Based on terraform-provider-sdwan: version v0.4.1
445 lines (444 loc) • 14.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* This resource can manage a Cisco OMP feature template.
* - Minimum SD-WAN Manager version: `15.0.0`
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* ```sh
* $ pulumi import sdwan:index/ciscoOmpFeatureTemplate:CiscoOmpFeatureTemplate example "f6b2c44c-693c-4763-b010-895aa3d236bd"
* ```
*/
export declare class CiscoOmpFeatureTemplate extends pulumi.CustomResource {
/**
* Get an existing CiscoOmpFeatureTemplate 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?: CiscoOmpFeatureTemplateState, opts?: pulumi.CustomResourceOptions): CiscoOmpFeatureTemplate;
/**
* Returns true if the given object is an instance of CiscoOmpFeatureTemplate. 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 CiscoOmpFeatureTemplate;
/**
* Advertise locally learned routes to OMP
*/
readonly advertiseIpv4Routes: pulumi.Output<outputs.CiscoOmpFeatureTemplateAdvertiseIpv4Route[] | undefined>;
/**
* Advertise locally learned routes to OMP
*/
readonly advertiseIpv6Routes: pulumi.Output<outputs.CiscoOmpFeatureTemplateAdvertiseIpv6Route[] | undefined>;
/**
* Set the time between OMP Update packets - 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 template
*/
readonly description: pulumi.Output<string>;
/**
* List of supported device types - Choices: `vedge-C8000V`, `vedge-C8300-1N1S-4T2X`, `vedge-C8300-1N1S-6T`,
* `vedge-C8300-2N2S-6T`, `vedge-C8300-2N2S-4T2X`, `vedge-C8500-12X4QC`, `vedge-C8500-12X`, `vedge-C8500-20X6C`,
* `vedge-C8500L-8S4X`, `vedge-C8200-1N-4T`, `vedge-C8200L-1N-4T`
*/
readonly deviceTypes: pulumi.Output<string[]>;
/**
* Set maximum number of OMP paths to install in vEdge route table - Range: `1`-`16` - Default value: `4`
*/
readonly ecmpLimit: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly ecmpLimitVariable: pulumi.Output<string | undefined>;
/**
* End of RIB timer <1..604800> seconds - Range: `1`-`3600` - Default value: `300`
*/
readonly eorTimer: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly eorTimerVariable: pulumi.Output<string | undefined>;
/**
* Enable or disable OMP graceful restart - Default value: `true`
*/
readonly gracefulRestart: pulumi.Output<boolean | undefined>;
/**
* Set the OMP graceful restart timer - 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>;
/**
* Set how long to wait before closing OMP peer connection - Default value: `60`
*/
readonly holdtime: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly holdtimeVariable: pulumi.Output<string | undefined>;
/**
* Ignore Region-Path Length During Best-Path Algorithm - Default value: `false`
*/
readonly ignoreRegionPathLength: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly ignoreRegionPathLengthVariable: pulumi.Output<string | undefined>;
/**
* The name of the feature template
*/
readonly name: pulumi.Output<string>;
/**
* omp-admin-distance-ipv4 - Range: `1`-`255`
*/
readonly ompAdminDistanceIpv4: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly ompAdminDistanceIpv4Variable: pulumi.Output<string | undefined>;
/**
* omp-admin-distance-ipv6 - Range: `1`-`255`
*/
readonly ompAdminDistanceIpv6: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly ompAdminDistanceIpv6Variable: pulumi.Output<string | undefined>;
/**
* Set Overlay AS number <1..4294967295> or <XX.YY> - Range: `1`-`4294967295`
*/
readonly overlayAs: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly overlayAsVariable: pulumi.Output<string | undefined>;
/**
* Set number of TLOC routes advertised between vSmart and vEdge - Range: `1`-`16` - Default value: `4`
*/
readonly sendPathLimit: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly sendPathLimitVariable: pulumi.Output<string | undefined>;
/**
* Enable or disable OMP - Default value: `false`
*/
readonly shutdown: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly shutdownVariable: pulumi.Output<string | undefined>;
/**
* The template type
*/
readonly templateType: pulumi.Output<string>;
/**
* Transport gateway path computation - 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 template
*/
readonly version: pulumi.Output<number>;
/**
* Create a CiscoOmpFeatureTemplate 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: CiscoOmpFeatureTemplateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CiscoOmpFeatureTemplate resources.
*/
export interface CiscoOmpFeatureTemplateState {
/**
* Advertise locally learned routes to OMP
*/
advertiseIpv4Routes?: pulumi.Input<pulumi.Input<inputs.CiscoOmpFeatureTemplateAdvertiseIpv4Route>[]>;
/**
* Advertise locally learned routes to OMP
*/
advertiseIpv6Routes?: pulumi.Input<pulumi.Input<inputs.CiscoOmpFeatureTemplateAdvertiseIpv6Route>[]>;
/**
* Set the time between OMP Update packets - Range: `0`-`65535` - Default value: `1`
*/
advertisementInterval?: pulumi.Input<number>;
/**
* Variable name
*/
advertisementIntervalVariable?: pulumi.Input<string>;
/**
* The description of the feature template
*/
description?: pulumi.Input<string>;
/**
* List of supported device types - Choices: `vedge-C8000V`, `vedge-C8300-1N1S-4T2X`, `vedge-C8300-1N1S-6T`,
* `vedge-C8300-2N2S-6T`, `vedge-C8300-2N2S-4T2X`, `vedge-C8500-12X4QC`, `vedge-C8500-12X`, `vedge-C8500-20X6C`,
* `vedge-C8500L-8S4X`, `vedge-C8200-1N-4T`, `vedge-C8200L-1N-4T`
*/
deviceTypes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Set maximum number of OMP paths to install in vEdge route table - Range: `1`-`16` - Default value: `4`
*/
ecmpLimit?: pulumi.Input<number>;
/**
* Variable name
*/
ecmpLimitVariable?: pulumi.Input<string>;
/**
* End of RIB timer <1..604800> seconds - Range: `1`-`3600` - Default value: `300`
*/
eorTimer?: pulumi.Input<number>;
/**
* Variable name
*/
eorTimerVariable?: pulumi.Input<string>;
/**
* Enable or disable OMP graceful restart - Default value: `true`
*/
gracefulRestart?: pulumi.Input<boolean>;
/**
* Set the OMP graceful restart timer - Range: `1`-`604800` - Default value: `43200`
*/
gracefulRestartTimer?: pulumi.Input<number>;
/**
* Variable name
*/
gracefulRestartTimerVariable?: pulumi.Input<string>;
/**
* Variable name
*/
gracefulRestartVariable?: pulumi.Input<string>;
/**
* Set how long to wait before closing OMP peer connection - Default value: `60`
*/
holdtime?: pulumi.Input<number>;
/**
* Variable name
*/
holdtimeVariable?: pulumi.Input<string>;
/**
* Ignore Region-Path Length During Best-Path Algorithm - Default value: `false`
*/
ignoreRegionPathLength?: pulumi.Input<boolean>;
/**
* Variable name
*/
ignoreRegionPathLengthVariable?: pulumi.Input<string>;
/**
* The name of the feature template
*/
name?: pulumi.Input<string>;
/**
* omp-admin-distance-ipv4 - Range: `1`-`255`
*/
ompAdminDistanceIpv4?: pulumi.Input<number>;
/**
* Variable name
*/
ompAdminDistanceIpv4Variable?: pulumi.Input<string>;
/**
* omp-admin-distance-ipv6 - Range: `1`-`255`
*/
ompAdminDistanceIpv6?: pulumi.Input<number>;
/**
* Variable name
*/
ompAdminDistanceIpv6Variable?: pulumi.Input<string>;
/**
* Set Overlay AS number <1..4294967295> or <XX.YY> - Range: `1`-`4294967295`
*/
overlayAs?: pulumi.Input<number>;
/**
* Variable name
*/
overlayAsVariable?: pulumi.Input<string>;
/**
* Set number of TLOC routes advertised between vSmart and vEdge - Range: `1`-`16` - Default value: `4`
*/
sendPathLimit?: pulumi.Input<number>;
/**
* Variable name
*/
sendPathLimitVariable?: pulumi.Input<string>;
/**
* Enable or disable OMP - Default value: `false`
*/
shutdown?: pulumi.Input<boolean>;
/**
* Variable name
*/
shutdownVariable?: pulumi.Input<string>;
/**
* The template type
*/
templateType?: pulumi.Input<string>;
/**
* Transport gateway path computation - Choices: `prefer`, `ecmp-with-direct-path`
*/
transportGateway?: pulumi.Input<string>;
/**
* Variable name
*/
transportGatewayVariable?: pulumi.Input<string>;
/**
* The version of the feature template
*/
version?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a CiscoOmpFeatureTemplate resource.
*/
export interface CiscoOmpFeatureTemplateArgs {
/**
* Advertise locally learned routes to OMP
*/
advertiseIpv4Routes?: pulumi.Input<pulumi.Input<inputs.CiscoOmpFeatureTemplateAdvertiseIpv4Route>[]>;
/**
* Advertise locally learned routes to OMP
*/
advertiseIpv6Routes?: pulumi.Input<pulumi.Input<inputs.CiscoOmpFeatureTemplateAdvertiseIpv6Route>[]>;
/**
* Set the time between OMP Update packets - Range: `0`-`65535` - Default value: `1`
*/
advertisementInterval?: pulumi.Input<number>;
/**
* Variable name
*/
advertisementIntervalVariable?: pulumi.Input<string>;
/**
* The description of the feature template
*/
description: pulumi.Input<string>;
/**
* List of supported device types - Choices: `vedge-C8000V`, `vedge-C8300-1N1S-4T2X`, `vedge-C8300-1N1S-6T`,
* `vedge-C8300-2N2S-6T`, `vedge-C8300-2N2S-4T2X`, `vedge-C8500-12X4QC`, `vedge-C8500-12X`, `vedge-C8500-20X6C`,
* `vedge-C8500L-8S4X`, `vedge-C8200-1N-4T`, `vedge-C8200L-1N-4T`
*/
deviceTypes: pulumi.Input<pulumi.Input<string>[]>;
/**
* Set maximum number of OMP paths to install in vEdge route table - Range: `1`-`16` - Default value: `4`
*/
ecmpLimit?: pulumi.Input<number>;
/**
* Variable name
*/
ecmpLimitVariable?: pulumi.Input<string>;
/**
* End of RIB timer <1..604800> seconds - Range: `1`-`3600` - Default value: `300`
*/
eorTimer?: pulumi.Input<number>;
/**
* Variable name
*/
eorTimerVariable?: pulumi.Input<string>;
/**
* Enable or disable OMP graceful restart - Default value: `true`
*/
gracefulRestart?: pulumi.Input<boolean>;
/**
* Set the OMP graceful restart timer - Range: `1`-`604800` - Default value: `43200`
*/
gracefulRestartTimer?: pulumi.Input<number>;
/**
* Variable name
*/
gracefulRestartTimerVariable?: pulumi.Input<string>;
/**
* Variable name
*/
gracefulRestartVariable?: pulumi.Input<string>;
/**
* Set how long to wait before closing OMP peer connection - Default value: `60`
*/
holdtime?: pulumi.Input<number>;
/**
* Variable name
*/
holdtimeVariable?: pulumi.Input<string>;
/**
* Ignore Region-Path Length During Best-Path Algorithm - Default value: `false`
*/
ignoreRegionPathLength?: pulumi.Input<boolean>;
/**
* Variable name
*/
ignoreRegionPathLengthVariable?: pulumi.Input<string>;
/**
* The name of the feature template
*/
name?: pulumi.Input<string>;
/**
* omp-admin-distance-ipv4 - Range: `1`-`255`
*/
ompAdminDistanceIpv4?: pulumi.Input<number>;
/**
* Variable name
*/
ompAdminDistanceIpv4Variable?: pulumi.Input<string>;
/**
* omp-admin-distance-ipv6 - Range: `1`-`255`
*/
ompAdminDistanceIpv6?: pulumi.Input<number>;
/**
* Variable name
*/
ompAdminDistanceIpv6Variable?: pulumi.Input<string>;
/**
* Set Overlay AS number <1..4294967295> or <XX.YY> - Range: `1`-`4294967295`
*/
overlayAs?: pulumi.Input<number>;
/**
* Variable name
*/
overlayAsVariable?: pulumi.Input<string>;
/**
* Set number of TLOC routes advertised between vSmart and vEdge - Range: `1`-`16` - Default value: `4`
*/
sendPathLimit?: pulumi.Input<number>;
/**
* Variable name
*/
sendPathLimitVariable?: pulumi.Input<string>;
/**
* Enable or disable OMP - Default value: `false`
*/
shutdown?: pulumi.Input<boolean>;
/**
* Variable name
*/
shutdownVariable?: pulumi.Input<string>;
/**
* Transport gateway path computation - Choices: `prefer`, `ecmp-with-direct-path`
*/
transportGateway?: pulumi.Input<string>;
/**
* Variable name
*/
transportGatewayVariable?: pulumi.Input<string>;
}