@pulumi/sdwan
Version:
A Pulumi package for managing resources on Cisco Catalyst SD-WAN.. Based on terraform-provider-sdwan: version v0.4.1
625 lines (624 loc) • 18.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 OSPFv3 IPv4 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.ServiceRoutingOspfv3Ipv4Feature("example", {
* name: "Example",
* description: "My Example",
* featureProfileId: "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
* routerId: "1.2.3.4",
* distance: 110,
* distanceExternal: 110,
* distanceInterArea: 110,
* distanceIntraArea: 110,
* referenceBandwidth: 101,
* rfc1583Compatible: true,
* defaultInformationOriginate: false,
* defaultInformationOriginateAlways: false,
* defaultInformationOriginateMetric: 1,
* defaultInformationOriginateMetricType: "type1",
* spfCalculationDelay: 200,
* spfInitialHoldTime: 1000,
* spfMaximumHoldTime: 10000,
* filter: false,
* redistributes: [{
* protocol: "nat-route",
* natDia: true,
* }],
* routerLsaAction: "on-startup",
* routerLsaOnStartupTime: 30,
* areas: [{
* areaNumber: 1,
* areaType: "stub",
* interfaces: [{
* name: "GigabitEthernet2",
* helloInterval: 10,
* deadInterval: 40,
* lsaRetransmitInterval: 5,
* cost: 10,
* networkType: "broadcast",
* passiveInterface: false,
* authenticationType: "no-auth",
* }],
* 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_ospfv3_ipv4_feature_id,feature_profile_id"
*
* ```sh
* $ pulumi import sdwan:index/serviceRoutingOspfv3Ipv4Feature:ServiceRoutingOspfv3Ipv4Feature example "f6b2c44c-693c-4763-b010-895aa3d236bd,f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"
* ```
*/
export declare class ServiceRoutingOspfv3Ipv4Feature extends pulumi.CustomResource {
/**
* Get an existing ServiceRoutingOspfv3Ipv4Feature 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?: ServiceRoutingOspfv3Ipv4FeatureState, opts?: pulumi.CustomResourceOptions): ServiceRoutingOspfv3Ipv4Feature;
/**
* Returns true if the given object is an instance of ServiceRoutingOspfv3Ipv4Feature. 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 ServiceRoutingOspfv3Ipv4Feature;
/**
* Configure OSPFv3 IPv4 area
*/
readonly areas: pulumi.Output<outputs.ServiceRoutingOspfv3Ipv4FeatureArea[] | undefined>;
/**
* Distribute default external route into OSPF disabled
*/
readonly defaultInformationOriginate: pulumi.Output<boolean | undefined>;
/**
* Always advertise default route
*/
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 metric 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>;
/**
* Distance
* - Range: `1`-`255`
* - Default value: `110`
*/
readonly distance: pulumi.Output<number | undefined>;
/**
* Set distance for external routes
* - Range: `1`-`254`
* - 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`-`254`
* - 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`-`254`
* - Default value: `110`
*/
readonly distanceIntraArea: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly distanceIntraAreaVariable: pulumi.Output<string | undefined>;
/**
* Variable name
*/
readonly distanceVariable: pulumi.Output<string | undefined>;
/**
* Feature Profile ID
*/
readonly featureProfileId: pulumi.Output<string>;
/**
* Table map filtered or not
* - Default value: `false`
*/
readonly filter: pulumi.Output<boolean | undefined>;
/**
* Variable name
*/
readonly filterVariable: pulumi.Output<string | undefined>;
/**
* The name of the Feature
*/
readonly name: pulumi.Output<string>;
/**
* Redistribute routes
*/
readonly redistributes: pulumi.Output<outputs.ServiceRoutingOspfv3Ipv4FeatureRedistribute[] | 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>;
/**
* Not advertise maximum metric Router LSA policy by default
*/
readonly routerLsaAction: pulumi.Output<string | undefined>;
/**
* Set how long to advertise maximum metric after router boot up
* - Range: `5`-`86400`
*/
readonly routerLsaOnStartupTime: pulumi.Output<number | undefined>;
/**
* Variable name
*/
readonly routerLsaOnStartupTimeVariable: pulumi.Output<string | 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 ServiceRoutingOspfv3Ipv4Feature 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: ServiceRoutingOspfv3Ipv4FeatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ServiceRoutingOspfv3Ipv4Feature resources.
*/
export interface ServiceRoutingOspfv3Ipv4FeatureState {
/**
* Configure OSPFv3 IPv4 area
*/
areas?: pulumi.Input<pulumi.Input<inputs.ServiceRoutingOspfv3Ipv4FeatureArea>[]>;
/**
* Distribute default external route into OSPF disabled
*/
defaultInformationOriginate?: pulumi.Input<boolean>;
/**
* Always advertise default route
*/
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 metric 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>;
/**
* Distance
* - Range: `1`-`255`
* - Default value: `110`
*/
distance?: pulumi.Input<number>;
/**
* Set distance for external routes
* - Range: `1`-`254`
* - Default value: `110`
*/
distanceExternal?: pulumi.Input<number>;
/**
* Variable name
*/
distanceExternalVariable?: pulumi.Input<string>;
/**
* Set distance for inter-area routes
* - Range: `1`-`254`
* - Default value: `110`
*/
distanceInterArea?: pulumi.Input<number>;
/**
* Variable name
*/
distanceInterAreaVariable?: pulumi.Input<string>;
/**
* Set distance for intra-area routes
* - Range: `1`-`254`
* - Default value: `110`
*/
distanceIntraArea?: pulumi.Input<number>;
/**
* Variable name
*/
distanceIntraAreaVariable?: pulumi.Input<string>;
/**
* Variable name
*/
distanceVariable?: pulumi.Input<string>;
/**
* Feature Profile ID
*/
featureProfileId?: pulumi.Input<string>;
/**
* Table map filtered or not
* - Default value: `false`
*/
filter?: pulumi.Input<boolean>;
/**
* Variable name
*/
filterVariable?: pulumi.Input<string>;
/**
* The name of the Feature
*/
name?: pulumi.Input<string>;
/**
* Redistribute routes
*/
redistributes?: pulumi.Input<pulumi.Input<inputs.ServiceRoutingOspfv3Ipv4FeatureRedistribute>[]>;
/**
* 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>;
/**
* Not advertise maximum metric Router LSA policy by default
*/
routerLsaAction?: pulumi.Input<string>;
/**
* Set how long to advertise maximum metric after router boot up
* - Range: `5`-`86400`
*/
routerLsaOnStartupTime?: pulumi.Input<number>;
/**
* Variable name
*/
routerLsaOnStartupTimeVariable?: pulumi.Input<string>;
/**
* 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 ServiceRoutingOspfv3Ipv4Feature resource.
*/
export interface ServiceRoutingOspfv3Ipv4FeatureArgs {
/**
* Configure OSPFv3 IPv4 area
*/
areas?: pulumi.Input<pulumi.Input<inputs.ServiceRoutingOspfv3Ipv4FeatureArea>[]>;
/**
* Distribute default external route into OSPF disabled
*/
defaultInformationOriginate?: pulumi.Input<boolean>;
/**
* Always advertise default route
*/
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 metric 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>;
/**
* Distance
* - Range: `1`-`255`
* - Default value: `110`
*/
distance?: pulumi.Input<number>;
/**
* Set distance for external routes
* - Range: `1`-`254`
* - Default value: `110`
*/
distanceExternal?: pulumi.Input<number>;
/**
* Variable name
*/
distanceExternalVariable?: pulumi.Input<string>;
/**
* Set distance for inter-area routes
* - Range: `1`-`254`
* - Default value: `110`
*/
distanceInterArea?: pulumi.Input<number>;
/**
* Variable name
*/
distanceInterAreaVariable?: pulumi.Input<string>;
/**
* Set distance for intra-area routes
* - Range: `1`-`254`
* - Default value: `110`
*/
distanceIntraArea?: pulumi.Input<number>;
/**
* Variable name
*/
distanceIntraAreaVariable?: pulumi.Input<string>;
/**
* Variable name
*/
distanceVariable?: pulumi.Input<string>;
/**
* Feature Profile ID
*/
featureProfileId: pulumi.Input<string>;
/**
* Table map filtered or not
* - Default value: `false`
*/
filter?: pulumi.Input<boolean>;
/**
* Variable name
*/
filterVariable?: pulumi.Input<string>;
/**
* The name of the Feature
*/
name?: pulumi.Input<string>;
/**
* Redistribute routes
*/
redistributes?: pulumi.Input<pulumi.Input<inputs.ServiceRoutingOspfv3Ipv4FeatureRedistribute>[]>;
/**
* 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>;
/**
* Not advertise maximum metric Router LSA policy by default
*/
routerLsaAction?: pulumi.Input<string>;
/**
* Set how long to advertise maximum metric after router boot up
* - Range: `5`-`86400`
*/
routerLsaOnStartupTime?: pulumi.Input<number>;
/**
* Variable name
*/
routerLsaOnStartupTimeVariable?: pulumi.Input<string>;
/**
* 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>;
}