1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectSystemSmsserver
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev

fortimanager.ObjectSystemSmsserver

Explore with Pulumi AI

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortimanager from "@pulumi/fortimanager";

const trname = new fortimanager.ObjectSystemSmsserver("trname", {mailServer: "terraform-tefv"});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.ObjectSystemSmsserver("trname", mail_server="terraform-tefv")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewObjectSystemSmsserver(ctx, "trname", &fortimanager.ObjectSystemSmsserverArgs{
			MailServer: pulumi.String("terraform-tefv"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.ObjectSystemSmsserver("trname", new()
    {
        MailServer = "terraform-tefv",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.ObjectSystemSmsserver;
import com.pulumi.fortimanager.ObjectSystemSmsserverArgs;
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 ObjectSystemSmsserver("trname", ObjectSystemSmsserverArgs.builder()
            .mailServer("terraform-tefv")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortimanager:ObjectSystemSmsserver
    properties:
      mailServer: terraform-tefv
Copy

Create ObjectSystemSmsserver Resource

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

Constructor syntax

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

@overload
def ObjectSystemSmsserver(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          adom: Optional[str] = None,
                          mail_server: Optional[str] = None,
                          name: Optional[str] = None,
                          object_system_smsserver_id: Optional[str] = None,
                          scopetype: Optional[str] = None)
func NewObjectSystemSmsserver(ctx *Context, name string, args *ObjectSystemSmsserverArgs, opts ...ResourceOption) (*ObjectSystemSmsserver, error)
public ObjectSystemSmsserver(string name, ObjectSystemSmsserverArgs? args = null, CustomResourceOptions? opts = null)
public ObjectSystemSmsserver(String name, ObjectSystemSmsserverArgs args)
public ObjectSystemSmsserver(String name, ObjectSystemSmsserverArgs args, CustomResourceOptions options)
type: fortimanager:ObjectSystemSmsserver
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ObjectSystemSmsserverArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ObjectSystemSmsserverArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ObjectSystemSmsserverArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ObjectSystemSmsserverArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ObjectSystemSmsserverArgs
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 objectSystemSmsserverResource = new Fortimanager.ObjectSystemSmsserver("objectSystemSmsserverResource", new()
{
    Adom = "string",
    MailServer = "string",
    Name = "string",
    ObjectSystemSmsserverId = "string",
    Scopetype = "string",
});
Copy
example, err := fortimanager.NewObjectSystemSmsserver(ctx, "objectSystemSmsserverResource", &fortimanager.ObjectSystemSmsserverArgs{
Adom: pulumi.String("string"),
MailServer: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectSystemSmsserverId: pulumi.String("string"),
Scopetype: pulumi.String("string"),
})
Copy
var objectSystemSmsserverResource = new ObjectSystemSmsserver("objectSystemSmsserverResource", ObjectSystemSmsserverArgs.builder()
    .adom("string")
    .mailServer("string")
    .name("string")
    .objectSystemSmsserverId("string")
    .scopetype("string")
    .build());
Copy
object_system_smsserver_resource = fortimanager.ObjectSystemSmsserver("objectSystemSmsserverResource",
    adom="string",
    mail_server="string",
    name="string",
    object_system_smsserver_id="string",
    scopetype="string")
Copy
const objectSystemSmsserverResource = new fortimanager.ObjectSystemSmsserver("objectSystemSmsserverResource", {
    adom: "string",
    mailServer: "string",
    name: "string",
    objectSystemSmsserverId: "string",
    scopetype: "string",
});
Copy
type: fortimanager:ObjectSystemSmsserver
properties:
    adom: string
    mailServer: string
    name: string
    objectSystemSmsserverId: string
    scopetype: string
Copy

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

Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
MailServer string
Email-to-SMS server domain name.
Name string
Name of SMS server.
ObjectSystemSmsserverId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
MailServer string
Email-to-SMS server domain name.
Name string
Name of SMS server.
ObjectSystemSmsserverId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
mailServer String
Email-to-SMS server domain name.
name String
Name of SMS server.
objectSystemSmsserverId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
mailServer string
Email-to-SMS server domain name.
name string
Name of SMS server.
objectSystemSmsserverId string
an identifier for the resource with format {{name}}.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
mail_server str
Email-to-SMS server domain name.
name str
Name of SMS server.
object_system_smsserver_id str
an identifier for the resource with format {{name}}.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
mailServer String
Email-to-SMS server domain name.
name String
Name of SMS server.
objectSystemSmsserverId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.

Outputs

All input properties are implicitly available as output properties. Additionally, the ObjectSystemSmsserver 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 ObjectSystemSmsserver Resource

Get an existing ObjectSystemSmsserver 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?: ObjectSystemSmsserverState, opts?: CustomResourceOptions): ObjectSystemSmsserver
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        mail_server: Optional[str] = None,
        name: Optional[str] = None,
        object_system_smsserver_id: Optional[str] = None,
        scopetype: Optional[str] = None) -> ObjectSystemSmsserver
func GetObjectSystemSmsserver(ctx *Context, name string, id IDInput, state *ObjectSystemSmsserverState, opts ...ResourceOption) (*ObjectSystemSmsserver, error)
public static ObjectSystemSmsserver Get(string name, Input<string> id, ObjectSystemSmsserverState? state, CustomResourceOptions? opts = null)
public static ObjectSystemSmsserver get(String name, Output<String> id, ObjectSystemSmsserverState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:ObjectSystemSmsserver    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
MailServer string
Email-to-SMS server domain name.
Name string
Name of SMS server.
ObjectSystemSmsserverId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
MailServer string
Email-to-SMS server domain name.
Name string
Name of SMS server.
ObjectSystemSmsserverId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
mailServer String
Email-to-SMS server domain name.
name String
Name of SMS server.
objectSystemSmsserverId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
mailServer string
Email-to-SMS server domain name.
name string
Name of SMS server.
objectSystemSmsserverId string
an identifier for the resource with format {{name}}.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
mail_server str
Email-to-SMS server domain name.
name str
Name of SMS server.
object_system_smsserver_id str
an identifier for the resource with format {{name}}.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
mailServer String
Email-to-SMS server domain name.
name String
Name of SMS server.
objectSystemSmsserverId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.

Import

ObjectSystem SmsServer can be imported using any of these accepted formats:

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/objectSystemSmsserver:ObjectSystemSmsserver labelname {{name}}
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

-> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

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

Package Details

Repository
fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes
This Pulumi package is based on the fortimanager Terraform Provider.