1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getNtp
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

iosxe.getNtp

Explore with Pulumi AI

Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

This data source can read the NTP configuration.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Iosxe = Pulumi.Iosxe;

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetNtp.Invoke();

});
Copy
package main

import (
	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iosxe.LookupNtp(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.IosxeFunctions;
import com.pulumi.iosxe.inputs.GetNtpArgs;
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) {
        final var example = IosxeFunctions.getNtp();

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as iosxe from "@pulumi/iosxe";

const example = iosxe.getNtp({});
Copy
import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_ntp()
Copy
variables:
  example:
    fn::invoke:
      Function: iosxe:getNtp
      Arguments: {}
Copy

Using getNtp

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNtp(args: GetNtpArgs, opts?: InvokeOptions): Promise<GetNtpResult>
function getNtpOutput(args: GetNtpOutputArgs, opts?: InvokeOptions): Output<GetNtpResult>
Copy
def get_ntp(device: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetNtpResult
def get_ntp_output(device: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetNtpResult]
Copy
func LookupNtp(ctx *Context, args *LookupNtpArgs, opts ...InvokeOption) (*LookupNtpResult, error)
func LookupNtpOutput(ctx *Context, args *LookupNtpOutputArgs, opts ...InvokeOption) LookupNtpResultOutput
Copy

> Note: This function is named LookupNtp in the Go SDK.

public static class GetNtp 
{
    public static Task<GetNtpResult> InvokeAsync(GetNtpArgs args, InvokeOptions? opts = null)
    public static Output<GetNtpResult> Invoke(GetNtpInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNtpResult> getNtp(GetNtpArgs args, InvokeOptions options)
public static Output<GetNtpResult> getNtp(GetNtpArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: iosxe:index/getNtp:getNtp
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Device string
A device name from the provider configuration.
Device string
A device name from the provider configuration.
device String
A device name from the provider configuration.
device string
A device name from the provider configuration.
device str
A device name from the provider configuration.
device String
A device name from the provider configuration.

getNtp Result

The following output properties are available:

AccessGroupPeerAcl string
AccessGroupQueryOnlyAcl string
AccessGroupServeAcl string
AccessGroupServeOnlyAcl string
Authenticate bool
Authenticate time sources
AuthenticationKeys List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetNtpAuthenticationKey>
Authentication key for trusted time sources
ClockPeriod int
Length of hardware clock tick
Id string
The path of the retrieved object.
Logging bool
Enable NTP message logging
Master bool
Act as NTP master clock
MasterStratum int
Passive bool
NTP passive mode
PeerVrfs List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetNtpPeerVrf>
VPN Routing/Forwarding Information
Peers List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetNtpPeer>
ServerVrfs List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetNtpServerVrf>
VPN Routing/Forwarding Information
Servers List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetNtpServer>
TrapSourceFortyGigabitEthernet string
Forty GigabitEthernet
TrapSourceGigabitEthernet string
GigabitEthernet IEEE 802.3z
TrapSourceHundredGigE string
Hundred GigabitEthernet
TrapSourceLoopback int
Loopback interface
TrapSourcePortChannel int
Ethernet Channel of interfaces
TrapSourcePortChannelSubinterface string
TrapSourceTenGigabitEthernet string
Ten Gigabit Ethernet
TrapSourceVlan int
Iosxr Vlans
UpdateCalendar bool
Periodically update calendar with NTP time
Device string
A device name from the provider configuration.
AccessGroupPeerAcl string
AccessGroupQueryOnlyAcl string
AccessGroupServeAcl string
AccessGroupServeOnlyAcl string
Authenticate bool
Authenticate time sources
AuthenticationKeys []GetNtpAuthenticationKey
Authentication key for trusted time sources
ClockPeriod int
Length of hardware clock tick
Id string
The path of the retrieved object.
Logging bool
Enable NTP message logging
Master bool
Act as NTP master clock
MasterStratum int
Passive bool
NTP passive mode
PeerVrfs []GetNtpPeerVrf
VPN Routing/Forwarding Information
Peers []GetNtpPeer
ServerVrfs []GetNtpServerVrf
VPN Routing/Forwarding Information
Servers []GetNtpServer
TrapSourceFortyGigabitEthernet string
Forty GigabitEthernet
TrapSourceGigabitEthernet string
GigabitEthernet IEEE 802.3z
TrapSourceHundredGigE string
Hundred GigabitEthernet
TrapSourceLoopback int
Loopback interface
TrapSourcePortChannel int
Ethernet Channel of interfaces
TrapSourcePortChannelSubinterface string
TrapSourceTenGigabitEthernet string
Ten Gigabit Ethernet
TrapSourceVlan int
Iosxr Vlans
UpdateCalendar bool
Periodically update calendar with NTP time
Device string
A device name from the provider configuration.
accessGroupPeerAcl String
accessGroupQueryOnlyAcl String
accessGroupServeAcl String
accessGroupServeOnlyAcl String
authenticate Boolean
Authenticate time sources
authenticationKeys List<GetNtpAuthenticationKey>
Authentication key for trusted time sources
clockPeriod Integer
Length of hardware clock tick
id String
The path of the retrieved object.
logging Boolean
Enable NTP message logging
master Boolean
Act as NTP master clock
masterStratum Integer
passive Boolean
NTP passive mode
peerVrfs List<GetNtpPeerVrf>
VPN Routing/Forwarding Information
peers List<GetNtpPeer>
serverVrfs List<GetNtpServerVrf>
VPN Routing/Forwarding Information
servers List<GetNtpServer>
trapSourceFortyGigabitEthernet String
Forty GigabitEthernet
trapSourceGigabitEthernet String
GigabitEthernet IEEE 802.3z
trapSourceHundredGigE String
Hundred GigabitEthernet
trapSourceLoopback Integer
Loopback interface
trapSourcePortChannel Integer
Ethernet Channel of interfaces
trapSourcePortChannelSubinterface String
trapSourceTenGigabitEthernet String
Ten Gigabit Ethernet
trapSourceVlan Integer
Iosxr Vlans
updateCalendar Boolean
Periodically update calendar with NTP time
device String
A device name from the provider configuration.
accessGroupPeerAcl string
accessGroupQueryOnlyAcl string
accessGroupServeAcl string
accessGroupServeOnlyAcl string
authenticate boolean
Authenticate time sources
authenticationKeys GetNtpAuthenticationKey[]
Authentication key for trusted time sources
clockPeriod number
Length of hardware clock tick
id string
The path of the retrieved object.
logging boolean
Enable NTP message logging
master boolean
Act as NTP master clock
masterStratum number
passive boolean
NTP passive mode
peerVrfs GetNtpPeerVrf[]
VPN Routing/Forwarding Information
peers GetNtpPeer[]
serverVrfs GetNtpServerVrf[]
VPN Routing/Forwarding Information
servers GetNtpServer[]
trapSourceFortyGigabitEthernet string
Forty GigabitEthernet
trapSourceGigabitEthernet string
GigabitEthernet IEEE 802.3z
trapSourceHundredGigE string
Hundred GigabitEthernet
trapSourceLoopback number
Loopback interface
trapSourcePortChannel number
Ethernet Channel of interfaces
trapSourcePortChannelSubinterface string
trapSourceTenGigabitEthernet string
Ten Gigabit Ethernet
trapSourceVlan number
Iosxr Vlans
updateCalendar boolean
Periodically update calendar with NTP time
device string
A device name from the provider configuration.
access_group_peer_acl str
access_group_query_only_acl str
access_group_serve_acl str
access_group_serve_only_acl str
authenticate bool
Authenticate time sources
authentication_keys Sequence[GetNtpAuthenticationKey]
Authentication key for trusted time sources
clock_period int
Length of hardware clock tick
id str
The path of the retrieved object.
logging bool
Enable NTP message logging
master bool
Act as NTP master clock
master_stratum int
passive bool
NTP passive mode
peer_vrfs Sequence[GetNtpPeerVrf]
VPN Routing/Forwarding Information
peers Sequence[GetNtpPeer]
server_vrfs Sequence[GetNtpServerVrf]
VPN Routing/Forwarding Information
servers Sequence[GetNtpServer]
trap_source_forty_gigabit_ethernet str
Forty GigabitEthernet
trap_source_gigabit_ethernet str
GigabitEthernet IEEE 802.3z
trap_source_hundred_gig_e str
Hundred GigabitEthernet
trap_source_loopback int
Loopback interface
trap_source_port_channel int
Ethernet Channel of interfaces
trap_source_port_channel_subinterface str
trap_source_ten_gigabit_ethernet str
Ten Gigabit Ethernet
trap_source_vlan int
Iosxr Vlans
update_calendar bool
Periodically update calendar with NTP time
device str
A device name from the provider configuration.
accessGroupPeerAcl String
accessGroupQueryOnlyAcl String
accessGroupServeAcl String
accessGroupServeOnlyAcl String
authenticate Boolean
Authenticate time sources
authenticationKeys List<Property Map>
Authentication key for trusted time sources
clockPeriod Number
Length of hardware clock tick
id String
The path of the retrieved object.
logging Boolean
Enable NTP message logging
master Boolean
Act as NTP master clock
masterStratum Number
passive Boolean
NTP passive mode
peerVrfs List<Property Map>
VPN Routing/Forwarding Information
peers List<Property Map>
serverVrfs List<Property Map>
VPN Routing/Forwarding Information
servers List<Property Map>
trapSourceFortyGigabitEthernet String
Forty GigabitEthernet
trapSourceGigabitEthernet String
GigabitEthernet IEEE 802.3z
trapSourceHundredGigE String
Hundred GigabitEthernet
trapSourceLoopback Number
Loopback interface
trapSourcePortChannel Number
Ethernet Channel of interfaces
trapSourcePortChannelSubinterface String
trapSourceTenGigabitEthernet String
Ten Gigabit Ethernet
trapSourceVlan Number
Iosxr Vlans
updateCalendar Boolean
Periodically update calendar with NTP time
device String
A device name from the provider configuration.

Supporting Types

GetNtpAuthenticationKey

CmacAes128 This property is required. string
CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
EncryptionType This property is required. int
Authentication key encryption type
HmacSha1 This property is required. string
HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
HmacSha2256 This property is required. string
HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
Md5 This property is required. string
MD5 authentication
Number This property is required. int
Sha1 This property is required. string
SHA1 (digest length = 160 bits, key length = [1-32] bytes)
Sha2 This property is required. string
SHA-256 (digest length = 256 bits, key length = [1-32] bytes)
CmacAes128 This property is required. string
CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
EncryptionType This property is required. int
Authentication key encryption type
HmacSha1 This property is required. string
HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
HmacSha2256 This property is required. string
HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
Md5 This property is required. string
MD5 authentication
Number This property is required. int
Sha1 This property is required. string
SHA1 (digest length = 160 bits, key length = [1-32] bytes)
Sha2 This property is required. string
SHA-256 (digest length = 256 bits, key length = [1-32] bytes)
cmacAes128 This property is required. String
CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
encryptionType This property is required. Integer
Authentication key encryption type
hmacSha1 This property is required. String
HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
hmacSha2256 This property is required. String
HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
md5 This property is required. String
MD5 authentication
number This property is required. Integer
sha1 This property is required. String
SHA1 (digest length = 160 bits, key length = [1-32] bytes)
sha2 This property is required. String
SHA-256 (digest length = 256 bits, key length = [1-32] bytes)
cmacAes128 This property is required. string
CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
encryptionType This property is required. number
Authentication key encryption type
hmacSha1 This property is required. string
HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
hmacSha2256 This property is required. string
HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
md5 This property is required. string
MD5 authentication
number This property is required. number
sha1 This property is required. string
SHA1 (digest length = 160 bits, key length = [1-32] bytes)
sha2 This property is required. string
SHA-256 (digest length = 256 bits, key length = [1-32] bytes)
cmac_aes128 This property is required. str
CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
encryption_type This property is required. int
Authentication key encryption type
hmac_sha1 This property is required. str
HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
hmac_sha2256 This property is required. str
HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
md5 This property is required. str
MD5 authentication
number This property is required. int
sha1 This property is required. str
SHA1 (digest length = 160 bits, key length = [1-32] bytes)
sha2 This property is required. str
SHA-256 (digest length = 256 bits, key length = [1-32] bytes)
cmacAes128 This property is required. String
CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
encryptionType This property is required. Number
Authentication key encryption type
hmacSha1 This property is required. String
HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
hmacSha2256 This property is required. String
HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
md5 This property is required. String
MD5 authentication
number This property is required. Number
sha1 This property is required. String
SHA1 (digest length = 160 bits, key length = [1-32] bytes)
sha2 This property is required. String
SHA-256 (digest length = 256 bits, key length = [1-32] bytes)

GetNtpPeer

IpAddress This property is required. string
Key This property is required. int
Configure peer authentication key
Prefer This property is required. bool
Prefer this peer when possible
Source This property is required. string
Interface for source address
Version This property is required. int
Configure NTP version
IpAddress This property is required. string
Key This property is required. int
Configure peer authentication key
Prefer This property is required. bool
Prefer this peer when possible
Source This property is required. string
Interface for source address
Version This property is required. int
Configure NTP version
ipAddress This property is required. String
key This property is required. Integer
Configure peer authentication key
prefer This property is required. Boolean
Prefer this peer when possible
source This property is required. String
Interface for source address
version This property is required. Integer
Configure NTP version
ipAddress This property is required. string
key This property is required. number
Configure peer authentication key
prefer This property is required. boolean
Prefer this peer when possible
source This property is required. string
Interface for source address
version This property is required. number
Configure NTP version
ip_address This property is required. str
key This property is required. int
Configure peer authentication key
prefer This property is required. bool
Prefer this peer when possible
source This property is required. str
Interface for source address
version This property is required. int
Configure NTP version
ipAddress This property is required. String
key This property is required. Number
Configure peer authentication key
prefer This property is required. Boolean
Prefer this peer when possible
source This property is required. String
Interface for source address
version This property is required. Number
Configure NTP version

GetNtpPeerVrf

Name This property is required. string
Peers This property is required. List<Lbrlabs.PulumiPackage.Iosxe.Inputs.GetNtpPeerVrfPeer>
Name This property is required. string
Peers This property is required. []GetNtpPeerVrfPeer
name This property is required. String
peers This property is required. List<GetNtpPeerVrfPeer>
name This property is required. string
peers This property is required. GetNtpPeerVrfPeer[]
name This property is required. str
peers This property is required. Sequence[GetNtpPeerVrfPeer]
name This property is required. String
peers This property is required. List<Property Map>

GetNtpPeerVrfPeer

IpAddress This property is required. string
Key This property is required. int
Configure peer authentication key
Prefer This property is required. bool
Prefer this peer when possible
Version This property is required. int
Configure NTP version
IpAddress This property is required. string
Key This property is required. int
Configure peer authentication key
Prefer This property is required. bool
Prefer this peer when possible
Version This property is required. int
Configure NTP version
ipAddress This property is required. String
key This property is required. Integer
Configure peer authentication key
prefer This property is required. Boolean
Prefer this peer when possible
version This property is required. Integer
Configure NTP version
ipAddress This property is required. string
key This property is required. number
Configure peer authentication key
prefer This property is required. boolean
Prefer this peer when possible
version This property is required. number
Configure NTP version
ip_address This property is required. str
key This property is required. int
Configure peer authentication key
prefer This property is required. bool
Prefer this peer when possible
version This property is required. int
Configure NTP version
ipAddress This property is required. String
key This property is required. Number
Configure peer authentication key
prefer This property is required. Boolean
Prefer this peer when possible
version This property is required. Number
Configure NTP version

GetNtpServer

IpAddress This property is required. string
Key This property is required. int
Configure peer authentication key
Prefer This property is required. bool
Prefer this peer when possible
Source This property is required. string
Interface for source address
Version This property is required. int
Configure NTP version
IpAddress This property is required. string
Key This property is required. int
Configure peer authentication key
Prefer This property is required. bool
Prefer this peer when possible
Source This property is required. string
Interface for source address
Version This property is required. int
Configure NTP version
ipAddress This property is required. String
key This property is required. Integer
Configure peer authentication key
prefer This property is required. Boolean
Prefer this peer when possible
source This property is required. String
Interface for source address
version This property is required. Integer
Configure NTP version
ipAddress This property is required. string
key This property is required. number
Configure peer authentication key
prefer This property is required. boolean
Prefer this peer when possible
source This property is required. string
Interface for source address
version This property is required. number
Configure NTP version
ip_address This property is required. str
key This property is required. int
Configure peer authentication key
prefer This property is required. bool
Prefer this peer when possible
source This property is required. str
Interface for source address
version This property is required. int
Configure NTP version
ipAddress This property is required. String
key This property is required. Number
Configure peer authentication key
prefer This property is required. Boolean
Prefer this peer when possible
source This property is required. String
Interface for source address
version This property is required. Number
Configure NTP version

GetNtpServerVrf

Name This property is required. string
Servers This property is required. List<Lbrlabs.PulumiPackage.Iosxe.Inputs.GetNtpServerVrfServer>
Name This property is required. string
Servers This property is required. []GetNtpServerVrfServer
name This property is required. String
servers This property is required. List<GetNtpServerVrfServer>
name This property is required. string
servers This property is required. GetNtpServerVrfServer[]
name This property is required. str
servers This property is required. Sequence[GetNtpServerVrfServer]
name This property is required. String
servers This property is required. List<Property Map>

GetNtpServerVrfServer

IpAddress This property is required. string
Key This property is required. int
Configure peer authentication key
Prefer This property is required. bool
Prefer this peer when possible
Version This property is required. int
Configure NTP version
IpAddress This property is required. string
Key This property is required. int
Configure peer authentication key
Prefer This property is required. bool
Prefer this peer when possible
Version This property is required. int
Configure NTP version
ipAddress This property is required. String
key This property is required. Integer
Configure peer authentication key
prefer This property is required. Boolean
Prefer this peer when possible
version This property is required. Integer
Configure NTP version
ipAddress This property is required. string
key This property is required. number
Configure peer authentication key
prefer This property is required. boolean
Prefer this peer when possible
version This property is required. number
Configure NTP version
ip_address This property is required. str
key This property is required. int
Configure peer authentication key
prefer This property is required. bool
Prefer this peer when possible
version This property is required. int
Configure NTP version
ipAddress This property is required. String
key This property is required. Number
Configure peer authentication key
prefer This property is required. Boolean
Prefer this peer when possible
version This property is required. Number
Configure NTP version

Package Details

Repository
iosxe lbrlabs/pulumi-iosxe
License
Apache-2.0
Notes
This Pulumi package is based on the iosxe Terraform Provider.
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs