@pulumi/sdwan
Version:
A Pulumi package for managing resources on Cisco Catalyst SD-WAN.. Based on terraform-provider-sdwan: version v0.4.1
551 lines (550 loc) • 16.9 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 Service Routing OSPF 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.ServiceRoutingOspfFeature("example", {
* name: "Example",
* description: "My Example",
* featureProfileId: "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
* routerId: "1.2.3.4",
* referenceBandwidth: 101,
* rfc1583Compatible: true,
* defaultInformationOriginate: false,
* defaultInformationOriginateAlways: false,
* defaultInformationOriginateMetric: 1,
* defaultInformationOriginateMetricType: "type1",
* distanceExternal: 110,
* distanceInterArea: 110,
* distanceIntraArea: 110,
* spfCalculationDelay: 200,
* spfInitialHoldTime: 1000,
* spfMaximumHoldTime: 10000,
* redistributes: [{
* protocol: "static",
* natDia: true,
* }],
* routerLsas: [{
* type: "on-startup",
* time: 5,
* }],
* areas: [{
* areaNumber: 1,
* areaType: "stub",
* noSummary: false,
* interfaces: [{
* name: "GigabitEthernet2",
* helloInterval: 10,
* deadInterval: 40,
* lsaRetransmitInterval: 5,
* cost: 10,
* designatedRouterPriority: 1,
* networkType: "broadcast",
* passiveInterface: false,
* authenticationType: "message-digest",
* messageDigestKeyId: 7,
* messageDigestKey: "sdjfhsghbjdjr",
* }],
* ranges: [{
* ipAddress: "10.1.1.0",
* subnetMask: "255.255.255.0",
* cost: 1,
* noAdvertise: false,
* }],
* }],
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Expected import identifier with the format: "service_routing_ospf_feature_id,feature_profile_id"
*
* ```sh
* $ pulumi import sdwan:index/serviceRoutingOspfFeature:ServiceRoutingOspfFeature example "f6b2c44c-693c-4763-b010-895aa3d236bd,f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"
* ```
*/
export declare class ServiceRoutingOspfFeature extends pulumi.CustomResource {
/**
* Get an existing ServiceRoutingOspfFeature 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?: ServiceRoutingOspfFeatureState, opts?: pulumi.CustomResourceOptions): ServiceRoutingOspfFeature;
/**
* Returns true if the given object is an instance of ServiceRoutingOspfFeature. 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 ServiceRoutingOspfFeature;
/**
* Configure OSPF area
*/
readonly areas: pulumi.Output<outputs.ServiceRoutingOspfFeatureArea[] | undefined>;
/**
* Distribute default external route into OSPF
* - Default value: `false`
*/
readonly defaultInformationOriginate: pulumi.Output<boolean | undefined>;
/**
* Always advertise default route
* - Default value: `false`
*/
readonly defaultInformationOriginateAlways: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly defaultInformationOriginateAlwaysVariable: pulumi.Output<string | undefined>;
/**
* Set metric used to generate default route <0..16777214>
* - Range: `0`-`16777214`
*/
readonly defaultInformationOriginateMetric: pulumi.Output<number | undefined>;
/**
* Set default route type
* - Choices: `type1`, `type2`
*/
readonly defaultInformationOriginateMetricType: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly defaultInformationOriginateMetricTypeVariable: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly defaultInformationOriginateMetricVariable: pulumi.Output<string | undefined>;
/**
* The description of the Feature
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Set distance for external routes
* - Range: `1`-`255`
* - Default value: `110`
*/
readonly distanceExternal: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly distanceExternalVariable: pulumi.Output<string | undefined>;
/**
* Set distance for inter-area routes
* - Range: `1`-`255`
* - Default value: `110`
*/
readonly distanceInterArea: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly distanceInterAreaVariable: pulumi.Output<string | undefined>;
/**
* Set distance for intra-area routes
* - Range: `1`-`255`
* - Default value: `110`
*/
readonly distanceIntraArea: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly distanceIntraAreaVariable: pulumi.Output<string | undefined>;
/**
* Feature Profile ID
*/
readonly featureProfileId: pulumi.Output<string>;
/**
* The name of the Feature
*/
readonly name: pulumi.Output<string>;
/**
* Redistribute routes
*/
readonly redistributes: pulumi.Output<outputs.ServiceRoutingOspfFeatureRedistribute[] | undefined>;
/**
* Set reference bandwidth method to assign OSPF cost
* - Range: `1`-`4294967`
* - Default value: `100`
*/
readonly referenceBandwidth: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly referenceBandwidthVariable: pulumi.Output<string | undefined>;
/**
* Calculate summary route cost based on RFC 1583
* - Default value: `true`
*/
readonly rfc1583Compatible: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly rfc1583CompatibleVariable: pulumi.Output<string | undefined>;
readonly routePolicyId: pulumi.Output<string | undefined>;
/**
* Set OSPF router ID to override system IP address
*/
readonly routerId: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly routerIdVariable: pulumi.Output<string | undefined>;
/**
* Advertise own router LSA with infinite distance
*/
readonly routerLsas: pulumi.Output<outputs.ServiceRoutingOspfFeatureRouterLsa[] | undefined>;
/**
* Set delay from first change received until performing SPF calculation
* - Range: `1`-`600000`
* - Default value: `200`
*/
readonly spfCalculationDelay: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly spfCalculationDelayVariable: pulumi.Output<string | undefined>;
/**
* Set initial hold time between consecutive SPF calculations
* - Range: `1`-`600000`
* - Default value: `1000`
*/
readonly spfInitialHoldTime: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly spfInitialHoldTimeVariable: pulumi.Output<string | undefined>;
/**
* Set maximum hold time between consecutive SPF calculations
* - Range: `1`-`600000`
* - Default value: `10000`
*/
readonly spfMaximumHoldTime: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly spfMaximumHoldTimeVariable: pulumi.Output<string | undefined>;
/**
* The version of the Feature
*/
readonly version: pulumi.Output<number>;
/**
* Create a ServiceRoutingOspfFeature 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: ServiceRoutingOspfFeatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ServiceRoutingOspfFeature resources.
*/
export interface ServiceRoutingOspfFeatureState {
/**
* Configure OSPF area
*/
areas?: pulumi.Input<pulumi.Input<inputs.ServiceRoutingOspfFeatureArea>[]>;
/**
* Distribute default external route into OSPF
* - Default value: `false`
*/
defaultInformationOriginate?: pulumi.Input<boolean>;
/**
* Always advertise default route
* - Default value: `false`
*/
defaultInformationOriginateAlways?: pulumi.Input<boolean>;
/**
* Variable name
*/
defaultInformationOriginateAlwaysVariable?: pulumi.Input<string>;
/**
* Set metric used to generate default route <0..16777214>
* - Range: `0`-`16777214`
*/
defaultInformationOriginateMetric?: pulumi.Input<number>;
/**
* Set default route type
* - Choices: `type1`, `type2`
*/
defaultInformationOriginateMetricType?: pulumi.Input<string>;
/**
* Variable name
*/
defaultInformationOriginateMetricTypeVariable?: pulumi.Input<string>;
/**
* Variable name
*/
defaultInformationOriginateMetricVariable?: pulumi.Input<string>;
/**
* The description of the Feature
*/
description?: pulumi.Input<string>;
/**
* Set distance for external routes
* - Range: `1`-`255`
* - Default value: `110`
*/
distanceExternal?: pulumi.Input<number>;
/**
* Variable name
*/
distanceExternalVariable?: pulumi.Input<string>;
/**
* Set distance for inter-area routes
* - Range: `1`-`255`
* - Default value: `110`
*/
distanceInterArea?: pulumi.Input<number>;
/**
* Variable name
*/
distanceInterAreaVariable?: pulumi.Input<string>;
/**
* Set distance for intra-area routes
* - Range: `1`-`255`
* - Default value: `110`
*/
distanceIntraArea?: pulumi.Input<number>;
/**
* Variable name
*/
distanceIntraAreaVariable?: pulumi.Input<string>;
/**
* Feature Profile ID
*/
featureProfileId?: pulumi.Input<string>;
/**
* The name of the Feature
*/
name?: pulumi.Input<string>;
/**
* Redistribute routes
*/
redistributes?: pulumi.Input<pulumi.Input<inputs.ServiceRoutingOspfFeatureRedistribute>[]>;
/**
* Set reference bandwidth method to assign OSPF cost
* - Range: `1`-`4294967`
* - Default value: `100`
*/
referenceBandwidth?: pulumi.Input<number>;
/**
* Variable name
*/
referenceBandwidthVariable?: pulumi.Input<string>;
/**
* Calculate summary route cost based on RFC 1583
* - Default value: `true`
*/
rfc1583Compatible?: pulumi.Input<boolean>;
/**
* Variable name
*/
rfc1583CompatibleVariable?: pulumi.Input<string>;
routePolicyId?: pulumi.Input<string>;
/**
* Set OSPF router ID to override system IP address
*/
routerId?: pulumi.Input<string>;
/**
* Variable name
*/
routerIdVariable?: pulumi.Input<string>;
/**
* Advertise own router LSA with infinite distance
*/
routerLsas?: pulumi.Input<pulumi.Input<inputs.ServiceRoutingOspfFeatureRouterLsa>[]>;
/**
* Set delay from first change received until performing SPF calculation
* - Range: `1`-`600000`
* - Default value: `200`
*/
spfCalculationDelay?: pulumi.Input<number>;
/**
* Variable name
*/
spfCalculationDelayVariable?: pulumi.Input<string>;
/**
* Set initial hold time between consecutive SPF calculations
* - Range: `1`-`600000`
* - Default value: `1000`
*/
spfInitialHoldTime?: pulumi.Input<number>;
/**
* Variable name
*/
spfInitialHoldTimeVariable?: pulumi.Input<string>;
/**
* Set maximum hold time between consecutive SPF calculations
* - Range: `1`-`600000`
* - Default value: `10000`
*/
spfMaximumHoldTime?: pulumi.Input<number>;
/**
* Variable name
*/
spfMaximumHoldTimeVariable?: pulumi.Input<string>;
/**
* The version of the Feature
*/
version?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a ServiceRoutingOspfFeature resource.
*/
export interface ServiceRoutingOspfFeatureArgs {
/**
* Configure OSPF area
*/
areas?: pulumi.Input<pulumi.Input<inputs.ServiceRoutingOspfFeatureArea>[]>;
/**
* Distribute default external route into OSPF
* - Default value: `false`
*/
defaultInformationOriginate?: pulumi.Input<boolean>;
/**
* Always advertise default route
* - Default value: `false`
*/
defaultInformationOriginateAlways?: pulumi.Input<boolean>;
/**
* Variable name
*/
defaultInformationOriginateAlwaysVariable?: pulumi.Input<string>;
/**
* Set metric used to generate default route <0..16777214>
* - Range: `0`-`16777214`
*/
defaultInformationOriginateMetric?: pulumi.Input<number>;
/**
* Set default route type
* - Choices: `type1`, `type2`
*/
defaultInformationOriginateMetricType?: pulumi.Input<string>;
/**
* Variable name
*/
defaultInformationOriginateMetricTypeVariable?: pulumi.Input<string>;
/**
* Variable name
*/
defaultInformationOriginateMetricVariable?: pulumi.Input<string>;
/**
* The description of the Feature
*/
description?: pulumi.Input<string>;
/**
* Set distance for external routes
* - Range: `1`-`255`
* - Default value: `110`
*/
distanceExternal?: pulumi.Input<number>;
/**
* Variable name
*/
distanceExternalVariable?: pulumi.Input<string>;
/**
* Set distance for inter-area routes
* - Range: `1`-`255`
* - Default value: `110`
*/
distanceInterArea?: pulumi.Input<number>;
/**
* Variable name
*/
distanceInterAreaVariable?: pulumi.Input<string>;
/**
* Set distance for intra-area routes
* - Range: `1`-`255`
* - Default value: `110`
*/
distanceIntraArea?: pulumi.Input<number>;
/**
* Variable name
*/
distanceIntraAreaVariable?: pulumi.Input<string>;
/**
* Feature Profile ID
*/
featureProfileId: pulumi.Input<string>;
/**
* The name of the Feature
*/
name?: pulumi.Input<string>;
/**
* Redistribute routes
*/
redistributes?: pulumi.Input<pulumi.Input<inputs.ServiceRoutingOspfFeatureRedistribute>[]>;
/**
* Set reference bandwidth method to assign OSPF cost
* - Range: `1`-`4294967`
* - Default value: `100`
*/
referenceBandwidth?: pulumi.Input<number>;
/**
* Variable name
*/
referenceBandwidthVariable?: pulumi.Input<string>;
/**
* Calculate summary route cost based on RFC 1583
* - Default value: `true`
*/
rfc1583Compatible?: pulumi.Input<boolean>;
/**
* Variable name
*/
rfc1583CompatibleVariable?: pulumi.Input<string>;
routePolicyId?: pulumi.Input<string>;
/**
* Set OSPF router ID to override system IP address
*/
routerId?: pulumi.Input<string>;
/**
* Variable name
*/
routerIdVariable?: pulumi.Input<string>;
/**
* Advertise own router LSA with infinite distance
*/
routerLsas?: pulumi.Input<pulumi.Input<inputs.ServiceRoutingOspfFeatureRouterLsa>[]>;
/**
* Set delay from first change received until performing SPF calculation
* - Range: `1`-`600000`
* - Default value: `200`
*/
spfCalculationDelay?: pulumi.Input<number>;
/**
* Variable name
*/
spfCalculationDelayVariable?: pulumi.Input<string>;
/**
* Set initial hold time between consecutive SPF calculations
* - Range: `1`-`600000`
* - Default value: `1000`
*/
spfInitialHoldTime?: pulumi.Input<number>;
/**
* Variable name
*/
spfInitialHoldTimeVariable?: pulumi.Input<string>;
/**
* Set maximum hold time between consecutive SPF calculations
* - Range: `1`-`600000`
* - Default value: `10000`
*/
spfMaximumHoldTime?: pulumi.Input<number>;
/**
* Variable name
*/
spfMaximumHoldTimeVariable?: pulumi.Input<string>;
}