@pulumiverse/fortios/user/peer.d.ts

A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0

import * as pulumi from "@pulumi/pulumi";
/**
 * Configure peer users.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fortios from "@pulumiverse/fortios";
 *
 * const trname1 = new fortios.user.Peer("trname1", {
 *     ca: "EC-ACC",
 *     cnType: "string",
 *     ldapMode: "password",
 *     mandatoryCaVerify: "enable",
 *     twoFactor: "disable",
 * });
 * ```
 *
 * ## Import
 *
 * User Peer can be imported using any of these accepted formats:
 *
 * ```sh
 * $ pulumi import fortios:user/peer:Peer labelname {{name}}
 * ```
 *
 * If you do not want to import arguments of block:
 *
 * $ export "FORTIOS_IMPORT_TABLE"="false"
 *
 * ```sh
 * $ pulumi import fortios:user/peer:Peer labelname {{name}}
 * ```
 *
 * $ unset "FORTIOS_IMPORT_TABLE"
 */
export declare class Peer extends pulumi.CustomResource {
    /**
     * Get an existing Peer 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?: PeerState, opts?: pulumi.CustomResourceOptions): Peer;
    /**
     * Returns true if the given object is an instance of Peer.  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 Peer;
    /**
     * Name of the CA certificate as returned by the execute vpn certificate ca list command.
     */
    readonly ca: pulumi.Output<string>;
    /**
     * Peer certificate common name.
     */
    readonly cn: pulumi.Output<string>;
    /**
     * Peer certificate common name type. Valid values: `string`, `email`, `FQDN`, `ipv4`, `ipv6`.
     */
    readonly cnType: pulumi.Output<string>;
    /**
     * Mode for LDAP peer authentication. Valid values: `password`, `principal-name`.
     */
    readonly ldapMode: pulumi.Output<string>;
    /**
     * Password for LDAP server bind.
     */
    readonly ldapPassword: pulumi.Output<string | undefined>;
    /**
     * Name of an LDAP server defined under the user ldap command. Performs client access rights check.
     */
    readonly ldapServer: pulumi.Output<string>;
    /**
     * Username for LDAP server bind.
     */
    readonly ldapUsername: pulumi.Output<string>;
    /**
     * Determine what happens to the peer if the CA certificate is not installed. Disable to automatically consider the peer certificate as valid. Valid values: `enable`, `disable`.
     */
    readonly mandatoryCaVerify: pulumi.Output<string>;
    /**
     * MFA mode for remote peer authentication/authorization. Valid values: `none`, `password`, `subject-identity`.
     */
    readonly mfaMode: pulumi.Output<string>;
    /**
     * Unified password for remote authentication. This field may be left empty when RADIUS authentication is used, in which case the FortiGate will use the RADIUS username as a password.
     */
    readonly mfaPassword: pulumi.Output<string | undefined>;
    /**
     * Name of a remote authenticator. Performs client access right check.
     */
    readonly mfaServer: pulumi.Output<string>;
    /**
     * Unified username for remote authentication.
     */
    readonly mfaUsername: pulumi.Output<string>;
    /**
     * Peer name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Online Certificate Status Protocol (OCSP) server for certificate retrieval.
     */
    readonly ocspOverrideServer: pulumi.Output<string>;
    /**
     * Peer's password used for two-factor authentication.
     */
    readonly passwd: pulumi.Output<string | undefined>;
    /**
     * Peer certificate name constraints.
     */
    readonly subject: pulumi.Output<string>;
    /**
     * Enable/disable two-factor authentication, applying certificate and password-based authentication. Valid values: `enable`, `disable`.
     */
    readonly twoFactor: pulumi.Output<string>;
    /**
     * Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
     */
    readonly vdomparam: pulumi.Output<string>;
    /**
     * Create a Peer 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?: PeerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Peer resources.
 */
export interface PeerState {
    /**
     * Name of the CA certificate as returned by the execute vpn certificate ca list command.
     */
    ca?: pulumi.Input<string>;
    /**
     * Peer certificate common name.
     */
    cn?: pulumi.Input<string>;
    /**
     * Peer certificate common name type. Valid values: `string`, `email`, `FQDN`, `ipv4`, `ipv6`.
     */
    cnType?: pulumi.Input<string>;
    /**
     * Mode for LDAP peer authentication. Valid values: `password`, `principal-name`.
     */
    ldapMode?: pulumi.Input<string>;
    /**
     * Password for LDAP server bind.
     */
    ldapPassword?: pulumi.Input<string>;
    /**
     * Name of an LDAP server defined under the user ldap command. Performs client access rights check.
     */
    ldapServer?: pulumi.Input<string>;
    /**
     * Username for LDAP server bind.
     */
    ldapUsername?: pulumi.Input<string>;
    /**
     * Determine what happens to the peer if the CA certificate is not installed. Disable to automatically consider the peer certificate as valid. Valid values: `enable`, `disable`.
     */
    mandatoryCaVerify?: pulumi.Input<string>;
    /**
     * MFA mode for remote peer authentication/authorization. Valid values: `none`, `password`, `subject-identity`.
     */
    mfaMode?: pulumi.Input<string>;
    /**
     * Unified password for remote authentication. This field may be left empty when RADIUS authentication is used, in which case the FortiGate will use the RADIUS username as a password.
     */
    mfaPassword?: pulumi.Input<string>;
    /**
     * Name of a remote authenticator. Performs client access right check.
     */
    mfaServer?: pulumi.Input<string>;
    /**
     * Unified username for remote authentication.
     */
    mfaUsername?: pulumi.Input<string>;
    /**
     * Peer name.
     */
    name?: pulumi.Input<string>;
    /**
     * Online Certificate Status Protocol (OCSP) server for certificate retrieval.
     */
    ocspOverrideServer?: pulumi.Input<string>;
    /**
     * Peer's password used for two-factor authentication.
     */
    passwd?: pulumi.Input<string>;
    /**
     * Peer certificate name constraints.
     */
    subject?: pulumi.Input<string>;
    /**
     * Enable/disable two-factor authentication, applying certificate and password-based authentication. Valid values: `enable`, `disable`.
     */
    twoFactor?: pulumi.Input<string>;
    /**
     * Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
     */
    vdomparam?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Peer resource.
 */
export interface PeerArgs {
    /**
     * Name of the CA certificate as returned by the execute vpn certificate ca list command.
     */
    ca?: pulumi.Input<string>;
    /**
     * Peer certificate common name.
     */
    cn?: pulumi.Input<string>;
    /**
     * Peer certificate common name type. Valid values: `string`, `email`, `FQDN`, `ipv4`, `ipv6`.
     */
    cnType?: pulumi.Input<string>;
    /**
     * Mode for LDAP peer authentication. Valid values: `password`, `principal-name`.
     */
    ldapMode?: pulumi.Input<string>;
    /**
     * Password for LDAP server bind.
     */
    ldapPassword?: pulumi.Input<string>;
    /**
     * Name of an LDAP server defined under the user ldap command. Performs client access rights check.
     */
    ldapServer?: pulumi.Input<string>;
    /**
     * Username for LDAP server bind.
     */
    ldapUsername?: pulumi.Input<string>;
    /**
     * Determine what happens to the peer if the CA certificate is not installed. Disable to automatically consider the peer certificate as valid. Valid values: `enable`, `disable`.
     */
    mandatoryCaVerify?: pulumi.Input<string>;
    /**
     * MFA mode for remote peer authentication/authorization. Valid values: `none`, `password`, `subject-identity`.
     */
    mfaMode?: pulumi.Input<string>;
    /**
     * Unified password for remote authentication. This field may be left empty when RADIUS authentication is used, in which case the FortiGate will use the RADIUS username as a password.
     */
    mfaPassword?: pulumi.Input<string>;
    /**
     * Name of a remote authenticator. Performs client access right check.
     */
    mfaServer?: pulumi.Input<string>;
    /**
     * Unified username for remote authentication.
     */
    mfaUsername?: pulumi.Input<string>;
    /**
     * Peer name.
     */
    name?: pulumi.Input<string>;
    /**
     * Online Certificate Status Protocol (OCSP) server for certificate retrieval.
     */
    ocspOverrideServer?: pulumi.Input<string>;
    /**
     * Peer's password used for two-factor authentication.
     */
    passwd?: pulumi.Input<string>;
    /**
     * Peer certificate name constraints.
     */
    subject?: pulumi.Input<string>;
    /**
     * Enable/disable two-factor authentication, applying certificate and password-based authentication. Valid values: `enable`, `disable`.
     */
    twoFactor?: pulumi.Input<string>;
    /**
     * Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
     */
    vdomparam?: pulumi.Input<string>;
}