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

fortios.system.Smsserver

Explore with Pulumi AI

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

    Configure SMS server for sending SMS messages to support user authentication.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.system.Smsserver("trname", {mailServer: "1.1.1.2"});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Smsserver("trname", mail_server="1.1.1.2")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := system.NewSmsserver(ctx, "trname", &system.SmsserverArgs{
			MailServer: pulumi.String("1.1.1.2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.System.Smsserver("trname", new()
    {
        MailServer = "1.1.1.2",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Smsserver;
import com.pulumi.fortios.system.SmsserverArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new Smsserver("trname", SmsserverArgs.builder()
            .mailServer("1.1.1.2")
            .build());

    }
}

    resources:
  trname:
    type: fortios:system:Smsserver
    properties:
      mailServer: 1.1.1.2

    Create Smsserver Resource

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

    Constructor syntax

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

@overload
def Smsserver(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              mail_server: Optional[str] = None,
              name: Optional[str] = None,
              vdomparam: Optional[str] = None)
    func NewSmsserver(ctx *Context, name string, args SmsserverArgs, opts ...ResourceOption) (*Smsserver, error)
    public Smsserver(string name, SmsserverArgs args, CustomResourceOptions? opts = null)
    public Smsserver(String name, SmsserverArgs args)
public Smsserver(String name, SmsserverArgs args, CustomResourceOptions options)

    type: fortios:system:Smsserver
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 SmsserverArgs
    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 SmsserverArgs
    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 SmsserverArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SmsserverArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SmsserverArgs
    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 smsserverResource = new Fortios.System.Smsserver("smsserverResource", new()
{
    MailServer = "string",
    Name = "string",
    Vdomparam = "string",
});

    example, err := system.NewSmsserver(ctx, "smsserverResource", &system.SmsserverArgs{
	MailServer: pulumi.String("string"),
	Name:       pulumi.String("string"),
	Vdomparam:  pulumi.String("string"),
})

    var smsserverResource = new Smsserver("smsserverResource", SmsserverArgs.builder()
    .mailServer("string")
    .name("string")
    .vdomparam("string")
    .build());

    smsserver_resource = fortios.system.Smsserver("smsserverResource",
    mail_server="string",
    name="string",
    vdomparam="string")

    const smsserverResource = new fortios.system.Smsserver("smsserverResource", {
    mailServer: "string",
    name: "string",
    vdomparam: "string",
});

    type: fortios:system:Smsserver
properties:
    mailServer: string
    name: string
    vdomparam: string

    Smsserver 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 Smsserver resource accepts the following input properties:

    MailServer string
    Email-to-SMS server domain name.
    Name string
    Name of SMS server.
    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.
    MailServer string
    Email-to-SMS server domain name.
    Name string
    Name of SMS server.
    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.
    mailServer String
    Email-to-SMS server domain name.
    name String
    Name of SMS server.
    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.
    mailServer string
    Email-to-SMS server domain name.
    name string
    Name of SMS server.
    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.
    mail_server str
    Email-to-SMS server domain name.
    name str
    Name of SMS server.
    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.
    mailServer String
    Email-to-SMS server domain name.
    name String
    Name of SMS server.
    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 Smsserver 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 Smsserver Resource

    Get an existing Smsserver 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?: SmsserverState, opts?: CustomResourceOptions): Smsserver
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        mail_server: Optional[str] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Smsserver
    func GetSmsserver(ctx *Context, name string, id IDInput, state *SmsserverState, opts ...ResourceOption) (*Smsserver, error)
    public static Smsserver Get(string name, Input<string> id, SmsserverState? state, CustomResourceOptions? opts = null)
    public static Smsserver get(String name, Output<String> id, SmsserverState 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:
    MailServer string
    Email-to-SMS server domain name.
    Name string
    Name of SMS server.
    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.
    MailServer string
    Email-to-SMS server domain name.
    Name string
    Name of SMS server.
    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.
    mailServer String
    Email-to-SMS server domain name.
    name String
    Name of SMS server.
    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.
    mailServer string
    Email-to-SMS server domain name.
    name string
    Name of SMS server.
    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.
    mail_server str
    Email-to-SMS server domain name.
    name str
    Name of SMS server.
    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.
    mailServer String
    Email-to-SMS server domain name.
    name String
    Name of SMS server.
    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 SmsServer can be imported using any of these accepted formats:

    $ pulumi import fortios:system/smsserver:Smsserver labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/smsserver:Smsserver 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