1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Dnsdatabase
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.system.Dnsdatabase

Explore with Pulumi AI

Configure DNS databases.

Example Usage

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

const trname = new fortios.system.Dnsdatabase("trname", {
    authoritative: "enable",
    contact: "hostmaster",
    dnsEntries: [{
        hostname: "sghsgh.com",
        ttl: 3,
        type: "MX",
    }],
    domain: "s.com",
    forwarder: "\"9.9.9.9\" \"3.3.3.3\" ",
    ipMaster: "0.0.0.0",
    primaryName: "dns",
    sourceIp: "0.0.0.0",
    status: "enable",
    ttl: 86400,
    type: "master",
    view: "shadow",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Dnsdatabase("trname",
    authoritative="enable",
    contact="hostmaster",
    dns_entries=[fortios.system.DnsdatabaseDnsEntryArgs(
        hostname="sghsgh.com",
        ttl=3,
        type="MX",
    )],
    domain="s.com",
    forwarder="\"9.9.9.9\" \"3.3.3.3\" ",
    ip_master="0.0.0.0",
    primary_name="dns",
    source_ip="0.0.0.0",
    status="enable",
    ttl=86400,
    type="master",
    view="shadow")
Copy
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.NewDnsdatabase(ctx, "trname", &system.DnsdatabaseArgs{
			Authoritative: pulumi.String("enable"),
			Contact:       pulumi.String("hostmaster"),
			DnsEntries: system.DnsdatabaseDnsEntryArray{
				&system.DnsdatabaseDnsEntryArgs{
					Hostname: pulumi.String("sghsgh.com"),
					Ttl:      pulumi.Int(3),
					Type:     pulumi.String("MX"),
				},
			},
			Domain:      pulumi.String("s.com"),
			Forwarder:   pulumi.String("\"9.9.9.9\" \"3.3.3.3\" "),
			IpMaster:    pulumi.String("0.0.0.0"),
			PrimaryName: pulumi.String("dns"),
			SourceIp:    pulumi.String("0.0.0.0"),
			Status:      pulumi.String("enable"),
			Ttl:         pulumi.Int(86400),
			Type:        pulumi.String("master"),
			View:        pulumi.String("shadow"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.System.Dnsdatabase("trname", new()
    {
        Authoritative = "enable",
        Contact = "hostmaster",
        DnsEntries = new[]
        {
            new Fortios.System.Inputs.DnsdatabaseDnsEntryArgs
            {
                Hostname = "sghsgh.com",
                Ttl = 3,
                Type = "MX",
            },
        },
        Domain = "s.com",
        Forwarder = "\"9.9.9.9\" \"3.3.3.3\" ",
        IpMaster = "0.0.0.0",
        PrimaryName = "dns",
        SourceIp = "0.0.0.0",
        Status = "enable",
        Ttl = 86400,
        Type = "master",
        View = "shadow",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Dnsdatabase;
import com.pulumi.fortios.system.DnsdatabaseArgs;
import com.pulumi.fortios.system.inputs.DnsdatabaseDnsEntryArgs;
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 Dnsdatabase("trname", DnsdatabaseArgs.builder()
            .authoritative("enable")
            .contact("hostmaster")
            .dnsEntries(DnsdatabaseDnsEntryArgs.builder()
                .hostname("sghsgh.com")
                .ttl(3)
                .type("MX")
                .build())
            .domain("s.com")
            .forwarder("\"9.9.9.9\" \"3.3.3.3\" ")
            .ipMaster("0.0.0.0")
            .primaryName("dns")
            .sourceIp("0.0.0.0")
            .status("enable")
            .ttl(86400)
            .type("master")
            .view("shadow")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:system:Dnsdatabase
    properties:
      authoritative: enable
      contact: hostmaster
      dnsEntries:
        - hostname: sghsgh.com
          ttl: 3
          type: MX
      domain: s.com
      forwarder: '"9.9.9.9" "3.3.3.3" '
      ipMaster: 0.0.0.0
      primaryName: dns
      sourceIp: 0.0.0.0
      status: enable
      ttl: 86400
      type: master
      view: shadow
Copy

Create Dnsdatabase Resource

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

Constructor syntax

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

@overload
def Dnsdatabase(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                ttl: Optional[int] = None,
                authoritative: Optional[str] = None,
                view: Optional[str] = None,
                type: Optional[str] = None,
                domain: Optional[str] = None,
                ip_primary: Optional[str] = None,
                primary_name: Optional[str] = None,
                forwarder6: Optional[str] = None,
                get_all_tables: Optional[str] = None,
                ip_master: Optional[str] = None,
                allow_transfer: Optional[str] = None,
                name: Optional[str] = None,
                forwarder: Optional[str] = None,
                rr_max: Optional[int] = None,
                source_ip: Optional[str] = None,
                source_ip6: Optional[str] = None,
                status: Optional[str] = None,
                dynamic_sort_subtable: Optional[str] = None,
                dns_entries: Optional[Sequence[DnsdatabaseDnsEntryArgs]] = None,
                vdomparam: Optional[str] = None,
                contact: Optional[str] = None)
func NewDnsdatabase(ctx *Context, name string, args DnsdatabaseArgs, opts ...ResourceOption) (*Dnsdatabase, error)
public Dnsdatabase(string name, DnsdatabaseArgs args, CustomResourceOptions? opts = null)
public Dnsdatabase(String name, DnsdatabaseArgs args)
public Dnsdatabase(String name, DnsdatabaseArgs args, CustomResourceOptions options)
type: fortios:system:Dnsdatabase
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 This property is required. DnsdatabaseArgs
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 This property is required. DnsdatabaseArgs
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 This property is required. DnsdatabaseArgs
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 This property is required. DnsdatabaseArgs
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. DnsdatabaseArgs
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 dnsdatabaseResource = new Fortios.System.Dnsdatabase("dnsdatabaseResource", new()
{
    Ttl = 0,
    Authoritative = "string",
    View = "string",
    Type = "string",
    Domain = "string",
    IpPrimary = "string",
    PrimaryName = "string",
    Forwarder6 = "string",
    GetAllTables = "string",
    IpMaster = "string",
    AllowTransfer = "string",
    Name = "string",
    Forwarder = "string",
    RrMax = 0,
    SourceIp = "string",
    SourceIp6 = "string",
    Status = "string",
    DynamicSortSubtable = "string",
    DnsEntries = new[]
    {
        new Fortios.System.Inputs.DnsdatabaseDnsEntryArgs
        {
            CanonicalName = "string",
            Hostname = "string",
            Id = 0,
            Ip = "string",
            Ipv6 = "string",
            Preference = 0,
            Status = "string",
            Ttl = 0,
            Type = "string",
        },
    },
    Vdomparam = "string",
    Contact = "string",
});
Copy
example, err := system.NewDnsdatabase(ctx, "dnsdatabaseResource", &system.DnsdatabaseArgs{
	Ttl:                 pulumi.Int(0),
	Authoritative:       pulumi.String("string"),
	View:                pulumi.String("string"),
	Type:                pulumi.String("string"),
	Domain:              pulumi.String("string"),
	IpPrimary:           pulumi.String("string"),
	PrimaryName:         pulumi.String("string"),
	Forwarder6:          pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	IpMaster:            pulumi.String("string"),
	AllowTransfer:       pulumi.String("string"),
	Name:                pulumi.String("string"),
	Forwarder:           pulumi.String("string"),
	RrMax:               pulumi.Int(0),
	SourceIp:            pulumi.String("string"),
	SourceIp6:           pulumi.String("string"),
	Status:              pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	DnsEntries: system.DnsdatabaseDnsEntryArray{
		&system.DnsdatabaseDnsEntryArgs{
			CanonicalName: pulumi.String("string"),
			Hostname:      pulumi.String("string"),
			Id:            pulumi.Int(0),
			Ip:            pulumi.String("string"),
			Ipv6:          pulumi.String("string"),
			Preference:    pulumi.Int(0),
			Status:        pulumi.String("string"),
			Ttl:           pulumi.Int(0),
			Type:          pulumi.String("string"),
		},
	},
	Vdomparam: pulumi.String("string"),
	Contact:   pulumi.String("string"),
})
Copy
var dnsdatabaseResource = new Dnsdatabase("dnsdatabaseResource", DnsdatabaseArgs.builder()
    .ttl(0)
    .authoritative("string")
    .view("string")
    .type("string")
    .domain("string")
    .ipPrimary("string")
    .primaryName("string")
    .forwarder6("string")
    .getAllTables("string")
    .ipMaster("string")
    .allowTransfer("string")
    .name("string")
    .forwarder("string")
    .rrMax(0)
    .sourceIp("string")
    .sourceIp6("string")
    .status("string")
    .dynamicSortSubtable("string")
    .dnsEntries(DnsdatabaseDnsEntryArgs.builder()
        .canonicalName("string")
        .hostname("string")
        .id(0)
        .ip("string")
        .ipv6("string")
        .preference(0)
        .status("string")
        .ttl(0)
        .type("string")
        .build())
    .vdomparam("string")
    .contact("string")
    .build());
Copy
dnsdatabase_resource = fortios.system.Dnsdatabase("dnsdatabaseResource",
    ttl=0,
    authoritative="string",
    view="string",
    type="string",
    domain="string",
    ip_primary="string",
    primary_name="string",
    forwarder6="string",
    get_all_tables="string",
    ip_master="string",
    allow_transfer="string",
    name="string",
    forwarder="string",
    rr_max=0,
    source_ip="string",
    source_ip6="string",
    status="string",
    dynamic_sort_subtable="string",
    dns_entries=[{
        "canonical_name": "string",
        "hostname": "string",
        "id": 0,
        "ip": "string",
        "ipv6": "string",
        "preference": 0,
        "status": "string",
        "ttl": 0,
        "type": "string",
    }],
    vdomparam="string",
    contact="string")
Copy
const dnsdatabaseResource = new fortios.system.Dnsdatabase("dnsdatabaseResource", {
    ttl: 0,
    authoritative: "string",
    view: "string",
    type: "string",
    domain: "string",
    ipPrimary: "string",
    primaryName: "string",
    forwarder6: "string",
    getAllTables: "string",
    ipMaster: "string",
    allowTransfer: "string",
    name: "string",
    forwarder: "string",
    rrMax: 0,
    sourceIp: "string",
    sourceIp6: "string",
    status: "string",
    dynamicSortSubtable: "string",
    dnsEntries: [{
        canonicalName: "string",
        hostname: "string",
        id: 0,
        ip: "string",
        ipv6: "string",
        preference: 0,
        status: "string",
        ttl: 0,
        type: "string",
    }],
    vdomparam: "string",
    contact: "string",
});
Copy
type: fortios:system:Dnsdatabase
properties:
    allowTransfer: string
    authoritative: string
    contact: string
    dnsEntries:
        - canonicalName: string
          hostname: string
          id: 0
          ip: string
          ipv6: string
          preference: 0
          status: string
          ttl: 0
          type: string
    domain: string
    dynamicSortSubtable: string
    forwarder: string
    forwarder6: string
    getAllTables: string
    ipMaster: string
    ipPrimary: string
    name: string
    primaryName: string
    rrMax: 0
    sourceIp: string
    sourceIp6: string
    status: string
    ttl: 0
    type: string
    vdomparam: string
    view: string
Copy

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

Authoritative This property is required. string
Enable/disable authoritative zone. Valid values: enable, disable.
Domain This property is required. string
Domain name.
Ttl This property is required. int
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
Type This property is required. string
Zone type (primary to manage entries directly, secondary to import entries from other zones).
View This property is required. string
Zone view (public to serve public clients, shadow to serve internal clients).
AllowTransfer string
DNS zone transfer IP address list.
Contact string
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
DnsEntries List<Pulumiverse.Fortios.System.Inputs.DnsdatabaseDnsEntry>
DNS entry. The structure of dns_entry block is documented below.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Forwarder string
DNS zone forwarder IP address list.
Forwarder6 string
Forwarder IPv6 address.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
IpMaster string
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
IpPrimary string
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
Name Changes to this property will trigger replacement. string
Zone name.
PrimaryName string
Domain name of the default DNS server for this zone.
RrMax int
Maximum number of resource records (10 - 65536, 0 means infinite).
SourceIp string
Source IP for forwarding to DNS server.
SourceIp6 string
IPv6 source IP address for forwarding to DNS server.
Status string
Enable/disable this DNS zone. Valid values: enable, disable.
Vdomparam Changes to this property will trigger replacement. 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.
Authoritative This property is required. string
Enable/disable authoritative zone. Valid values: enable, disable.
Domain This property is required. string
Domain name.
Ttl This property is required. int
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
Type This property is required. string
Zone type (primary to manage entries directly, secondary to import entries from other zones).
View This property is required. string
Zone view (public to serve public clients, shadow to serve internal clients).
AllowTransfer string
DNS zone transfer IP address list.
Contact string
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
DnsEntries []DnsdatabaseDnsEntryArgs
DNS entry. The structure of dns_entry block is documented below.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Forwarder string
DNS zone forwarder IP address list.
Forwarder6 string
Forwarder IPv6 address.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
IpMaster string
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
IpPrimary string
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
Name Changes to this property will trigger replacement. string
Zone name.
PrimaryName string
Domain name of the default DNS server for this zone.
RrMax int
Maximum number of resource records (10 - 65536, 0 means infinite).
SourceIp string
Source IP for forwarding to DNS server.
SourceIp6 string
IPv6 source IP address for forwarding to DNS server.
Status string
Enable/disable this DNS zone. Valid values: enable, disable.
Vdomparam Changes to this property will trigger replacement. 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.
authoritative This property is required. String
Enable/disable authoritative zone. Valid values: enable, disable.
domain This property is required. String
Domain name.
ttl This property is required. Integer
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
type This property is required. String
Zone type (primary to manage entries directly, secondary to import entries from other zones).
view This property is required. String
Zone view (public to serve public clients, shadow to serve internal clients).
allowTransfer String
DNS zone transfer IP address list.
contact String
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
dnsEntries List<DnsdatabaseDnsEntry>
DNS entry. The structure of dns_entry block is documented below.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
forwarder String
DNS zone forwarder IP address list.
forwarder6 String
Forwarder IPv6 address.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ipMaster String
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
ipPrimary String
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
name Changes to this property will trigger replacement. String
Zone name.
primaryName String
Domain name of the default DNS server for this zone.
rrMax Integer
Maximum number of resource records (10 - 65536, 0 means infinite).
sourceIp String
Source IP for forwarding to DNS server.
sourceIp6 String
IPv6 source IP address for forwarding to DNS server.
status String
Enable/disable this DNS zone. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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.
authoritative This property is required. string
Enable/disable authoritative zone. Valid values: enable, disable.
domain This property is required. string
Domain name.
ttl This property is required. number
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
type This property is required. string
Zone type (primary to manage entries directly, secondary to import entries from other zones).
view This property is required. string
Zone view (public to serve public clients, shadow to serve internal clients).
allowTransfer string
DNS zone transfer IP address list.
contact string
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
dnsEntries DnsdatabaseDnsEntry[]
DNS entry. The structure of dns_entry block is documented below.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
forwarder string
DNS zone forwarder IP address list.
forwarder6 string
Forwarder IPv6 address.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ipMaster string
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
ipPrimary string
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
name Changes to this property will trigger replacement. string
Zone name.
primaryName string
Domain name of the default DNS server for this zone.
rrMax number
Maximum number of resource records (10 - 65536, 0 means infinite).
sourceIp string
Source IP for forwarding to DNS server.
sourceIp6 string
IPv6 source IP address for forwarding to DNS server.
status string
Enable/disable this DNS zone. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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.
authoritative This property is required. str
Enable/disable authoritative zone. Valid values: enable, disable.
domain This property is required. str
Domain name.
ttl This property is required. int
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
type This property is required. str
Zone type (primary to manage entries directly, secondary to import entries from other zones).
view This property is required. str
Zone view (public to serve public clients, shadow to serve internal clients).
allow_transfer str
DNS zone transfer IP address list.
contact str
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
dns_entries Sequence[DnsdatabaseDnsEntryArgs]
DNS entry. The structure of dns_entry block is documented below.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
forwarder str
DNS zone forwarder IP address list.
forwarder6 str
Forwarder IPv6 address.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ip_master str
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
ip_primary str
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
name Changes to this property will trigger replacement. str
Zone name.
primary_name str
Domain name of the default DNS server for this zone.
rr_max int
Maximum number of resource records (10 - 65536, 0 means infinite).
source_ip str
Source IP for forwarding to DNS server.
source_ip6 str
IPv6 source IP address for forwarding to DNS server.
status str
Enable/disable this DNS zone. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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.
authoritative This property is required. String
Enable/disable authoritative zone. Valid values: enable, disable.
domain This property is required. String
Domain name.
ttl This property is required. Number
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
type This property is required. String
Zone type (primary to manage entries directly, secondary to import entries from other zones).
view This property is required. String
Zone view (public to serve public clients, shadow to serve internal clients).
allowTransfer String
DNS zone transfer IP address list.
contact String
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
dnsEntries List<Property Map>
DNS entry. The structure of dns_entry block is documented below.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
forwarder String
DNS zone forwarder IP address list.
forwarder6 String
Forwarder IPv6 address.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ipMaster String
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
ipPrimary String
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
name Changes to this property will trigger replacement. String
Zone name.
primaryName String
Domain name of the default DNS server for this zone.
rrMax Number
Maximum number of resource records (10 - 65536, 0 means infinite).
sourceIp String
Source IP for forwarding to DNS server.
sourceIp6 String
IPv6 source IP address for forwarding to DNS server.
status String
Enable/disable this DNS zone. Valid values: enable, disable.
vdomparam Changes to this property will trigger replacement. 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 Dnsdatabase 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 Dnsdatabase Resource

Get an existing Dnsdatabase 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?: DnsdatabaseState, opts?: CustomResourceOptions): Dnsdatabase
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_transfer: Optional[str] = None,
        authoritative: Optional[str] = None,
        contact: Optional[str] = None,
        dns_entries: Optional[Sequence[DnsdatabaseDnsEntryArgs]] = None,
        domain: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        forwarder: Optional[str] = None,
        forwarder6: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        ip_master: Optional[str] = None,
        ip_primary: Optional[str] = None,
        name: Optional[str] = None,
        primary_name: Optional[str] = None,
        rr_max: Optional[int] = None,
        source_ip: Optional[str] = None,
        source_ip6: Optional[str] = None,
        status: Optional[str] = None,
        ttl: Optional[int] = None,
        type: Optional[str] = None,
        vdomparam: Optional[str] = None,
        view: Optional[str] = None) -> Dnsdatabase
func GetDnsdatabase(ctx *Context, name string, id IDInput, state *DnsdatabaseState, opts ...ResourceOption) (*Dnsdatabase, error)
public static Dnsdatabase Get(string name, Input<string> id, DnsdatabaseState? state, CustomResourceOptions? opts = null)
public static Dnsdatabase get(String name, Output<String> id, DnsdatabaseState state, CustomResourceOptions options)
resources:  _:    type: fortios:system:Dnsdatabase    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:
AllowTransfer string
DNS zone transfer IP address list.
Authoritative string
Enable/disable authoritative zone. Valid values: enable, disable.
Contact string
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
DnsEntries List<Pulumiverse.Fortios.System.Inputs.DnsdatabaseDnsEntry>
DNS entry. The structure of dns_entry block is documented below.
Domain string
Domain name.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Forwarder string
DNS zone forwarder IP address list.
Forwarder6 string
Forwarder IPv6 address.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
IpMaster string
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
IpPrimary string
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
Name Changes to this property will trigger replacement. string
Zone name.
PrimaryName string
Domain name of the default DNS server for this zone.
RrMax int
Maximum number of resource records (10 - 65536, 0 means infinite).
SourceIp string
Source IP for forwarding to DNS server.
SourceIp6 string
IPv6 source IP address for forwarding to DNS server.
Status string
Enable/disable this DNS zone. Valid values: enable, disable.
Ttl int
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
Type string
Zone type (primary to manage entries directly, secondary to import entries from other zones).
Vdomparam Changes to this property will trigger replacement. 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.
View string
Zone view (public to serve public clients, shadow to serve internal clients).
AllowTransfer string
DNS zone transfer IP address list.
Authoritative string
Enable/disable authoritative zone. Valid values: enable, disable.
Contact string
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
DnsEntries []DnsdatabaseDnsEntryArgs
DNS entry. The structure of dns_entry block is documented below.
Domain string
Domain name.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Forwarder string
DNS zone forwarder IP address list.
Forwarder6 string
Forwarder IPv6 address.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
IpMaster string
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
IpPrimary string
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
Name Changes to this property will trigger replacement. string
Zone name.
PrimaryName string
Domain name of the default DNS server for this zone.
RrMax int
Maximum number of resource records (10 - 65536, 0 means infinite).
SourceIp string
Source IP for forwarding to DNS server.
SourceIp6 string
IPv6 source IP address for forwarding to DNS server.
Status string
Enable/disable this DNS zone. Valid values: enable, disable.
Ttl int
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
Type string
Zone type (primary to manage entries directly, secondary to import entries from other zones).
Vdomparam Changes to this property will trigger replacement. 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.
View string
Zone view (public to serve public clients, shadow to serve internal clients).
allowTransfer String
DNS zone transfer IP address list.
authoritative String
Enable/disable authoritative zone. Valid values: enable, disable.
contact String
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
dnsEntries List<DnsdatabaseDnsEntry>
DNS entry. The structure of dns_entry block is documented below.
domain String
Domain name.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
forwarder String
DNS zone forwarder IP address list.
forwarder6 String
Forwarder IPv6 address.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ipMaster String
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
ipPrimary String
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
name Changes to this property will trigger replacement. String
Zone name.
primaryName String
Domain name of the default DNS server for this zone.
rrMax Integer
Maximum number of resource records (10 - 65536, 0 means infinite).
sourceIp String
Source IP for forwarding to DNS server.
sourceIp6 String
IPv6 source IP address for forwarding to DNS server.
status String
Enable/disable this DNS zone. Valid values: enable, disable.
ttl Integer
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
type String
Zone type (primary to manage entries directly, secondary to import entries from other zones).
vdomparam Changes to this property will trigger replacement. 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.
view String
Zone view (public to serve public clients, shadow to serve internal clients).
allowTransfer string
DNS zone transfer IP address list.
authoritative string
Enable/disable authoritative zone. Valid values: enable, disable.
contact string
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
dnsEntries DnsdatabaseDnsEntry[]
DNS entry. The structure of dns_entry block is documented below.
domain string
Domain name.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
forwarder string
DNS zone forwarder IP address list.
forwarder6 string
Forwarder IPv6 address.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ipMaster string
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
ipPrimary string
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
name Changes to this property will trigger replacement. string
Zone name.
primaryName string
Domain name of the default DNS server for this zone.
rrMax number
Maximum number of resource records (10 - 65536, 0 means infinite).
sourceIp string
Source IP for forwarding to DNS server.
sourceIp6 string
IPv6 source IP address for forwarding to DNS server.
status string
Enable/disable this DNS zone. Valid values: enable, disable.
ttl number
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
type string
Zone type (primary to manage entries directly, secondary to import entries from other zones).
vdomparam Changes to this property will trigger replacement. 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.
view string
Zone view (public to serve public clients, shadow to serve internal clients).
allow_transfer str
DNS zone transfer IP address list.
authoritative str
Enable/disable authoritative zone. Valid values: enable, disable.
contact str
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
dns_entries Sequence[DnsdatabaseDnsEntryArgs]
DNS entry. The structure of dns_entry block is documented below.
domain str
Domain name.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
forwarder str
DNS zone forwarder IP address list.
forwarder6 str
Forwarder IPv6 address.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ip_master str
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
ip_primary str
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
name Changes to this property will trigger replacement. str
Zone name.
primary_name str
Domain name of the default DNS server for this zone.
rr_max int
Maximum number of resource records (10 - 65536, 0 means infinite).
source_ip str
Source IP for forwarding to DNS server.
source_ip6 str
IPv6 source IP address for forwarding to DNS server.
status str
Enable/disable this DNS zone. Valid values: enable, disable.
ttl int
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
type str
Zone type (primary to manage entries directly, secondary to import entries from other zones).
vdomparam Changes to this property will trigger replacement. 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.
view str
Zone view (public to serve public clients, shadow to serve internal clients).
allowTransfer String
DNS zone transfer IP address list.
authoritative String
Enable/disable authoritative zone. Valid values: enable, disable.
contact String
Email address of the administrator for this zone. You can specify only the username, such as admin or the full email address, such as admin@test.com When using only a username, the domain of the email will be this zone.
dnsEntries List<Property Map>
DNS entry. The structure of dns_entry block is documented below.
domain String
Domain name.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
forwarder String
DNS zone forwarder IP address list.
forwarder6 String
Forwarder IPv6 address.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ipMaster String
IP address of master DNS server. Entries in this master DNS server and imported into the DNS zone.
ipPrimary String
IP address of primary DNS server. Entries in this primary DNS server and imported into the DNS zone.
name Changes to this property will trigger replacement. String
Zone name.
primaryName String
Domain name of the default DNS server for this zone.
rrMax Number
Maximum number of resource records (10 - 65536, 0 means infinite).
sourceIp String
Source IP for forwarding to DNS server.
sourceIp6 String
IPv6 source IP address for forwarding to DNS server.
status String
Enable/disable this DNS zone. Valid values: enable, disable.
ttl Number
Default time-to-live value for the entries of this DNS zone (0 - 2147483647 sec, default = 86400).
type String
Zone type (primary to manage entries directly, secondary to import entries from other zones).
vdomparam Changes to this property will trigger replacement. 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.
view String
Zone view (public to serve public clients, shadow to serve internal clients).

Supporting Types

DnsdatabaseDnsEntry
, DnsdatabaseDnsEntryArgs

CanonicalName string
Canonical name of the host.
Hostname string
Name of the host.
Id int
DNS entry ID.
Ip string
IPv4 address of the host.
Ipv6 string
IPv6 address of the host.
Preference int
DNS entry preference (0 - 65535, highest preference = 0, default = 10).
Status string
Enable/disable resource record status. Valid values: enable, disable.
Ttl int
Time-to-live for this entry (0 to 2147483647 sec, default = 0).
Type string
Resource record type. Valid values: A, NS, CNAME, MX, AAAA, PTR, PTR_V6.
CanonicalName string
Canonical name of the host.
Hostname string
Name of the host.
Id int
DNS entry ID.
Ip string
IPv4 address of the host.
Ipv6 string
IPv6 address of the host.
Preference int
DNS entry preference (0 - 65535, highest preference = 0, default = 10).
Status string
Enable/disable resource record status. Valid values: enable, disable.
Ttl int
Time-to-live for this entry (0 to 2147483647 sec, default = 0).
Type string
Resource record type. Valid values: A, NS, CNAME, MX, AAAA, PTR, PTR_V6.
canonicalName String
Canonical name of the host.
hostname String
Name of the host.
id Integer
DNS entry ID.
ip String
IPv4 address of the host.
ipv6 String
IPv6 address of the host.
preference Integer
DNS entry preference (0 - 65535, highest preference = 0, default = 10).
status String
Enable/disable resource record status. Valid values: enable, disable.
ttl Integer
Time-to-live for this entry (0 to 2147483647 sec, default = 0).
type String
Resource record type. Valid values: A, NS, CNAME, MX, AAAA, PTR, PTR_V6.
canonicalName string
Canonical name of the host.
hostname string
Name of the host.
id number
DNS entry ID.
ip string
IPv4 address of the host.
ipv6 string
IPv6 address of the host.
preference number
DNS entry preference (0 - 65535, highest preference = 0, default = 10).
status string
Enable/disable resource record status. Valid values: enable, disable.
ttl number
Time-to-live for this entry (0 to 2147483647 sec, default = 0).
type string
Resource record type. Valid values: A, NS, CNAME, MX, AAAA, PTR, PTR_V6.
canonical_name str
Canonical name of the host.
hostname str
Name of the host.
id int
DNS entry ID.
ip str
IPv4 address of the host.
ipv6 str
IPv6 address of the host.
preference int
DNS entry preference (0 - 65535, highest preference = 0, default = 10).
status str
Enable/disable resource record status. Valid values: enable, disable.
ttl int
Time-to-live for this entry (0 to 2147483647 sec, default = 0).
type str
Resource record type. Valid values: A, NS, CNAME, MX, AAAA, PTR, PTR_V6.
canonicalName String
Canonical name of the host.
hostname String
Name of the host.
id Number
DNS entry ID.
ip String
IPv4 address of the host.
ipv6 String
IPv6 address of the host.
preference Number
DNS entry preference (0 - 65535, highest preference = 0, default = 10).
status String
Enable/disable resource record status. Valid values: enable, disable.
ttl Number
Time-to-live for this entry (0 to 2147483647 sec, default = 0).
type String
Resource record type. Valid values: A, NS, CNAME, MX, AAAA, PTR, PTR_V6.

Import

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

$ pulumi import fortios:system/dnsdatabase:Dnsdatabase labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/dnsdatabase:Dnsdatabase labelname {{name}}
Copy

$ 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.