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

iosxe.Ntp

Explore with Pulumi AI

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

    This resource can manage the NTP configuration.

    Example Usage

    Coming soon!

    Coming soon!

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.iosxe.Ntp;
    import com.pulumi.iosxe.NtpArgs;
    import com.pulumi.iosxe.inputs.NtpAuthenticationKeyArgs;
    import com.pulumi.iosxe.inputs.NtpPeerVrfArgs;
    import com.pulumi.iosxe.inputs.NtpPeerArgs;
    import com.pulumi.iosxe.inputs.NtpServerVrfArgs;
    import com.pulumi.iosxe.inputs.NtpServerArgs;
    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 example = new Ntp("example", NtpArgs.builder()        
                .accessGroupPeerAcl("SACL1")
                .accessGroupQueryOnlyAcl("SACL1")
                .accessGroupServeAcl("SACL1")
                .accessGroupServeOnlyAcl("SACL1")
                .authenticate(true)
                .authenticationKeys(NtpAuthenticationKeyArgs.builder()
                    .encryption_type(7)
                    .md5("060506324F41584B564347")
                    .number(1)
                    .build())
                .logging(false)
                .master(true)
                .masterStratum(5)
                .passive(false)
                .peerVrfs(NtpPeerVrfArgs.builder()
                    .name("VRF1")
                    .peers(NtpPeerVrfPeerArgs.builder()
                        .ipAddress("5.4.5.6")
                        .key(1)
                        .prefer(true)
                        .version(2)
                        .build())
                    .build())
                .peers(NtpPeerArgs.builder()
                    .ip_address("5.2.3.4")
                    .key(1)
                    .prefer(true)
                    .source("Loopback1")
                    .version(2)
                    .build())
                .serverVrfs(NtpServerVrfArgs.builder()
                    .name("VRF1")
                    .servers(NtpServerVrfServerArgs.builder()
                        .ipAddress("3.4.5.6")
                        .key(1)
                        .prefer(true)
                        .version(2)
                        .build())
                    .build())
                .servers(NtpServerArgs.builder()
                    .ip_address("1.2.3.4")
                    .key(1)
                    .prefer(true)
                    .source("Loopback1")
                    .version(2)
                    .build())
                .trapSourceLoopback(1)
                .updateCalendar(false)
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      example:
        type: iosxe:Ntp
        properties:
          accessGroupPeerAcl: SACL1
          accessGroupQueryOnlyAcl: SACL1
          accessGroupServeAcl: SACL1
          accessGroupServeOnlyAcl: SACL1
          authenticate: true
          authenticationKeys:
            - encryption_type: 7
              md5: 060506324F41584B564347
              number: 1
          logging: false
          master: true
          masterStratum: 5
          passive: false
          peerVrfs:
            - name: VRF1
              peers:
                - ipAddress: 5.4.5.6
                  key: 1
                  prefer: true
                  version: 2
          peers:
            - ip_address: 5.2.3.4
              key: 1
              prefer: true
              source: Loopback1
              version: 2
          serverVrfs:
            - name: VRF1
              servers:
                - ipAddress: 3.4.5.6
                  key: 1
                  prefer: true
                  version: 2
          servers:
            - ip_address: 1.2.3.4
              key: 1
              prefer: true
              source: Loopback1
              version: 2
          trapSourceLoopback: 1
          updateCalendar: false
    

    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,
            access_group_peer_acl: Optional[str] = None,
            access_group_query_only_acl: Optional[str] = None,
            access_group_serve_acl: Optional[str] = None,
            access_group_serve_only_acl: Optional[str] = None,
            authenticate: Optional[bool] = None,
            authentication_keys: Optional[Sequence[NtpAuthenticationKeyArgs]] = None,
            clock_period: Optional[int] = None,
            delete_mode: Optional[str] = None,
            device: Optional[str] = None,
            logging: Optional[bool] = None,
            master: Optional[bool] = None,
            master_stratum: Optional[int] = None,
            passive: Optional[bool] = None,
            peer_vrfs: Optional[Sequence[NtpPeerVrfArgs]] = None,
            peers: Optional[Sequence[NtpPeerArgs]] = None,
            server_vrfs: Optional[Sequence[NtpServerVrfArgs]] = None,
            servers: Optional[Sequence[NtpServerArgs]] = None,
            trap_source_forty_gigabit_ethernet: Optional[str] = None,
            trap_source_gigabit_ethernet: Optional[str] = None,
            trap_source_hundred_gig_e: Optional[str] = None,
            trap_source_loopback: Optional[int] = None,
            trap_source_port_channel: Optional[int] = None,
            trap_source_port_channel_subinterface: Optional[str] = None,
            trap_source_ten_gigabit_ethernet: Optional[str] = None,
            trap_source_vlan: Optional[int] = None,
            update_calendar: Optional[bool] = 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: iosxe: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 Iosxe.Ntp("ntpResource", new()
    {
        AccessGroupPeerAcl = "string",
        AccessGroupQueryOnlyAcl = "string",
        AccessGroupServeAcl = "string",
        AccessGroupServeOnlyAcl = "string",
        Authenticate = false,
        AuthenticationKeys = new[]
        {
            new Iosxe.Inputs.NtpAuthenticationKeyArgs
            {
                Number = 0,
                CmacAes128 = "string",
                EncryptionType = 0,
                HmacSha1 = "string",
                HmacSha2256 = "string",
                Md5 = "string",
                Sha1 = "string",
                Sha2 = "string",
            },
        },
        ClockPeriod = 0,
        DeleteMode = "string",
        Device = "string",
        Logging = false,
        Master = false,
        MasterStratum = 0,
        Passive = false,
        PeerVrfs = new[]
        {
            new Iosxe.Inputs.NtpPeerVrfArgs
            {
                Name = "string",
                Peers = new[]
                {
                    new Iosxe.Inputs.NtpPeerVrfPeerArgs
                    {
                        IpAddress = "string",
                        Key = 0,
                        Prefer = false,
                        Version = 0,
                    },
                },
            },
        },
        Peers = new[]
        {
            new Iosxe.Inputs.NtpPeerArgs
            {
                IpAddress = "string",
                Key = 0,
                Prefer = false,
                Source = "string",
                Version = 0,
            },
        },
        ServerVrfs = new[]
        {
            new Iosxe.Inputs.NtpServerVrfArgs
            {
                Name = "string",
                Servers = new[]
                {
                    new Iosxe.Inputs.NtpServerVrfServerArgs
                    {
                        IpAddress = "string",
                        Key = 0,
                        Prefer = false,
                        Version = 0,
                    },
                },
            },
        },
        Servers = new[]
        {
            new Iosxe.Inputs.NtpServerArgs
            {
                IpAddress = "string",
                Key = 0,
                Prefer = false,
                Source = "string",
                Version = 0,
            },
        },
        TrapSourceFortyGigabitEthernet = "string",
        TrapSourceGigabitEthernet = "string",
        TrapSourceHundredGigE = "string",
        TrapSourceLoopback = 0,
        TrapSourcePortChannel = 0,
        TrapSourcePortChannelSubinterface = "string",
        TrapSourceTenGigabitEthernet = "string",
        TrapSourceVlan = 0,
        UpdateCalendar = false,
    });
    
    example, err := iosxe.NewNtp(ctx, "ntpResource", &iosxe.NtpArgs{
    	AccessGroupPeerAcl:      pulumi.String("string"),
    	AccessGroupQueryOnlyAcl: pulumi.String("string"),
    	AccessGroupServeAcl:     pulumi.String("string"),
    	AccessGroupServeOnlyAcl: pulumi.String("string"),
    	Authenticate:            pulumi.Bool(false),
    	AuthenticationKeys: iosxe.NtpAuthenticationKeyArray{
    		&iosxe.NtpAuthenticationKeyArgs{
    			Number:         pulumi.Int(0),
    			CmacAes128:     pulumi.String("string"),
    			EncryptionType: pulumi.Int(0),
    			HmacSha1:       pulumi.String("string"),
    			HmacSha2256:    pulumi.String("string"),
    			Md5:            pulumi.String("string"),
    			Sha1:           pulumi.String("string"),
    			Sha2:           pulumi.String("string"),
    		},
    	},
    	ClockPeriod:   pulumi.Int(0),
    	DeleteMode:    pulumi.String("string"),
    	Device:        pulumi.String("string"),
    	Logging:       pulumi.Bool(false),
    	Master:        pulumi.Bool(false),
    	MasterStratum: pulumi.Int(0),
    	Passive:       pulumi.Bool(false),
    	PeerVrfs: iosxe.NtpPeerVrfArray{
    		&iosxe.NtpPeerVrfArgs{
    			Name: pulumi.String("string"),
    			Peers: iosxe.NtpPeerVrfPeerArray{
    				&iosxe.NtpPeerVrfPeerArgs{
    					IpAddress: pulumi.String("string"),
    					Key:       pulumi.Int(0),
    					Prefer:    pulumi.Bool(false),
    					Version:   pulumi.Int(0),
    				},
    			},
    		},
    	},
    	Peers: iosxe.NtpPeerArray{
    		&iosxe.NtpPeerArgs{
    			IpAddress: pulumi.String("string"),
    			Key:       pulumi.Int(0),
    			Prefer:    pulumi.Bool(false),
    			Source:    pulumi.String("string"),
    			Version:   pulumi.Int(0),
    		},
    	},
    	ServerVrfs: iosxe.NtpServerVrfArray{
    		&iosxe.NtpServerVrfArgs{
    			Name: pulumi.String("string"),
    			Servers: iosxe.NtpServerVrfServerArray{
    				&iosxe.NtpServerVrfServerArgs{
    					IpAddress: pulumi.String("string"),
    					Key:       pulumi.Int(0),
    					Prefer:    pulumi.Bool(false),
    					Version:   pulumi.Int(0),
    				},
    			},
    		},
    	},
    	Servers: iosxe.NtpServerArray{
    		&iosxe.NtpServerArgs{
    			IpAddress: pulumi.String("string"),
    			Key:       pulumi.Int(0),
    			Prefer:    pulumi.Bool(false),
    			Source:    pulumi.String("string"),
    			Version:   pulumi.Int(0),
    		},
    	},
    	TrapSourceFortyGigabitEthernet:    pulumi.String("string"),
    	TrapSourceGigabitEthernet:         pulumi.String("string"),
    	TrapSourceHundredGigE:             pulumi.String("string"),
    	TrapSourceLoopback:                pulumi.Int(0),
    	TrapSourcePortChannel:             pulumi.Int(0),
    	TrapSourcePortChannelSubinterface: pulumi.String("string"),
    	TrapSourceTenGigabitEthernet:      pulumi.String("string"),
    	TrapSourceVlan:                    pulumi.Int(0),
    	UpdateCalendar:                    pulumi.Bool(false),
    })
    
    var ntpResource = new Ntp("ntpResource", NtpArgs.builder()
        .accessGroupPeerAcl("string")
        .accessGroupQueryOnlyAcl("string")
        .accessGroupServeAcl("string")
        .accessGroupServeOnlyAcl("string")
        .authenticate(false)
        .authenticationKeys(NtpAuthenticationKeyArgs.builder()
            .number(0)
            .cmacAes128("string")
            .encryptionType(0)
            .hmacSha1("string")
            .hmacSha2256("string")
            .md5("string")
            .sha1("string")
            .sha2("string")
            .build())
        .clockPeriod(0)
        .deleteMode("string")
        .device("string")
        .logging(false)
        .master(false)
        .masterStratum(0)
        .passive(false)
        .peerVrfs(NtpPeerVrfArgs.builder()
            .name("string")
            .peers(NtpPeerVrfPeerArgs.builder()
                .ipAddress("string")
                .key(0)
                .prefer(false)
                .version(0)
                .build())
            .build())
        .peers(NtpPeerArgs.builder()
            .ipAddress("string")
            .key(0)
            .prefer(false)
            .source("string")
            .version(0)
            .build())
        .serverVrfs(NtpServerVrfArgs.builder()
            .name("string")
            .servers(NtpServerVrfServerArgs.builder()
                .ipAddress("string")
                .key(0)
                .prefer(false)
                .version(0)
                .build())
            .build())
        .servers(NtpServerArgs.builder()
            .ipAddress("string")
            .key(0)
            .prefer(false)
            .source("string")
            .version(0)
            .build())
        .trapSourceFortyGigabitEthernet("string")
        .trapSourceGigabitEthernet("string")
        .trapSourceHundredGigE("string")
        .trapSourceLoopback(0)
        .trapSourcePortChannel(0)
        .trapSourcePortChannelSubinterface("string")
        .trapSourceTenGigabitEthernet("string")
        .trapSourceVlan(0)
        .updateCalendar(false)
        .build());
    
    ntp_resource = iosxe.Ntp("ntpResource",
        access_group_peer_acl="string",
        access_group_query_only_acl="string",
        access_group_serve_acl="string",
        access_group_serve_only_acl="string",
        authenticate=False,
        authentication_keys=[{
            "number": 0,
            "cmac_aes128": "string",
            "encryption_type": 0,
            "hmac_sha1": "string",
            "hmac_sha2256": "string",
            "md5": "string",
            "sha1": "string",
            "sha2": "string",
        }],
        clock_period=0,
        delete_mode="string",
        device="string",
        logging=False,
        master=False,
        master_stratum=0,
        passive=False,
        peer_vrfs=[{
            "name": "string",
            "peers": [{
                "ip_address": "string",
                "key": 0,
                "prefer": False,
                "version": 0,
            }],
        }],
        peers=[{
            "ip_address": "string",
            "key": 0,
            "prefer": False,
            "source": "string",
            "version": 0,
        }],
        server_vrfs=[{
            "name": "string",
            "servers": [{
                "ip_address": "string",
                "key": 0,
                "prefer": False,
                "version": 0,
            }],
        }],
        servers=[{
            "ip_address": "string",
            "key": 0,
            "prefer": False,
            "source": "string",
            "version": 0,
        }],
        trap_source_forty_gigabit_ethernet="string",
        trap_source_gigabit_ethernet="string",
        trap_source_hundred_gig_e="string",
        trap_source_loopback=0,
        trap_source_port_channel=0,
        trap_source_port_channel_subinterface="string",
        trap_source_ten_gigabit_ethernet="string",
        trap_source_vlan=0,
        update_calendar=False)
    
    const ntpResource = new iosxe.Ntp("ntpResource", {
        accessGroupPeerAcl: "string",
        accessGroupQueryOnlyAcl: "string",
        accessGroupServeAcl: "string",
        accessGroupServeOnlyAcl: "string",
        authenticate: false,
        authenticationKeys: [{
            number: 0,
            cmacAes128: "string",
            encryptionType: 0,
            hmacSha1: "string",
            hmacSha2256: "string",
            md5: "string",
            sha1: "string",
            sha2: "string",
        }],
        clockPeriod: 0,
        deleteMode: "string",
        device: "string",
        logging: false,
        master: false,
        masterStratum: 0,
        passive: false,
        peerVrfs: [{
            name: "string",
            peers: [{
                ipAddress: "string",
                key: 0,
                prefer: false,
                version: 0,
            }],
        }],
        peers: [{
            ipAddress: "string",
            key: 0,
            prefer: false,
            source: "string",
            version: 0,
        }],
        serverVrfs: [{
            name: "string",
            servers: [{
                ipAddress: "string",
                key: 0,
                prefer: false,
                version: 0,
            }],
        }],
        servers: [{
            ipAddress: "string",
            key: 0,
            prefer: false,
            source: "string",
            version: 0,
        }],
        trapSourceFortyGigabitEthernet: "string",
        trapSourceGigabitEthernet: "string",
        trapSourceHundredGigE: "string",
        trapSourceLoopback: 0,
        trapSourcePortChannel: 0,
        trapSourcePortChannelSubinterface: "string",
        trapSourceTenGigabitEthernet: "string",
        trapSourceVlan: 0,
        updateCalendar: false,
    });
    
    type: iosxe:Ntp
    properties:
        accessGroupPeerAcl: string
        accessGroupQueryOnlyAcl: string
        accessGroupServeAcl: string
        accessGroupServeOnlyAcl: string
        authenticate: false
        authenticationKeys:
            - cmacAes128: string
              encryptionType: 0
              hmacSha1: string
              hmacSha2256: string
              md5: string
              number: 0
              sha1: string
              sha2: string
        clockPeriod: 0
        deleteMode: string
        device: string
        logging: false
        master: false
        masterStratum: 0
        passive: false
        peerVrfs:
            - name: string
              peers:
                - ipAddress: string
                  key: 0
                  prefer: false
                  version: 0
        peers:
            - ipAddress: string
              key: 0
              prefer: false
              source: string
              version: 0
        serverVrfs:
            - name: string
              servers:
                - ipAddress: string
                  key: 0
                  prefer: false
                  version: 0
        servers:
            - ipAddress: string
              key: 0
              prefer: false
              source: string
              version: 0
        trapSourceFortyGigabitEthernet: string
        trapSourceGigabitEthernet: string
        trapSourceHundredGigE: string
        trapSourceLoopback: 0
        trapSourcePortChannel: 0
        trapSourcePortChannelSubinterface: string
        trapSourceTenGigabitEthernet: string
        trapSourceVlan: 0
        updateCalendar: false
    

    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:

    AccessGroupPeerAcl string
    AccessGroupQueryOnlyAcl string
    AccessGroupServeAcl string
    AccessGroupServeOnlyAcl string
    Authenticate bool
    Authenticate time sources
    AuthenticationKeys List<Lbrlabs.PulumiPackage.Iosxe.Inputs.NtpAuthenticationKey>
    Authentication key for trusted time sources
    ClockPeriod int
    Length of hardware clock tick - Range: 0-4294967295
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Logging bool
    Enable NTP message logging
    Master bool
    Act as NTP master clock
    MasterStratum int
    • Range: 1-15
    Passive bool
    NTP passive mode
    PeerVrfs List<Lbrlabs.PulumiPackage.Iosxe.Inputs.NtpPeerVrf>
    VPN Routing/Forwarding Information
    Peers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.NtpPeer>
    ServerVrfs List<Lbrlabs.PulumiPackage.Iosxe.Inputs.NtpServerVrf>
    VPN Routing/Forwarding Information
    Servers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.NtpServer>
    TrapSourceFortyGigabitEthernet string
    Forty GigabitEthernet
    TrapSourceGigabitEthernet string
    GigabitEthernet IEEE 802.3z
    TrapSourceHundredGigE string
    Hundred GigabitEthernet
    TrapSourceLoopback int
    Loopback interface - Range: 0-2147483647
    TrapSourcePortChannel int
    Ethernet Channel of interfaces - Range: 0-4294967295
    TrapSourcePortChannelSubinterface string
    TrapSourceTenGigabitEthernet string
    Ten Gigabit Ethernet
    TrapSourceVlan int
    Iosxr Vlans - Range: 0-65535
    UpdateCalendar bool
    Periodically update calendar with NTP time
    AccessGroupPeerAcl string
    AccessGroupQueryOnlyAcl string
    AccessGroupServeAcl string
    AccessGroupServeOnlyAcl string
    Authenticate bool
    Authenticate time sources
    AuthenticationKeys []NtpAuthenticationKeyArgs
    Authentication key for trusted time sources
    ClockPeriod int
    Length of hardware clock tick - Range: 0-4294967295
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Logging bool
    Enable NTP message logging
    Master bool
    Act as NTP master clock
    MasterStratum int
    • Range: 1-15
    Passive bool
    NTP passive mode
    PeerVrfs []NtpPeerVrfArgs
    VPN Routing/Forwarding Information
    Peers []NtpPeerArgs
    ServerVrfs []NtpServerVrfArgs
    VPN Routing/Forwarding Information
    Servers []NtpServerArgs
    TrapSourceFortyGigabitEthernet string
    Forty GigabitEthernet
    TrapSourceGigabitEthernet string
    GigabitEthernet IEEE 802.3z
    TrapSourceHundredGigE string
    Hundred GigabitEthernet
    TrapSourceLoopback int
    Loopback interface - Range: 0-2147483647
    TrapSourcePortChannel int
    Ethernet Channel of interfaces - Range: 0-4294967295
    TrapSourcePortChannelSubinterface string
    TrapSourceTenGigabitEthernet string
    Ten Gigabit Ethernet
    TrapSourceVlan int
    Iosxr Vlans - Range: 0-65535
    UpdateCalendar bool
    Periodically update calendar with NTP time
    accessGroupPeerAcl String
    accessGroupQueryOnlyAcl String
    accessGroupServeAcl String
    accessGroupServeOnlyAcl String
    authenticate Boolean
    Authenticate time sources
    authenticationKeys List<NtpAuthenticationKey>
    Authentication key for trusted time sources
    clockPeriod Integer
    Length of hardware clock tick - Range: 0-4294967295
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    logging Boolean
    Enable NTP message logging
    master Boolean
    Act as NTP master clock
    masterStratum Integer
    • Range: 1-15
    passive Boolean
    NTP passive mode
    peerVrfs List<NtpPeerVrf>
    VPN Routing/Forwarding Information
    peers List<NtpPeer>
    serverVrfs List<NtpServerVrf>
    VPN Routing/Forwarding Information
    servers List<NtpServer>
    trapSourceFortyGigabitEthernet String
    Forty GigabitEthernet
    trapSourceGigabitEthernet String
    GigabitEthernet IEEE 802.3z
    trapSourceHundredGigE String
    Hundred GigabitEthernet
    trapSourceLoopback Integer
    Loopback interface - Range: 0-2147483647
    trapSourcePortChannel Integer
    Ethernet Channel of interfaces - Range: 0-4294967295
    trapSourcePortChannelSubinterface String
    trapSourceTenGigabitEthernet String
    Ten Gigabit Ethernet
    trapSourceVlan Integer
    Iosxr Vlans - Range: 0-65535
    updateCalendar Boolean
    Periodically update calendar with NTP time
    accessGroupPeerAcl string
    accessGroupQueryOnlyAcl string
    accessGroupServeAcl string
    accessGroupServeOnlyAcl string
    authenticate boolean
    Authenticate time sources
    authenticationKeys NtpAuthenticationKey[]
    Authentication key for trusted time sources
    clockPeriod number
    Length of hardware clock tick - Range: 0-4294967295
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    logging boolean
    Enable NTP message logging
    master boolean
    Act as NTP master clock
    masterStratum number
    • Range: 1-15
    passive boolean
    NTP passive mode
    peerVrfs NtpPeerVrf[]
    VPN Routing/Forwarding Information
    peers NtpPeer[]
    serverVrfs NtpServerVrf[]
    VPN Routing/Forwarding Information
    servers NtpServer[]
    trapSourceFortyGigabitEthernet string
    Forty GigabitEthernet
    trapSourceGigabitEthernet string
    GigabitEthernet IEEE 802.3z
    trapSourceHundredGigE string
    Hundred GigabitEthernet
    trapSourceLoopback number
    Loopback interface - Range: 0-2147483647
    trapSourcePortChannel number
    Ethernet Channel of interfaces - Range: 0-4294967295
    trapSourcePortChannelSubinterface string
    trapSourceTenGigabitEthernet string
    Ten Gigabit Ethernet
    trapSourceVlan number
    Iosxr Vlans - Range: 0-65535
    updateCalendar boolean
    Periodically update calendar with NTP time
    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[NtpAuthenticationKeyArgs]
    Authentication key for trusted time sources
    clock_period int
    Length of hardware clock tick - Range: 0-4294967295
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    logging bool
    Enable NTP message logging
    master bool
    Act as NTP master clock
    master_stratum int
    • Range: 1-15
    passive bool
    NTP passive mode
    peer_vrfs Sequence[NtpPeerVrfArgs]
    VPN Routing/Forwarding Information
    peers Sequence[NtpPeerArgs]
    server_vrfs Sequence[NtpServerVrfArgs]
    VPN Routing/Forwarding Information
    servers Sequence[NtpServerArgs]
    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 - Range: 0-2147483647
    trap_source_port_channel int
    Ethernet Channel of interfaces - Range: 0-4294967295
    trap_source_port_channel_subinterface str
    trap_source_ten_gigabit_ethernet str
    Ten Gigabit Ethernet
    trap_source_vlan int
    Iosxr Vlans - Range: 0-65535
    update_calendar bool
    Periodically update calendar with NTP time
    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 - Range: 0-4294967295
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    logging Boolean
    Enable NTP message logging
    master Boolean
    Act as NTP master clock
    masterStratum Number
    • Range: 1-15
    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 - Range: 0-2147483647
    trapSourcePortChannel Number
    Ethernet Channel of interfaces - Range: 0-4294967295
    trapSourcePortChannelSubinterface String
    trapSourceTenGigabitEthernet String
    Ten Gigabit Ethernet
    trapSourceVlan Number
    Iosxr Vlans - Range: 0-65535
    updateCalendar Boolean
    Periodically update calendar with NTP 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,
            access_group_peer_acl: Optional[str] = None,
            access_group_query_only_acl: Optional[str] = None,
            access_group_serve_acl: Optional[str] = None,
            access_group_serve_only_acl: Optional[str] = None,
            authenticate: Optional[bool] = None,
            authentication_keys: Optional[Sequence[NtpAuthenticationKeyArgs]] = None,
            clock_period: Optional[int] = None,
            delete_mode: Optional[str] = None,
            device: Optional[str] = None,
            logging: Optional[bool] = None,
            master: Optional[bool] = None,
            master_stratum: Optional[int] = None,
            passive: Optional[bool] = None,
            peer_vrfs: Optional[Sequence[NtpPeerVrfArgs]] = None,
            peers: Optional[Sequence[NtpPeerArgs]] = None,
            server_vrfs: Optional[Sequence[NtpServerVrfArgs]] = None,
            servers: Optional[Sequence[NtpServerArgs]] = None,
            trap_source_forty_gigabit_ethernet: Optional[str] = None,
            trap_source_gigabit_ethernet: Optional[str] = None,
            trap_source_hundred_gig_e: Optional[str] = None,
            trap_source_loopback: Optional[int] = None,
            trap_source_port_channel: Optional[int] = None,
            trap_source_port_channel_subinterface: Optional[str] = None,
            trap_source_ten_gigabit_ethernet: Optional[str] = None,
            trap_source_vlan: Optional[int] = None,
            update_calendar: Optional[bool] = 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:
    AccessGroupPeerAcl string
    AccessGroupQueryOnlyAcl string
    AccessGroupServeAcl string
    AccessGroupServeOnlyAcl string
    Authenticate bool
    Authenticate time sources
    AuthenticationKeys List<Lbrlabs.PulumiPackage.Iosxe.Inputs.NtpAuthenticationKey>
    Authentication key for trusted time sources
    ClockPeriod int
    Length of hardware clock tick - Range: 0-4294967295
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Logging bool
    Enable NTP message logging
    Master bool
    Act as NTP master clock
    MasterStratum int
    • Range: 1-15
    Passive bool
    NTP passive mode
    PeerVrfs List<Lbrlabs.PulumiPackage.Iosxe.Inputs.NtpPeerVrf>
    VPN Routing/Forwarding Information
    Peers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.NtpPeer>
    ServerVrfs List<Lbrlabs.PulumiPackage.Iosxe.Inputs.NtpServerVrf>
    VPN Routing/Forwarding Information
    Servers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.NtpServer>
    TrapSourceFortyGigabitEthernet string
    Forty GigabitEthernet
    TrapSourceGigabitEthernet string
    GigabitEthernet IEEE 802.3z
    TrapSourceHundredGigE string
    Hundred GigabitEthernet
    TrapSourceLoopback int
    Loopback interface - Range: 0-2147483647
    TrapSourcePortChannel int
    Ethernet Channel of interfaces - Range: 0-4294967295
    TrapSourcePortChannelSubinterface string
    TrapSourceTenGigabitEthernet string
    Ten Gigabit Ethernet
    TrapSourceVlan int
    Iosxr Vlans - Range: 0-65535
    UpdateCalendar bool
    Periodically update calendar with NTP time
    AccessGroupPeerAcl string
    AccessGroupQueryOnlyAcl string
    AccessGroupServeAcl string
    AccessGroupServeOnlyAcl string
    Authenticate bool
    Authenticate time sources
    AuthenticationKeys []NtpAuthenticationKeyArgs
    Authentication key for trusted time sources
    ClockPeriod int
    Length of hardware clock tick - Range: 0-4294967295
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    Logging bool
    Enable NTP message logging
    Master bool
    Act as NTP master clock
    MasterStratum int
    • Range: 1-15
    Passive bool
    NTP passive mode
    PeerVrfs []NtpPeerVrfArgs
    VPN Routing/Forwarding Information
    Peers []NtpPeerArgs
    ServerVrfs []NtpServerVrfArgs
    VPN Routing/Forwarding Information
    Servers []NtpServerArgs
    TrapSourceFortyGigabitEthernet string
    Forty GigabitEthernet
    TrapSourceGigabitEthernet string
    GigabitEthernet IEEE 802.3z
    TrapSourceHundredGigE string
    Hundred GigabitEthernet
    TrapSourceLoopback int
    Loopback interface - Range: 0-2147483647
    TrapSourcePortChannel int
    Ethernet Channel of interfaces - Range: 0-4294967295
    TrapSourcePortChannelSubinterface string
    TrapSourceTenGigabitEthernet string
    Ten Gigabit Ethernet
    TrapSourceVlan int
    Iosxr Vlans - Range: 0-65535
    UpdateCalendar bool
    Periodically update calendar with NTP time
    accessGroupPeerAcl String
    accessGroupQueryOnlyAcl String
    accessGroupServeAcl String
    accessGroupServeOnlyAcl String
    authenticate Boolean
    Authenticate time sources
    authenticationKeys List<NtpAuthenticationKey>
    Authentication key for trusted time sources
    clockPeriod Integer
    Length of hardware clock tick - Range: 0-4294967295
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    logging Boolean
    Enable NTP message logging
    master Boolean
    Act as NTP master clock
    masterStratum Integer
    • Range: 1-15
    passive Boolean
    NTP passive mode
    peerVrfs List<NtpPeerVrf>
    VPN Routing/Forwarding Information
    peers List<NtpPeer>
    serverVrfs List<NtpServerVrf>
    VPN Routing/Forwarding Information
    servers List<NtpServer>
    trapSourceFortyGigabitEthernet String
    Forty GigabitEthernet
    trapSourceGigabitEthernet String
    GigabitEthernet IEEE 802.3z
    trapSourceHundredGigE String
    Hundred GigabitEthernet
    trapSourceLoopback Integer
    Loopback interface - Range: 0-2147483647
    trapSourcePortChannel Integer
    Ethernet Channel of interfaces - Range: 0-4294967295
    trapSourcePortChannelSubinterface String
    trapSourceTenGigabitEthernet String
    Ten Gigabit Ethernet
    trapSourceVlan Integer
    Iosxr Vlans - Range: 0-65535
    updateCalendar Boolean
    Periodically update calendar with NTP time
    accessGroupPeerAcl string
    accessGroupQueryOnlyAcl string
    accessGroupServeAcl string
    accessGroupServeOnlyAcl string
    authenticate boolean
    Authenticate time sources
    authenticationKeys NtpAuthenticationKey[]
    Authentication key for trusted time sources
    clockPeriod number
    Length of hardware clock tick - Range: 0-4294967295
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    logging boolean
    Enable NTP message logging
    master boolean
    Act as NTP master clock
    masterStratum number
    • Range: 1-15
    passive boolean
    NTP passive mode
    peerVrfs NtpPeerVrf[]
    VPN Routing/Forwarding Information
    peers NtpPeer[]
    serverVrfs NtpServerVrf[]
    VPN Routing/Forwarding Information
    servers NtpServer[]
    trapSourceFortyGigabitEthernet string
    Forty GigabitEthernet
    trapSourceGigabitEthernet string
    GigabitEthernet IEEE 802.3z
    trapSourceHundredGigE string
    Hundred GigabitEthernet
    trapSourceLoopback number
    Loopback interface - Range: 0-2147483647
    trapSourcePortChannel number
    Ethernet Channel of interfaces - Range: 0-4294967295
    trapSourcePortChannelSubinterface string
    trapSourceTenGigabitEthernet string
    Ten Gigabit Ethernet
    trapSourceVlan number
    Iosxr Vlans - Range: 0-65535
    updateCalendar boolean
    Periodically update calendar with NTP time
    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[NtpAuthenticationKeyArgs]
    Authentication key for trusted time sources
    clock_period int
    Length of hardware clock tick - Range: 0-4294967295
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    logging bool
    Enable NTP message logging
    master bool
    Act as NTP master clock
    master_stratum int
    • Range: 1-15
    passive bool
    NTP passive mode
    peer_vrfs Sequence[NtpPeerVrfArgs]
    VPN Routing/Forwarding Information
    peers Sequence[NtpPeerArgs]
    server_vrfs Sequence[NtpServerVrfArgs]
    VPN Routing/Forwarding Information
    servers Sequence[NtpServerArgs]
    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 - Range: 0-2147483647
    trap_source_port_channel int
    Ethernet Channel of interfaces - Range: 0-4294967295
    trap_source_port_channel_subinterface str
    trap_source_ten_gigabit_ethernet str
    Ten Gigabit Ethernet
    trap_source_vlan int
    Iosxr Vlans - Range: 0-65535
    update_calendar bool
    Periodically update calendar with NTP time
    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 - Range: 0-4294967295
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    logging Boolean
    Enable NTP message logging
    master Boolean
    Act as NTP master clock
    masterStratum Number
    • Range: 1-15
    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 - Range: 0-2147483647
    trapSourcePortChannel Number
    Ethernet Channel of interfaces - Range: 0-4294967295
    trapSourcePortChannelSubinterface String
    trapSourceTenGigabitEthernet String
    Ten Gigabit Ethernet
    trapSourceVlan Number
    Iosxr Vlans - Range: 0-65535
    updateCalendar Boolean
    Periodically update calendar with NTP time

    Supporting Types

    NtpAuthenticationKey, NtpAuthenticationKeyArgs

    Number int
    CmacAes128 string
    EncryptionType int
    HmacSha1 string
    HmacSha2256 string
    Md5 string
    Sha1 string
    Sha2 string
    Number int
    CmacAes128 string
    EncryptionType int
    HmacSha1 string
    HmacSha2256 string
    Md5 string
    Sha1 string
    Sha2 string
    number Integer
    cmacAes128 String
    encryptionType Integer
    hmacSha1 String
    hmacSha2256 String
    md5 String
    sha1 String
    sha2 String
    number number
    cmacAes128 string
    encryptionType number
    hmacSha1 string
    hmacSha2256 string
    md5 string
    sha1 string
    sha2 string
    number Number
    cmacAes128 String
    encryptionType Number
    hmacSha1 String
    hmacSha2256 String
    md5 String
    sha1 String
    sha2 String

    NtpPeer, NtpPeerArgs

    IpAddress string
    Key int
    Prefer bool
    Source string
    Version int
    IpAddress string
    Key int
    Prefer bool
    Source string
    Version int
    ipAddress String
    key Integer
    prefer Boolean
    source String
    version Integer
    ipAddress string
    key number
    prefer boolean
    source string
    version number
    ipAddress String
    key Number
    prefer Boolean
    source String
    version Number

    NtpPeerVrf, NtpPeerVrfArgs

    NtpPeerVrfPeer, NtpPeerVrfPeerArgs

    IpAddress string
    Key int
    Prefer bool
    Version int
    IpAddress string
    Key int
    Prefer bool
    Version int
    ipAddress String
    key Integer
    prefer Boolean
    version Integer
    ipAddress string
    key number
    prefer boolean
    version number
    ipAddress String
    key Number
    prefer Boolean
    version Number

    NtpServer, NtpServerArgs

    IpAddress string
    Key int
    Prefer bool
    Source string
    Version int
    IpAddress string
    Key int
    Prefer bool
    Source string
    Version int
    ipAddress String
    key Integer
    prefer Boolean
    source String
    version Integer
    ipAddress string
    key number
    prefer boolean
    source string
    version number
    ipAddress String
    key Number
    prefer Boolean
    source String
    version Number

    NtpServerVrf, NtpServerVrfArgs

    NtpServerVrfServer, NtpServerVrfServerArgs

    IpAddress string
    Key int
    Prefer bool
    Version int
    IpAddress string
    Key int
    Prefer bool
    Version int
    ipAddress String
    key Integer
    prefer Boolean
    version Integer
    ipAddress string
    key number
    prefer boolean
    version number
    ipAddress String
    key Number
    prefer Boolean
    version Number

    Import

     $ pulumi import iosxe:index/ntp:Ntp example "Cisco-IOS-XE-native:native/ntp"
    

    To learn more about importing existing cloud resources, see Importing resources.

    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