Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Sdnproxy
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system.Sdnproxy

Explore with Pulumi AI

fortios logo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Configure SDN proxy. Applies to FortiOS Version >= 7.4.0.

    Create Sdnproxy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Sdnproxy(name: string, args?: SdnproxyArgs, opts?: CustomResourceOptions);
    @overload
def Sdnproxy(resource_name: str,
             args: Optional[SdnproxyArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Sdnproxy(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             name: Optional[str] = None,
             password: Optional[str] = None,
             server: Optional[str] = None,
             server_port: Optional[int] = None,
             type: Optional[str] = None,
             username: Optional[str] = None,
             vdomparam: Optional[str] = None)
    func NewSdnproxy(ctx *Context, name string, args *SdnproxyArgs, opts ...ResourceOption) (*Sdnproxy, error)
    public Sdnproxy(string name, SdnproxyArgs? args = null, CustomResourceOptions? opts = null)
    public Sdnproxy(String name, SdnproxyArgs args)
public Sdnproxy(String name, SdnproxyArgs args, CustomResourceOptions options)

    type: fortios:system:Sdnproxy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SdnproxyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SdnproxyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SdnproxyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SdnproxyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SdnproxyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sdnproxyResource = new Fortios.System.Sdnproxy("sdnproxyResource", new()
{
    Name = "string",
    Password = "string",
    Server = "string",
    ServerPort = 0,
    Type = "string",
    Username = "string",
    Vdomparam = "string",
});

    example, err := system.NewSdnproxy(ctx, "sdnproxyResource", &system.SdnproxyArgs{
	Name:       pulumi.String("string"),
	Password:   pulumi.String("string"),
	Server:     pulumi.String("string"),
	ServerPort: pulumi.Int(0),
	Type:       pulumi.String("string"),
	Username:   pulumi.String("string"),
	Vdomparam:  pulumi.String("string"),
})

    var sdnproxyResource = new Sdnproxy("sdnproxyResource", SdnproxyArgs.builder()
    .name("string")
    .password("string")
    .server("string")
    .serverPort(0)
    .type("string")
    .username("string")
    .vdomparam("string")
    .build());

    sdnproxy_resource = fortios.system.Sdnproxy("sdnproxyResource",
    name="string",
    password="string",
    server="string",
    server_port=0,
    type="string",
    username="string",
    vdomparam="string")

    const sdnproxyResource = new fortios.system.Sdnproxy("sdnproxyResource", {
    name: "string",
    password: "string",
    server: "string",
    serverPort: 0,
    type: "string",
    username: "string",
    vdomparam: "string",
});

    type: fortios:system:Sdnproxy
properties:
    name: string
    password: string
    server: string
    serverPort: 0
    type: string
    username: string
    vdomparam: string

    Sdnproxy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Sdnproxy resource accepts the following input properties:

    Name string
    SDN proxy name.
    Password string
    SDN proxy password.
    Server string
    Server address of the SDN proxy.
    ServerPort int
    Port number of the SDN proxy.
    Type string
    Type of SDN proxy. Valid values: general, fortimanager.
    Username string
    SDN proxy username.
    Vdomparam 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.
    Name string
    SDN proxy name.
    Password string
    SDN proxy password.
    Server string
    Server address of the SDN proxy.
    ServerPort int
    Port number of the SDN proxy.
    Type string
    Type of SDN proxy. Valid values: general, fortimanager.
    Username string
    SDN proxy username.
    Vdomparam 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.
    name String
    SDN proxy name.
    password String
    SDN proxy password.
    server String
    Server address of the SDN proxy.
    serverPort Integer
    Port number of the SDN proxy.
    type String
    Type of SDN proxy. Valid values: general, fortimanager.
    username String
    SDN proxy username.
    vdomparam 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.
    name string
    SDN proxy name.
    password string
    SDN proxy password.
    server string
    Server address of the SDN proxy.
    serverPort number
    Port number of the SDN proxy.
    type string
    Type of SDN proxy. Valid values: general, fortimanager.
    username string
    SDN proxy username.
    vdomparam 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.
    name str
    SDN proxy name.
    password str
    SDN proxy password.
    server str
    Server address of the SDN proxy.
    server_port int
    Port number of the SDN proxy.
    type str
    Type of SDN proxy. Valid values: general, fortimanager.
    username str
    SDN proxy username.
    vdomparam str
    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.
    name String
    SDN proxy name.
    password String
    SDN proxy password.
    server String
    Server address of the SDN proxy.
    serverPort Number
    Port number of the SDN proxy.
    type String
    Type of SDN proxy. Valid values: general, fortimanager.
    username String
    SDN proxy username.
    vdomparam 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Sdnproxy resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Sdnproxy Resource

    Get an existing Sdnproxy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SdnproxyState, opts?: CustomResourceOptions): Sdnproxy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        server: Optional[str] = None,
        server_port: Optional[int] = None,
        type: Optional[str] = None,
        username: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Sdnproxy
    func GetSdnproxy(ctx *Context, name string, id IDInput, state *SdnproxyState, opts ...ResourceOption) (*Sdnproxy, error)
    public static Sdnproxy Get(string name, Input<string> id, SdnproxyState? state, CustomResourceOptions? opts = null)
    public static Sdnproxy get(String name, Output<String> id, SdnproxyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Name string
    SDN proxy name.
    Password string
    SDN proxy password.
    Server string
    Server address of the SDN proxy.
    ServerPort int
    Port number of the SDN proxy.
    Type string
    Type of SDN proxy. Valid values: general, fortimanager.
    Username string
    SDN proxy username.
    Vdomparam 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.
    Name string
    SDN proxy name.
    Password string
    SDN proxy password.
    Server string
    Server address of the SDN proxy.
    ServerPort int
    Port number of the SDN proxy.
    Type string
    Type of SDN proxy. Valid values: general, fortimanager.
    Username string
    SDN proxy username.
    Vdomparam 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.
    name String
    SDN proxy name.
    password String
    SDN proxy password.
    server String
    Server address of the SDN proxy.
    serverPort Integer
    Port number of the SDN proxy.
    type String
    Type of SDN proxy. Valid values: general, fortimanager.
    username String
    SDN proxy username.
    vdomparam 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.
    name string
    SDN proxy name.
    password string
    SDN proxy password.
    server string
    Server address of the SDN proxy.
    serverPort number
    Port number of the SDN proxy.
    type string
    Type of SDN proxy. Valid values: general, fortimanager.
    username string
    SDN proxy username.
    vdomparam 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.
    name str
    SDN proxy name.
    password str
    SDN proxy password.
    server str
    Server address of the SDN proxy.
    server_port int
    Port number of the SDN proxy.
    type str
    Type of SDN proxy. Valid values: general, fortimanager.
    username str
    SDN proxy username.
    vdomparam str
    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.
    name String
    SDN proxy name.
    password String
    SDN proxy password.
    server String
    Server address of the SDN proxy.
    serverPort Number
    Port number of the SDN proxy.
    type String
    Type of SDN proxy. Valid values: general, fortimanager.
    username String
    SDN proxy username.
    vdomparam 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.

    Import

    System SdnProxy can be imported using any of these accepted formats:

    $ pulumi import fortios:system/sdnproxy:Sdnproxy labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/sdnproxy:Sdnproxy labelname {{name}}

    $ unset “FORTIOS_IMPORT_TABLE”

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios