1. Packages
  2. F5bigip Provider
  3. API Docs
  4. sys
  5. Ntp
f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi

f5bigip.sys.Ntp

Explore with Pulumi AI

f5bigip.sys.Ntp resource is helpful when configuring NTP server on the BIG-IP.

Example Usage

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

const ntp1 = new f5bigip.sys.Ntp("ntp1", {
    description: "/Common/NTP1",
    servers: ["time.facebook.com"],
    timezone: "America/Los_Angeles",
});
Copy
import pulumi
import pulumi_f5bigip as f5bigip

ntp1 = f5bigip.sys.Ntp("ntp1",
    description="/Common/NTP1",
    servers=["time.facebook.com"],
    timezone="America/Los_Angeles")
Copy
package main

import (
	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/sys"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sys.NewNtp(ctx, "ntp1", &sys.NtpArgs{
			Description: pulumi.String("/Common/NTP1"),
			Servers: pulumi.StringArray{
				pulumi.String("time.facebook.com"),
			},
			Timezone: pulumi.String("America/Los_Angeles"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;

return await Deployment.RunAsync(() => 
{
    var ntp1 = new F5BigIP.Sys.Ntp("ntp1", new()
    {
        Description = "/Common/NTP1",
        Servers = new[]
        {
            "time.facebook.com",
        },
        Timezone = "America/Los_Angeles",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.sys.Ntp;
import com.pulumi.f5bigip.sys.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 ntp1 = new Ntp("ntp1", NtpArgs.builder()
            .description("/Common/NTP1")
            .servers("time.facebook.com")
            .timezone("America/Los_Angeles")
            .build());

    }
}
Copy
resources:
  ntp1:
    type: f5bigip:sys:Ntp
    properties:
      description: /Common/NTP1
      servers:
        - time.facebook.com
      timezone: America/Los_Angeles
Copy

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: NtpArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Ntp(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        servers: Optional[Sequence[str]] = None,
        timezone: Optional[str] = None)
func NewNtp(ctx *Context, name string, args NtpArgs, opts ...ResourceOption) (*Ntp, error)
public Ntp(string name, NtpArgs args, CustomResourceOptions? opts = null)
public Ntp(String name, NtpArgs args)
public Ntp(String name, NtpArgs args, CustomResourceOptions options)
type: f5bigip:sys:Ntp
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. NtpArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. NtpArgs
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. NtpArgs
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. 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 F5BigIP.Sys.Ntp("ntpResource", new()
{
    Description = "string",
    Servers = new[]
    {
        "string",
    },
    Timezone = "string",
});
Copy
example, err := sys.NewNtp(ctx, "ntpResource", &sys.NtpArgs{
	Description: pulumi.String("string"),
	Servers: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timezone: pulumi.String("string"),
})
Copy
var ntpResource = new Ntp("ntpResource", NtpArgs.builder()
    .description("string")
    .servers("string")
    .timezone("string")
    .build());
Copy
ntp_resource = f5bigip.sys.Ntp("ntpResource",
    description="string",
    servers=["string"],
    timezone="string")
Copy
const ntpResource = new f5bigip.sys.Ntp("ntpResource", {
    description: "string",
    servers: ["string"],
    timezone: "string",
});
Copy
type: f5bigip:sys:Ntp
properties:
    description: string
    servers:
        - string
    timezone: string
Copy

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:

Description This property is required. string
User defined description.
Servers This property is required. List<string>
Specifies the time servers that the system uses to update the system time.
Timezone string
Specifies the time zone that you want to use for the system time.
Description This property is required. string
User defined description.
Servers This property is required. []string
Specifies the time servers that the system uses to update the system time.
Timezone string
Specifies the time zone that you want to use for the system time.
description This property is required. String
User defined description.
servers This property is required. List<String>
Specifies the time servers that the system uses to update the system time.
timezone String
Specifies the time zone that you want to use for the system time.
description This property is required. string
User defined description.
servers This property is required. string[]
Specifies the time servers that the system uses to update the system time.
timezone string
Specifies the time zone that you want to use for the system time.
description This property is required. str
User defined description.
servers This property is required. Sequence[str]
Specifies the time servers that the system uses to update the system time.
timezone str
Specifies the time zone that you want to use for the system time.
description This property is required. String
User defined description.
servers This property is required. List<String>
Specifies the time servers that the system uses to update the system time.
timezone String
Specifies the time zone that you want to use for the system time.

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,
        description: Optional[str] = None,
        servers: Optional[Sequence[str]] = None,
        timezone: 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)
resources:  _:    type: f5bigip:sys:Ntp    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:
Description string
User defined description.
Servers List<string>
Specifies the time servers that the system uses to update the system time.
Timezone string
Specifies the time zone that you want to use for the system time.
Description string
User defined description.
Servers []string
Specifies the time servers that the system uses to update the system time.
Timezone string
Specifies the time zone that you want to use for the system time.
description String
User defined description.
servers List<String>
Specifies the time servers that the system uses to update the system time.
timezone String
Specifies the time zone that you want to use for the system time.
description string
User defined description.
servers string[]
Specifies the time servers that the system uses to update the system time.
timezone string
Specifies the time zone that you want to use for the system time.
description str
User defined description.
servers Sequence[str]
Specifies the time servers that the system uses to update the system time.
timezone str
Specifies the time zone that you want to use for the system time.
description String
User defined description.
servers List<String>
Specifies the time servers that the system uses to update the system time.
timezone String
Specifies the time zone that you want to use for the system time.

Package Details

Repository
f5 BIG-IP pulumi/pulumi-f5bigip
License
Apache-2.0
Notes
This Pulumi package is based on the bigip Terraform Provider.