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

iosxe logo
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();
    
    });
    
    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 pulumi
    import pulumi_iosxe as iosxe
    
    example = iosxe.get_ntp()
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@pulumi/iosxe";
    
    const example = iosxe.getNtp({});
    
    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: iosxe:index/getNtp:getNtp
      arguments:
        # arguments dictionary

    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 string
    CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
    EncryptionType int
    Authentication key encryption type
    HmacSha1 string
    HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
    HmacSha2256 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)
    CmacAes128 string
    CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
    EncryptionType int
    Authentication key encryption type
    HmacSha1 string
    HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
    HmacSha2256 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)
    cmacAes128 String
    CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
    encryptionType Integer
    Authentication key encryption type
    hmacSha1 String
    HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
    hmacSha2256 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)
    cmacAes128 string
    CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
    encryptionType number
    Authentication key encryption type
    hmacSha1 string
    HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
    hmacSha2256 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)
    cmacAes128 String
    CMAC-AES-128 (digest length = 128 bits, key length = [16 or 32] bytes)
    encryptionType Number
    Authentication key encryption type
    hmacSha1 String
    HMAC-SHA1 (digest length = 160 bits, key length = [1-32] bytes)
    hmacSha2256 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

    IpAddress string
    Key int
    Configure peer authentication key
    Prefer bool
    Prefer this peer when possible
    Source string
    Interface for source address
    Version int
    Configure NTP version
    IpAddress string
    Key int
    Configure peer authentication key
    Prefer bool
    Prefer this peer when possible
    Source string
    Interface for source address
    Version int
    Configure NTP version
    ipAddress String
    key Integer
    Configure peer authentication key
    prefer Boolean
    Prefer this peer when possible
    source String
    Interface for source address
    version Integer
    Configure NTP version
    ipAddress string
    key number
    Configure peer authentication key
    prefer boolean
    Prefer this peer when possible
    source string
    Interface for source address
    version number
    Configure NTP version
    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
    ipAddress String
    key Number
    Configure peer authentication key
    prefer Boolean
    Prefer this peer when possible
    source String
    Interface for source address
    version Number
    Configure NTP version

    GetNtpPeerVrf

    GetNtpPeerVrfPeer

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

    GetNtpServer

    IpAddress string
    Key int
    Configure peer authentication key
    Prefer bool
    Prefer this peer when possible
    Source string
    Interface for source address
    Version int
    Configure NTP version
    IpAddress string
    Key int
    Configure peer authentication key
    Prefer bool
    Prefer this peer when possible
    Source string
    Interface for source address
    Version int
    Configure NTP version
    ipAddress String
    key Integer
    Configure peer authentication key
    prefer Boolean
    Prefer this peer when possible
    source String
    Interface for source address
    version Integer
    Configure NTP version
    ipAddress string
    key number
    Configure peer authentication key
    prefer boolean
    Prefer this peer when possible
    source string
    Interface for source address
    version number
    Configure NTP version
    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
    ipAddress String
    key Number
    Configure peer authentication key
    prefer Boolean
    Prefer this peer when possible
    source String
    Interface for source address
    version Number
    Configure NTP version

    GetNtpServerVrf

    GetNtpServerVrfServer

    IpAddress string
    Key int
    Configure peer authentication key
    Prefer bool
    Prefer this peer when possible
    Version int
    Configure NTP version
    IpAddress string
    Key int
    Configure peer authentication key
    Prefer bool
    Prefer this peer when possible
    Version int
    Configure NTP version
    ipAddress String
    key Integer
    Configure peer authentication key
    prefer Boolean
    Prefer this peer when possible
    version Integer
    Configure NTP version
    ipAddress string
    key number
    Configure peer authentication key
    prefer boolean
    Prefer this peer when possible
    version number
    Configure NTP version
    ip_address str
    key int
    Configure peer authentication key
    prefer bool
    Prefer this peer when possible
    version int
    Configure NTP version
    ipAddress String
    key Number
    Configure peer authentication key
    prefer Boolean
    Prefer this peer when possible
    version 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.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs