Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
iosxe.getNtp
Explore with Pulumi AI
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();
});
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
	})
}
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();
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as iosxe from "@pulumi/iosxe";
const example = iosxe.getNtp({});
import pulumi
import pulumi_iosxe as iosxe
example = iosxe.get_ntp()
variables:
  example:
    fn::invoke:
      Function: iosxe:getNtp
      Arguments: {}
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>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]func LookupNtp(ctx *Context, args *LookupNtpArgs, opts ...InvokeOption) (*LookupNtpResult, error)
func LookupNtpOutput(ctx *Context, args *LookupNtpOutputArgs, opts ...InvokeOption) LookupNtpResultOutput> 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)
}public static CompletableFuture<GetNtpResult> getNtp(GetNtpArgs args, InvokeOptions options)
public static Output<GetNtpResult> getNtp(GetNtpArgs args, InvokeOptions options)
fn::invoke:
  function: iosxe:index/getNtp:getNtp
  arguments:
    # arguments dictionaryThe 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:
- Access
Group stringPeer Acl  - Access
Group stringQuery Only Acl  - Access
Group stringServe Acl  - Access
Group stringServe Only Acl  - Authenticate bool
 - Authenticate time sources
 - Authentication
Keys List<Lbrlabs.Pulumi Package. Iosxe. Outputs. Get Ntp Authentication Key>  - Authentication key for trusted time sources
 - Clock
Period 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
 - Master
Stratum int - Passive bool
 - NTP passive mode
 - Peer
Vrfs List<Lbrlabs.Pulumi Package. Iosxe. Outputs. Get Ntp Peer Vrf>  - VPN Routing/Forwarding Information
 - Peers
List<Lbrlabs.
Pulumi Package. Iosxe. Outputs. Get Ntp Peer>  - Server
Vrfs List<Lbrlabs.Pulumi Package. Iosxe. Outputs. Get Ntp Server Vrf>  - VPN Routing/Forwarding Information
 - Servers
List<Lbrlabs.
Pulumi Package. Iosxe. Outputs. Get Ntp Server>  - Trap
Source stringForty Gigabit Ethernet  - Forty GigabitEthernet
 - Trap
Source stringGigabit Ethernet  - GigabitEthernet IEEE 802.3z
 - Trap
Source stringHundred Gig E  - Hundred GigabitEthernet
 - Trap
Source intLoopback  - Loopback interface
 - Trap
Source intPort Channel  - Ethernet Channel of interfaces
 - Trap
Source stringPort Channel Subinterface  - Trap
Source stringTen Gigabit Ethernet  - Ten Gigabit Ethernet
 - Trap
Source intVlan  - Iosxr Vlans
 - Update
Calendar bool - Periodically update calendar with NTP time
 - Device string
 - A device name from the provider configuration.
 
- Access
Group stringPeer Acl  - Access
Group stringQuery Only Acl  - Access
Group stringServe Acl  - Access
Group stringServe Only Acl  - Authenticate bool
 - Authenticate time sources
 - Authentication
Keys []GetNtp Authentication Key  - Authentication key for trusted time sources
 - Clock
Period 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
 - Master
Stratum int - Passive bool
 - NTP passive mode
 - Peer
Vrfs []GetNtp Peer Vrf  - VPN Routing/Forwarding Information
 - Peers
[]Get
Ntp Peer  - Server
Vrfs []GetNtp Server Vrf  - VPN Routing/Forwarding Information
 - Servers
[]Get
Ntp Server  - Trap
Source stringForty Gigabit Ethernet  - Forty GigabitEthernet
 - Trap
Source stringGigabit Ethernet  - GigabitEthernet IEEE 802.3z
 - Trap
Source stringHundred Gig E  - Hundred GigabitEthernet
 - Trap
Source intLoopback  - Loopback interface
 - Trap
Source intPort Channel  - Ethernet Channel of interfaces
 - Trap
Source stringPort Channel Subinterface  - Trap
Source stringTen Gigabit Ethernet  - Ten Gigabit Ethernet
 - Trap
Source intVlan  - Iosxr Vlans
 - Update
Calendar bool - Periodically update calendar with NTP time
 - Device string
 - A device name from the provider configuration.
 
- access
Group StringPeer Acl  - access
Group StringQuery Only Acl  - access
Group StringServe Acl  - access
Group StringServe Only Acl  - authenticate Boolean
 - Authenticate time sources
 - authentication
Keys List<GetNtp Authentication Key>  - Authentication key for trusted time sources
 - clock
Period 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
 - master
Stratum Integer - passive Boolean
 - NTP passive mode
 - peer
Vrfs List<GetNtp Peer Vrf>  - VPN Routing/Forwarding Information
 - peers
List<Get
Ntp Peer>  - server
Vrfs List<GetNtp Server Vrf>  - VPN Routing/Forwarding Information
 - servers
List<Get
Ntp Server>  - trap
Source StringForty Gigabit Ethernet  - Forty GigabitEthernet
 - trap
Source StringGigabit Ethernet  - GigabitEthernet IEEE 802.3z
 - trap
Source StringHundred Gig E  - Hundred GigabitEthernet
 - trap
Source IntegerLoopback  - Loopback interface
 - trap
Source IntegerPort Channel  - Ethernet Channel of interfaces
 - trap
Source StringPort Channel Subinterface  - trap
Source StringTen Gigabit Ethernet  - Ten Gigabit Ethernet
 - trap
Source IntegerVlan  - Iosxr Vlans
 - update
Calendar Boolean - Periodically update calendar with NTP time
 - device String
 - A device name from the provider configuration.
 
- access
Group stringPeer Acl  - access
Group stringQuery Only Acl  - access
Group stringServe Acl  - access
Group stringServe Only Acl  - authenticate boolean
 - Authenticate time sources
 - authentication
Keys GetNtp Authentication Key[]  - Authentication key for trusted time sources
 - clock
Period 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
 - master
Stratum number - passive boolean
 - NTP passive mode
 - peer
Vrfs GetNtp Peer Vrf[]  - VPN Routing/Forwarding Information
 - peers
Get
Ntp Peer[]  - server
Vrfs GetNtp Server Vrf[]  - VPN Routing/Forwarding Information
 - servers
Get
Ntp Server[]  - trap
Source stringForty Gigabit Ethernet  - Forty GigabitEthernet
 - trap
Source stringGigabit Ethernet  - GigabitEthernet IEEE 802.3z
 - trap
Source stringHundred Gig E  - Hundred GigabitEthernet
 - trap
Source numberLoopback  - Loopback interface
 - trap
Source numberPort Channel  - Ethernet Channel of interfaces
 - trap
Source stringPort Channel Subinterface  - trap
Source stringTen Gigabit Ethernet  - Ten Gigabit Ethernet
 - trap
Source numberVlan  - Iosxr Vlans
 - update
Calendar boolean - Periodically update calendar with NTP time
 - device string
 - A device name from the provider configuration.
 
- access_
group_ strpeer_ acl  - access_
group_ strquery_ only_ acl  - access_
group_ strserve_ acl  - access_
group_ strserve_ only_ acl  - authenticate bool
 - Authenticate time sources
 - authentication_
keys Sequence[GetNtp Authentication Key]  - 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[GetNtp Peer Vrf]  - VPN Routing/Forwarding Information
 - peers
Sequence[Get
Ntp Peer]  - server_
vrfs Sequence[GetNtp Server Vrf]  - VPN Routing/Forwarding Information
 - servers
Sequence[Get
Ntp Server]  - trap_
source_ strforty_ gigabit_ ethernet  - Forty GigabitEthernet
 - trap_
source_ strgigabit_ ethernet  - GigabitEthernet IEEE 802.3z
 - trap_
source_ strhundred_ gig_ e  - Hundred GigabitEthernet
 - trap_
source_ intloopback  - Loopback interface
 - trap_
source_ intport_ channel  - Ethernet Channel of interfaces
 - trap_
source_ strport_ channel_ subinterface  - trap_
source_ strten_ gigabit_ ethernet  - Ten Gigabit Ethernet
 - trap_
source_ intvlan  - Iosxr Vlans
 - update_
calendar bool - Periodically update calendar with NTP time
 - device str
 - A device name from the provider configuration.
 
- access
Group StringPeer Acl  - access
Group StringQuery Only Acl  - access
Group StringServe Acl  - access
Group StringServe Only Acl  - authenticate Boolean
 - Authenticate time sources
 - authentication
Keys List<Property Map> - Authentication key for trusted time sources
 - clock
Period 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
 - master
Stratum Number - passive Boolean
 - NTP passive mode
 - peer
Vrfs List<Property Map> - VPN Routing/Forwarding Information
 - peers List<Property Map>
 - server
Vrfs List<Property Map> - VPN Routing/Forwarding Information
 - servers List<Property Map>
 - trap
Source StringForty Gigabit Ethernet  - Forty GigabitEthernet
 - trap
Source StringGigabit Ethernet  - GigabitEthernet IEEE 802.3z
 - trap
Source StringHundred Gig E  - Hundred GigabitEthernet
 - trap
Source NumberLoopback  - Loopback interface
 - trap
Source NumberPort Channel  - Ethernet Channel of interfaces
 - trap
Source StringPort Channel Subinterface  - trap
Source StringTen Gigabit Ethernet  - Ten Gigabit Ethernet
 - trap
Source NumberVlan  - Iosxr Vlans
 - update
Calendar Boolean - Periodically update calendar with NTP time
 - device String
 - A device name from the provider configuration.
 
Supporting Types
GetNtpAuthenticationKey   
- Cmac
Aes128 string - CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
 - Encryption
Type int - Authentication key encryption type
 - Hmac
Sha1 string - HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - Hmac
Sha2256 string - HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
 - Md5 string
 - MD5 authentication
 - Number int
 - Sha1 string
 - SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - Sha2 string
 - SHA-256 (digest length = 256 bits, key length = [1-32] bytes)
 
- Cmac
Aes128 string - CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
 - Encryption
Type int - Authentication key encryption type
 - Hmac
Sha1 string - HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - Hmac
Sha2256 string - HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
 - Md5 string
 - MD5 authentication
 - Number int
 - Sha1 string
 - SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - Sha2 string
 - SHA-256 (digest length = 256 bits, key length = [1-32] bytes)
 
- cmac
Aes128 String - CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
 - encryption
Type Integer - Authentication key encryption type
 - hmac
Sha1 String - HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - hmac
Sha2256 String - HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
 - md5 String
 - MD5 authentication
 - number Integer
 - sha1 String
 - SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - sha2 String
 - SHA-256 (digest length = 256 bits, key length = [1-32] bytes)
 
- cmac
Aes128 string - CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
 - encryption
Type number - Authentication key encryption type
 - hmac
Sha1 string - HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - hmac
Sha2256 string - HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
 - md5 string
 - MD5 authentication
 - number number
 - sha1 string
 - SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - sha2 string
 - SHA-256 (digest length = 256 bits, key length = [1-32] bytes)
 
- cmac_
aes128 str - CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
 - encryption_
type int - Authentication key encryption type
 - hmac_
sha1 str - HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - hmac_
sha2256 str - HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
 - md5 str
 - MD5 authentication
 - number int
 - sha1 str
 - SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - sha2 str
 - SHA-256 (digest length = 256 bits, key length = [1-32] bytes)
 
- cmac
Aes128 String - CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
 - encryption
Type Number - Authentication key encryption type
 - hmac
Sha1 String - HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - hmac
Sha2256 String - HMAC-SHA2-256 (digest length = 256 bits, key length = [1-32] bytes)
 - md5 String
 - MD5 authentication
 - number Number
 - sha1 String
 - SHA1 (digest length = 160 bits, key length = [1-32] bytes)
 - sha2 String
 - SHA-256 (digest length = 256 bits, key length = [1-32] bytes)
 
GetNtpPeer  
- ip_
address str - key int
 - Configure peer authentication key
 - prefer bool
 - Prefer this peer when possible
 - source str
 - Interface for source address
 - version int
 - Configure NTP version
 
GetNtpPeerVrf   
- Name string
 - Peers
[]Get
Ntp Peer Vrf Peer  
- name String
 - peers
List<Get
Ntp Peer Vrf Peer>  
- name string
 - peers
Get
Ntp Peer Vrf Peer[]  
- name String
 - peers List<Property Map>
 
GetNtpPeerVrfPeer    
- ip_
address str - key int
 - Configure peer authentication key
 - prefer bool
 - Prefer this peer when possible
 - version int
 - Configure NTP version
 
GetNtpServer  
- ip_
address str - key int
 - Configure peer authentication key
 - prefer bool
 - Prefer this peer when possible
 - source str
 - Interface for source address
 - version int
 - Configure NTP version
 
GetNtpServerVrf   
- name String
 - servers List<Property Map>
 
GetNtpServerVrfServer    
- ip_
address str - key int
 - Configure peer authentication key
 - prefer bool
 - Prefer this peer when possible
 - version int
 - Configure NTP version
 
Package Details
- Repository
 - iosxe lbrlabs/pulumi-iosxe
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
iosxeTerraform Provider.