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

fortios.system.Ntp

Explore with Pulumi AI

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

    Configure system NTP information.

    Example Usage

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

const trname = new fortios.system.Ntp("trname", {
    ntpsync: "enable",
    serverMode: "disable",
    sourceIp: "0.0.0.0",
    sourceIp6: "::",
    syncinterval: 1,
    type: "fortiguard",
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Ntp("trname",
    ntpsync="enable",
    server_mode="disable",
    source_ip="0.0.0.0",
    source_ip6="::",
    syncinterval=1,
    type="fortiguard")

    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.NewNtp(ctx, "trname", &system.NtpArgs{
			Ntpsync:      pulumi.String("enable"),
			ServerMode:   pulumi.String("disable"),
			SourceIp:     pulumi.String("0.0.0.0"),
			SourceIp6:    pulumi.String("::"),
			Syncinterval: pulumi.Int(1),
			Type:         pulumi.String("fortiguard"),
		})
		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.Ntp("trname", new()
    {
        Ntpsync = "enable",
        ServerMode = "disable",
        SourceIp = "0.0.0.0",
        SourceIp6 = "::",
        Syncinterval = 1,
        Type = "fortiguard",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Ntp;
import com.pulumi.fortios.system.NtpArgs;
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 Ntp("trname", NtpArgs.builder()
            .ntpsync("enable")
            .serverMode("disable")
            .sourceIp("0.0.0.0")
            .sourceIp6("::")
            .syncinterval(1)
            .type("fortiguard")
            .build());

    }
}

    resources:
  trname:
    type: fortios:system:Ntp
    properties:
      ntpsync: enable
      serverMode: disable
      sourceIp: 0.0.0.0
      sourceIp6: '::'
      syncinterval: 1
      type: fortiguard

    Create Ntp Resource

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

    Constructor syntax

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

@overload
def Ntp(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        interfaces: Optional[Sequence[NtpInterfaceArgs]] = None,
        key: Optional[str] = None,
        key_id: Optional[int] = None,
        key_type: Optional[str] = None,
        ntpservers: Optional[Sequence[NtpNtpserverArgs]] = None,
        ntpsync: Optional[str] = None,
        server_mode: Optional[str] = None,
        source_ip: Optional[str] = None,
        source_ip6: Optional[str] = None,
        syncinterval: Optional[int] = None,
        type: Optional[str] = None,
        vdomparam: Optional[str] = None)
    func NewNtp(ctx *Context, name string, args *NtpArgs, opts ...ResourceOption) (*Ntp, error)
    public Ntp(string name, NtpArgs? args = null, CustomResourceOptions? opts = null)
    public Ntp(String name, NtpArgs args)
public Ntp(String name, NtpArgs args, CustomResourceOptions options)

    type: fortios:system:Ntp
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 NtpArgs
    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 NtpArgs
    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 NtpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NtpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NtpArgs
    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 ntpResource = new Fortios.System.Ntp("ntpResource", new()
{
    Authentication = "string",
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    Interfaces = new[]
    {
        new Fortios.System.Inputs.NtpInterfaceArgs
        {
            InterfaceName = "string",
        },
    },
    Key = "string",
    KeyId = 0,
    KeyType = "string",
    Ntpservers = new[]
    {
        new Fortios.System.Inputs.NtpNtpserverArgs
        {
            Authentication = "string",
            Id = 0,
            Interface = "string",
            InterfaceSelectMethod = "string",
            IpType = "string",
            Key = "string",
            KeyId = 0,
            KeyType = "string",
            Ntpv3 = "string",
            Server = "string",
        },
    },
    Ntpsync = "string",
    ServerMode = "string",
    SourceIp = "string",
    SourceIp6 = "string",
    Syncinterval = 0,
    Type = "string",
    Vdomparam = "string",
});

    example, err := system.NewNtp(ctx, "ntpResource", &system.NtpArgs{
	Authentication:      pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Interfaces: system.NtpInterfaceArray{
		&system.NtpInterfaceArgs{
			InterfaceName: pulumi.String("string"),
		},
	},
	Key:     pulumi.String("string"),
	KeyId:   pulumi.Int(0),
	KeyType: pulumi.String("string"),
	Ntpservers: system.NtpNtpserverArray{
		&system.NtpNtpserverArgs{
			Authentication:        pulumi.String("string"),
			Id:                    pulumi.Int(0),
			Interface:             pulumi.String("string"),
			InterfaceSelectMethod: pulumi.String("string"),
			IpType:                pulumi.String("string"),
			Key:                   pulumi.String("string"),
			KeyId:                 pulumi.Int(0),
			KeyType:               pulumi.String("string"),
			Ntpv3:                 pulumi.String("string"),
			Server:                pulumi.String("string"),
		},
	},
	Ntpsync:      pulumi.String("string"),
	ServerMode:   pulumi.String("string"),
	SourceIp:     pulumi.String("string"),
	SourceIp6:    pulumi.String("string"),
	Syncinterval: pulumi.Int(0),
	Type:         pulumi.String("string"),
	Vdomparam:    pulumi.String("string"),
})

    var ntpResource = new Ntp("ntpResource", NtpArgs.builder()
    .authentication("string")
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .interfaces(NtpInterfaceArgs.builder()
        .interfaceName("string")
        .build())
    .key("string")
    .keyId(0)
    .keyType("string")
    .ntpservers(NtpNtpserverArgs.builder()
        .authentication("string")
        .id(0)
        .interface_("string")
        .interfaceSelectMethod("string")
        .ipType("string")
        .key("string")
        .keyId(0)
        .keyType("string")
        .ntpv3("string")
        .server("string")
        .build())
    .ntpsync("string")
    .serverMode("string")
    .sourceIp("string")
    .sourceIp6("string")
    .syncinterval(0)
    .type("string")
    .vdomparam("string")
    .build());

    ntp_resource = fortios.system.Ntp("ntpResource",
    authentication="string",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    interfaces=[{
        "interface_name": "string",
    }],
    key="string",
    key_id=0,
    key_type="string",
    ntpservers=[{
        "authentication": "string",
        "id": 0,
        "interface": "string",
        "interface_select_method": "string",
        "ip_type": "string",
        "key": "string",
        "key_id": 0,
        "key_type": "string",
        "ntpv3": "string",
        "server": "string",
    }],
    ntpsync="string",
    server_mode="string",
    source_ip="string",
    source_ip6="string",
    syncinterval=0,
    type="string",
    vdomparam="string")

    const ntpResource = new fortios.system.Ntp("ntpResource", {
    authentication: "string",
    dynamicSortSubtable: "string",
    getAllTables: "string",
    interfaces: [{
        interfaceName: "string",
    }],
    key: "string",
    keyId: 0,
    keyType: "string",
    ntpservers: [{
        authentication: "string",
        id: 0,
        "interface": "string",
        interfaceSelectMethod: "string",
        ipType: "string",
        key: "string",
        keyId: 0,
        keyType: "string",
        ntpv3: "string",
        server: "string",
    }],
    ntpsync: "string",
    serverMode: "string",
    sourceIp: "string",
    sourceIp6: "string",
    syncinterval: 0,
    type: "string",
    vdomparam: "string",
});

    type: fortios:system:Ntp
properties:
    authentication: string
    dynamicSortSubtable: string
    getAllTables: string
    interfaces:
        - interfaceName: string
    key: string
    keyId: 0
    keyType: string
    ntpservers:
        - authentication: string
          id: 0
          interface: string
          interfaceSelectMethod: string
          ipType: string
          key: string
          keyId: 0
          keyType: string
          ntpv3: string
          server: string
    ntpsync: string
    serverMode: string
    sourceIp: string
    sourceIp6: string
    syncinterval: 0
    type: string
    vdomparam: string

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

    Authentication string
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    Interfaces List<Pulumiverse.Fortios.System.Inputs.NtpInterface>
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    Key string
    Key for authentication.
    KeyId int
    Key ID for authentication.
    KeyType string
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    Ntpservers List<Pulumiverse.Fortios.System.Inputs.NtpNtpserver>
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    Ntpsync string
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    ServerMode string
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    SourceIp string
    Source IP address for communication to the NTP server.
    SourceIp6 string
    Source IPv6 address for communication to the NTP server.
    Syncinterval int
    NTP synchronization interval (1 - 1440 min).
    Type string
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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.
    Authentication string
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    Interfaces []NtpInterfaceArgs
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    Key string
    Key for authentication.
    KeyId int
    Key ID for authentication.
    KeyType string
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    Ntpservers []NtpNtpserverArgs
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    Ntpsync string
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    ServerMode string
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    SourceIp string
    Source IP address for communication to the NTP server.
    SourceIp6 string
    Source IPv6 address for communication to the NTP server.
    Syncinterval int
    NTP synchronization interval (1 - 1440 min).
    Type string
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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.
    authentication String
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    interfaces List<NtpInterface>
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    key String
    Key for authentication.
    keyId Integer
    Key ID for authentication.
    keyType String
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    ntpservers List<NtpNtpserver>
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    ntpsync String
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    serverMode String
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    sourceIp String
    Source IP address for communication to the NTP server.
    sourceIp6 String
    Source IPv6 address for communication to the NTP server.
    syncinterval Integer
    NTP synchronization interval (1 - 1440 min).
    type String
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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.
    authentication string
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    interfaces NtpInterface[]
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    key string
    Key for authentication.
    keyId number
    Key ID for authentication.
    keyType string
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    ntpservers NtpNtpserver[]
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    ntpsync string
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    serverMode string
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    sourceIp string
    Source IP address for communication to the NTP server.
    sourceIp6 string
    Source IPv6 address for communication to the NTP server.
    syncinterval number
    NTP synchronization interval (1 - 1440 min).
    type string
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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.
    authentication str
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    interfaces Sequence[NtpInterfaceArgs]
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    key str
    Key for authentication.
    key_id int
    Key ID for authentication.
    key_type str
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    ntpservers Sequence[NtpNtpserverArgs]
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    ntpsync str
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    server_mode str
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    source_ip str
    Source IP address for communication to the NTP server.
    source_ip6 str
    Source IPv6 address for communication to the NTP server.
    syncinterval int
    NTP synchronization interval (1 - 1440 min).
    type str
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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.
    authentication String
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    interfaces List<Property Map>
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    key String
    Key for authentication.
    keyId Number
    Key ID for authentication.
    keyType String
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    ntpservers List<Property Map>
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    ntpsync String
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    serverMode String
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    sourceIp String
    Source IP address for communication to the NTP server.
    sourceIp6 String
    Source IPv6 address for communication to the NTP server.
    syncinterval Number
    NTP synchronization interval (1 - 1440 min).
    type String
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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 Ntp 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 Ntp Resource

    Get an existing Ntp 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?: NtpState, opts?: CustomResourceOptions): Ntp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        interfaces: Optional[Sequence[NtpInterfaceArgs]] = None,
        key: Optional[str] = None,
        key_id: Optional[int] = None,
        key_type: Optional[str] = None,
        ntpservers: Optional[Sequence[NtpNtpserverArgs]] = None,
        ntpsync: Optional[str] = None,
        server_mode: Optional[str] = None,
        source_ip: Optional[str] = None,
        source_ip6: Optional[str] = None,
        syncinterval: Optional[int] = None,
        type: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Ntp
    func GetNtp(ctx *Context, name string, id IDInput, state *NtpState, opts ...ResourceOption) (*Ntp, error)
    public static Ntp Get(string name, Input<string> id, NtpState? state, CustomResourceOptions? opts = null)
    public static Ntp get(String name, Output<String> id, NtpState 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:
    Authentication string
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    Interfaces List<Pulumiverse.Fortios.System.Inputs.NtpInterface>
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    Key string
    Key for authentication.
    KeyId int
    Key ID for authentication.
    KeyType string
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    Ntpservers List<Pulumiverse.Fortios.System.Inputs.NtpNtpserver>
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    Ntpsync string
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    ServerMode string
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    SourceIp string
    Source IP address for communication to the NTP server.
    SourceIp6 string
    Source IPv6 address for communication to the NTP server.
    Syncinterval int
    NTP synchronization interval (1 - 1440 min).
    Type string
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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.
    Authentication string
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    Interfaces []NtpInterfaceArgs
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    Key string
    Key for authentication.
    KeyId int
    Key ID for authentication.
    KeyType string
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    Ntpservers []NtpNtpserverArgs
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    Ntpsync string
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    ServerMode string
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    SourceIp string
    Source IP address for communication to the NTP server.
    SourceIp6 string
    Source IPv6 address for communication to the NTP server.
    Syncinterval int
    NTP synchronization interval (1 - 1440 min).
    Type string
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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.
    authentication String
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    interfaces List<NtpInterface>
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    key String
    Key for authentication.
    keyId Integer
    Key ID for authentication.
    keyType String
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    ntpservers List<NtpNtpserver>
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    ntpsync String
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    serverMode String
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    sourceIp String
    Source IP address for communication to the NTP server.
    sourceIp6 String
    Source IPv6 address for communication to the NTP server.
    syncinterval Integer
    NTP synchronization interval (1 - 1440 min).
    type String
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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.
    authentication string
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    interfaces NtpInterface[]
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    key string
    Key for authentication.
    keyId number
    Key ID for authentication.
    keyType string
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    ntpservers NtpNtpserver[]
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    ntpsync string
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    serverMode string
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    sourceIp string
    Source IP address for communication to the NTP server.
    sourceIp6 string
    Source IPv6 address for communication to the NTP server.
    syncinterval number
    NTP synchronization interval (1 - 1440 min).
    type string
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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.
    authentication str
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    interfaces Sequence[NtpInterfaceArgs]
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    key str
    Key for authentication.
    key_id int
    Key ID for authentication.
    key_type str
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    ntpservers Sequence[NtpNtpserverArgs]
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    ntpsync str
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    server_mode str
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    source_ip str
    Source IP address for communication to the NTP server.
    source_ip6 str
    Source IPv6 address for communication to the NTP server.
    syncinterval int
    NTP synchronization interval (1 - 1440 min).
    type str
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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.
    authentication String
    Enable/disable authentication. Valid values: enable, disable.
    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 ].
    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.
    interfaces List<Property Map>
    FortiGate interface(s) with NTP server mode enabled. Devices on your network can contact these interfaces for NTP services. The structure of interface block is documented below.
    key String
    Key for authentication.
    keyId Number
    Key ID for authentication.
    keyType String
    Key type for authentication. On FortiOS versions 6.2.4-7.4.3: MD5, SHA1. On FortiOS versions >= 7.4.4: MD5, SHA1, SHA256.
    ntpservers List<Property Map>
    Configure the FortiGate to connect to any available third-party NTP server. The structure of ntpserver block is documented below.
    ntpsync String
    Enable/disable setting the FortiGate system time by synchronizing with an NTP Server. Valid values: enable, disable.
    serverMode String
    Enable/disable FortiGate NTP Server Mode. Your FortiGate becomes an NTP server for other devices on your network. The FortiGate relays NTP requests to its configured NTP server. Valid values: enable, disable.
    sourceIp String
    Source IP address for communication to the NTP server.
    sourceIp6 String
    Source IPv6 address for communication to the NTP server.
    syncinterval Number
    NTP synchronization interval (1 - 1440 min).
    type String
    Use the FortiGuard NTP server or any other available NTP Server. Valid values: fortiguard, custom.
    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.

    Supporting Types

    NtpInterface, NtpInterfaceArgs

    InterfaceName string
    Interface name.
    InterfaceName string
    Interface name.
    interfaceName String
    Interface name.
    interfaceName string
    Interface name.
    interface_name str
    Interface name.
    interfaceName String
    Interface name.

    NtpNtpserver, NtpNtpserverArgs

    Authentication string
    Enable/disable MD5/SHA1 authentication. Valid values: enable, disable.
    Id int
    NTP server ID.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    IpType string
    Choose to connect to IPv4 or/and IPv6 NTP server. Valid values: IPv6, IPv4, Both.
    Key string
    Key for authentication. On FortiOS versions 6.2.0: MD5(NTPv3)/SHA1(NTPv4). On FortiOS versions >= 7.4.4: MD5(NTPv3)/SHA1(NTPv4)/SHA256(NTPv4).
    KeyId int
    Key ID for authentication.
    KeyType string
    Select NTP authentication type. Valid values: MD5, SHA1, SHA256.
    Ntpv3 string
    Enable to use NTPv3 instead of NTPv4. Valid values: enable, disable.
    Server string
    IP address or hostname of the NTP Server.
    Authentication string
    Enable/disable MD5/SHA1 authentication. Valid values: enable, disable.
    Id int
    NTP server ID.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    IpType string
    Choose to connect to IPv4 or/and IPv6 NTP server. Valid values: IPv6, IPv4, Both.
    Key string
    Key for authentication. On FortiOS versions 6.2.0: MD5(NTPv3)/SHA1(NTPv4). On FortiOS versions >= 7.4.4: MD5(NTPv3)/SHA1(NTPv4)/SHA256(NTPv4).
    KeyId int
    Key ID for authentication.
    KeyType string
    Select NTP authentication type. Valid values: MD5, SHA1, SHA256.
    Ntpv3 string
    Enable to use NTPv3 instead of NTPv4. Valid values: enable, disable.
    Server string
    IP address or hostname of the NTP Server.
    authentication String
    Enable/disable MD5/SHA1 authentication. Valid values: enable, disable.
    id Integer
    NTP server ID.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    interface_ String
    Specify outgoing interface to reach server.
    ipType String
    Choose to connect to IPv4 or/and IPv6 NTP server. Valid values: IPv6, IPv4, Both.
    key String
    Key for authentication. On FortiOS versions 6.2.0: MD5(NTPv3)/SHA1(NTPv4). On FortiOS versions >= 7.4.4: MD5(NTPv3)/SHA1(NTPv4)/SHA256(NTPv4).
    keyId Integer
    Key ID for authentication.
    keyType String
    Select NTP authentication type. Valid values: MD5, SHA1, SHA256.
    ntpv3 String
    Enable to use NTPv3 instead of NTPv4. Valid values: enable, disable.
    server String
    IP address or hostname of the NTP Server.
    authentication string
    Enable/disable MD5/SHA1 authentication. Valid values: enable, disable.
    id number
    NTP server ID.
    interface string
    Specify outgoing interface to reach server.
    interfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    ipType string
    Choose to connect to IPv4 or/and IPv6 NTP server. Valid values: IPv6, IPv4, Both.
    key string
    Key for authentication. On FortiOS versions 6.2.0: MD5(NTPv3)/SHA1(NTPv4). On FortiOS versions >= 7.4.4: MD5(NTPv3)/SHA1(NTPv4)/SHA256(NTPv4).
    keyId number
    Key ID for authentication.
    keyType string
    Select NTP authentication type. Valid values: MD5, SHA1, SHA256.
    ntpv3 string
    Enable to use NTPv3 instead of NTPv4. Valid values: enable, disable.
    server string
    IP address or hostname of the NTP Server.
    authentication str
    Enable/disable MD5/SHA1 authentication. Valid values: enable, disable.
    id int
    NTP server ID.
    interface str
    Specify outgoing interface to reach server.
    interface_select_method str
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    ip_type str
    Choose to connect to IPv4 or/and IPv6 NTP server. Valid values: IPv6, IPv4, Both.
    key str
    Key for authentication. On FortiOS versions 6.2.0: MD5(NTPv3)/SHA1(NTPv4). On FortiOS versions >= 7.4.4: MD5(NTPv3)/SHA1(NTPv4)/SHA256(NTPv4).
    key_id int
    Key ID for authentication.
    key_type str
    Select NTP authentication type. Valid values: MD5, SHA1, SHA256.
    ntpv3 str
    Enable to use NTPv3 instead of NTPv4. Valid values: enable, disable.
    server str
    IP address or hostname of the NTP Server.
    authentication String
    Enable/disable MD5/SHA1 authentication. Valid values: enable, disable.
    id Number
    NTP server ID.
    interface String
    Specify outgoing interface to reach server.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    ipType String
    Choose to connect to IPv4 or/and IPv6 NTP server. Valid values: IPv6, IPv4, Both.
    key String
    Key for authentication. On FortiOS versions 6.2.0: MD5(NTPv3)/SHA1(NTPv4). On FortiOS versions >= 7.4.4: MD5(NTPv3)/SHA1(NTPv4)/SHA256(NTPv4).
    keyId Number
    Key ID for authentication.
    keyType String
    Select NTP authentication type. Valid values: MD5, SHA1, SHA256.
    ntpv3 String
    Enable to use NTPv3 instead of NTPv4. Valid values: enable, disable.
    server String
    IP address or hostname of the NTP Server.

    Import

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

    $ pulumi import fortios:system/ntp:Ntp labelname SystemNtp

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/ntp:Ntp labelname SystemNtp

    $ 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