@pulumi/ise
Version:
A Pulumi package for managing resources on a Cisco ISE (Identity Service Engine) instance.. Based on terraform-provider-ise: version v0.2.1
309 lines (308 loc) • 12.3 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 Device Admin Authentication Rule.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as ise from "@pulumi/ise";
*
* const example = new ise.deviceadmin.AuthenticationRule("example", {
* policySetId: "d82952cb-b901-4b09-b363-5ebf39bdbaf9",
* name: "Rule1",
* "default": false,
* rank: 0,
* state: "enabled",
* conditionType: "ConditionAttributes",
* conditionIsNegate: false,
* conditionAttributeName: "Location",
* conditionAttributeValue: "All Locations",
* conditionDictionaryName: "DEVICE",
* conditionOperator: "equals",
* identitySourceName: "Internal Endpoints",
* ifAuthFail: "REJECT",
* ifProcessFail: "DROP",
* ifUserNotFound: "REJECT",
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* ```sh
* $ pulumi import ise:deviceadmin/authenticationRule:AuthenticationRule example "76d24097-41c4-4558-a4d0-a8c07ac08470,76d24097-41c4-4558-a4d0-a8c07ac08470"
* ```
*/
export declare class AuthenticationRule extends pulumi.CustomResource {
/**
* Get an existing AuthenticationRule 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?: AuthenticationRuleState, opts?: pulumi.CustomResourceOptions): AuthenticationRule;
/**
* Returns true if the given object is an instance of AuthenticationRule. 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 AuthenticationRule;
/**
* List of child conditions. `conditionType` must be one of `ConditionAndBlock` or `ConditionOrBlock`.
*/
readonly childrens: pulumi.Output<outputs.deviceadmin.AuthenticationRuleChildren[] | undefined>;
/**
* Dictionary attribute name
*/
readonly conditionAttributeName: pulumi.Output<string | undefined>;
/**
* Attribute value for condition. Value type is specified in dictionary object.
*/
readonly conditionAttributeValue: pulumi.Output<string | undefined>;
/**
* Dictionary name
*/
readonly conditionDictionaryName: pulumi.Output<string | undefined>;
/**
* Dictionary value
*/
readonly conditionDictionaryValue: pulumi.Output<string | undefined>;
/**
* UUID for condition
*/
readonly conditionId: pulumi.Output<string | undefined>;
/**
* Indicates whereas this condition is in negate mode
*/
readonly conditionIsNegate: pulumi.Output<boolean | undefined>;
/**
* Equality operator
* - Choices: `contains`, `endsWith`, `equals`, `greaterOrEquals`, `greaterThan`, `in`, `ipEquals`, `ipGreaterThan`, `ipLessThan`, `ipNotEquals`, `lessOrEquals`, `lessThan`, `matches`, `notContains`, `notEndsWith`, `notEquals`, `notIn`, `notStartsWith`, `startsWith`, `macContains`, `macEndsWith`, `macEquals`, `macIn`, `macNotContains`, `macNotEndsWith`, `macNotEquals`, `macNotIn`, `macNotStartsWith`, `macStartsWith`
*/
readonly conditionOperator: pulumi.Output<string | undefined>;
/**
* Indicates whether the record is the condition itself or a logical aggregation. Logical aggreation indicates that additional conditions are present under the children attribute.
* - Choices: `ConditionAndBlock`, `ConditionAttributes`, `ConditionOrBlock`, `ConditionReference`
*/
readonly conditionType: pulumi.Output<string | undefined>;
/**
* Indicates if this rule is the default one
*/
readonly default: pulumi.Output<boolean | undefined>;
/**
* Identity source name from the identity stores
*/
readonly identitySourceName: pulumi.Output<string | undefined>;
/**
* Action to perform when authentication fails such as Bad credentials, disabled user and so on
* - Choices: `REJECT`, `DROP`, `CONTINUE`
*/
readonly ifAuthFail: pulumi.Output<string>;
/**
* Action to perform when ISE is unable to access the identity database
* - Choices: `REJECT`, `DROP`, `CONTINUE`
*/
readonly ifProcessFail: pulumi.Output<string>;
/**
* Action to perform when user is not found in any of identity stores
* - Choices: `REJECT`, `DROP`, `CONTINUE`
*/
readonly ifUserNotFound: pulumi.Output<string>;
/**
* Rule name, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses]
*/
readonly name: pulumi.Output<string>;
/**
* Policy set ID
*/
readonly policySetId: pulumi.Output<string>;
/**
* The rank (priority) in relation to other rules. Lower rank is higher priority.
*/
readonly rank: pulumi.Output<number | undefined>;
/**
* The state that the rule is in. A disabled rule cannot be matched.
* - Choices: `disabled`, `enabled`, `monitor`
*/
readonly state: pulumi.Output<string | undefined>;
/**
* Create a AuthenticationRule 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: AuthenticationRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AuthenticationRule resources.
*/
export interface AuthenticationRuleState {
/**
* List of child conditions. `conditionType` must be one of `ConditionAndBlock` or `ConditionOrBlock`.
*/
childrens?: pulumi.Input<pulumi.Input<inputs.deviceadmin.AuthenticationRuleChildren>[]>;
/**
* Dictionary attribute name
*/
conditionAttributeName?: pulumi.Input<string>;
/**
* Attribute value for condition. Value type is specified in dictionary object.
*/
conditionAttributeValue?: pulumi.Input<string>;
/**
* Dictionary name
*/
conditionDictionaryName?: pulumi.Input<string>;
/**
* Dictionary value
*/
conditionDictionaryValue?: pulumi.Input<string>;
/**
* UUID for condition
*/
conditionId?: pulumi.Input<string>;
/**
* Indicates whereas this condition is in negate mode
*/
conditionIsNegate?: pulumi.Input<boolean>;
/**
* Equality operator
* - Choices: `contains`, `endsWith`, `equals`, `greaterOrEquals`, `greaterThan`, `in`, `ipEquals`, `ipGreaterThan`, `ipLessThan`, `ipNotEquals`, `lessOrEquals`, `lessThan`, `matches`, `notContains`, `notEndsWith`, `notEquals`, `notIn`, `notStartsWith`, `startsWith`, `macContains`, `macEndsWith`, `macEquals`, `macIn`, `macNotContains`, `macNotEndsWith`, `macNotEquals`, `macNotIn`, `macNotStartsWith`, `macStartsWith`
*/
conditionOperator?: pulumi.Input<string>;
/**
* Indicates whether the record is the condition itself or a logical aggregation. Logical aggreation indicates that additional conditions are present under the children attribute.
* - Choices: `ConditionAndBlock`, `ConditionAttributes`, `ConditionOrBlock`, `ConditionReference`
*/
conditionType?: pulumi.Input<string>;
/**
* Indicates if this rule is the default one
*/
default?: pulumi.Input<boolean>;
/**
* Identity source name from the identity stores
*/
identitySourceName?: pulumi.Input<string>;
/**
* Action to perform when authentication fails such as Bad credentials, disabled user and so on
* - Choices: `REJECT`, `DROP`, `CONTINUE`
*/
ifAuthFail?: pulumi.Input<string>;
/**
* Action to perform when ISE is unable to access the identity database
* - Choices: `REJECT`, `DROP`, `CONTINUE`
*/
ifProcessFail?: pulumi.Input<string>;
/**
* Action to perform when user is not found in any of identity stores
* - Choices: `REJECT`, `DROP`, `CONTINUE`
*/
ifUserNotFound?: pulumi.Input<string>;
/**
* Rule name, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses]
*/
name?: pulumi.Input<string>;
/**
* Policy set ID
*/
policySetId?: pulumi.Input<string>;
/**
* The rank (priority) in relation to other rules. Lower rank is higher priority.
*/
rank?: pulumi.Input<number>;
/**
* The state that the rule is in. A disabled rule cannot be matched.
* - Choices: `disabled`, `enabled`, `monitor`
*/
state?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AuthenticationRule resource.
*/
export interface AuthenticationRuleArgs {
/**
* List of child conditions. `conditionType` must be one of `ConditionAndBlock` or `ConditionOrBlock`.
*/
childrens?: pulumi.Input<pulumi.Input<inputs.deviceadmin.AuthenticationRuleChildren>[]>;
/**
* Dictionary attribute name
*/
conditionAttributeName?: pulumi.Input<string>;
/**
* Attribute value for condition. Value type is specified in dictionary object.
*/
conditionAttributeValue?: pulumi.Input<string>;
/**
* Dictionary name
*/
conditionDictionaryName?: pulumi.Input<string>;
/**
* Dictionary value
*/
conditionDictionaryValue?: pulumi.Input<string>;
/**
* UUID for condition
*/
conditionId?: pulumi.Input<string>;
/**
* Indicates whereas this condition is in negate mode
*/
conditionIsNegate?: pulumi.Input<boolean>;
/**
* Equality operator
* - Choices: `contains`, `endsWith`, `equals`, `greaterOrEquals`, `greaterThan`, `in`, `ipEquals`, `ipGreaterThan`, `ipLessThan`, `ipNotEquals`, `lessOrEquals`, `lessThan`, `matches`, `notContains`, `notEndsWith`, `notEquals`, `notIn`, `notStartsWith`, `startsWith`, `macContains`, `macEndsWith`, `macEquals`, `macIn`, `macNotContains`, `macNotEndsWith`, `macNotEquals`, `macNotIn`, `macNotStartsWith`, `macStartsWith`
*/
conditionOperator?: pulumi.Input<string>;
/**
* Indicates whether the record is the condition itself or a logical aggregation. Logical aggreation indicates that additional conditions are present under the children attribute.
* - Choices: `ConditionAndBlock`, `ConditionAttributes`, `ConditionOrBlock`, `ConditionReference`
*/
conditionType?: pulumi.Input<string>;
/**
* Indicates if this rule is the default one
*/
default?: pulumi.Input<boolean>;
/**
* Identity source name from the identity stores
*/
identitySourceName?: pulumi.Input<string>;
/**
* Action to perform when authentication fails such as Bad credentials, disabled user and so on
* - Choices: `REJECT`, `DROP`, `CONTINUE`
*/
ifAuthFail: pulumi.Input<string>;
/**
* Action to perform when ISE is unable to access the identity database
* - Choices: `REJECT`, `DROP`, `CONTINUE`
*/
ifProcessFail: pulumi.Input<string>;
/**
* Action to perform when user is not found in any of identity stores
* - Choices: `REJECT`, `DROP`, `CONTINUE`
*/
ifUserNotFound: pulumi.Input<string>;
/**
* Rule name, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses]
*/
name?: pulumi.Input<string>;
/**
* Policy set ID
*/
policySetId: pulumi.Input<string>;
/**
* The rank (priority) in relation to other rules. Lower rank is higher priority.
*/
rank?: pulumi.Input<number>;
/**
* The state that the rule is in. A disabled rule cannot be matched.
* - Choices: `disabled`, `enabled`, `monitor`
*/
state?: pulumi.Input<string>;
}