Junos® OS Junos XML API Operational Reference

7366 Pages·2016·36.75 MB·English

by  Juniper Networks

Junos OS
Junos XML API Operational Developer
Reference
Release
Published
20.4R1
2020-12-20
ii
JuniperNetworks,Inc.
1194NorthMathildaAvenue
Sunnyvale,California94089
USA
408-745-2000
www.juniper.net
JuniperNetworks,theJuniperNetworkslogo,Juniper,andJunosareregisteredtrademarksofJuniperNetworks,Inc.in
theUnitedStatesandothercountries.Allothertrademarks,servicemarks,registeredmarks,orregisteredservicemarks
arethepropertyoftheirrespectiveowners.
JuniperNetworksassumesnoresponsibilityforanyinaccuraciesinthisdocument.JuniperNetworksreservestheright
tochange,modify,transfer,orotherwiserevisethispublicationwithoutnotice.
®
Junos OSJunosXMLAPIOperationalDeveloperReference
Copyright©2019JuniperNetworks,Inc.Allrightsreserved.
RevisionHistory
December2020—R1Junos20.4
Theinformationinthisdocumentiscurrentasofthedateonthetitlepage.
YEAR2000NOTICE
JuniperNetworkshardwareandsoftwareproductsareYear2000compliant.JunosOShasnoknowntime-related
limitationsthroughtheyear2038.However,theNTPapplicationisknowntohavesomedifficultyintheyear2036.
ENDUSERLICENSEAGREEMENT
TheJuniperNetworksproductthatisthesubjectofthistechnicaldocumentationconsistsof(orisintendedforusewith)
JuniperNetworkssoftware.UseofsuchsoftwareissubjecttothetermsandconditionsoftheEndUserLicenseAgreement
(“EULA”)postedathttps://support.juniper.net/support/eula/.Bydownloading,installingorusingsuchsoftware,you
agreetothetermsandconditionsofthatEULA.
iii
Table of Contents
AboutThisGuide | dcccxxv
JunosOSDocumentationandReleaseNotes | dcccxxv
Objectives | dcccxxvi
Audience | dcccxxvi
SupportedPlatforms | dcccxxvii
UsingtheExamplesinThisManual | dcccxxvii
MergingaFullExample | dcccxxvii
MergingaSnippet | dcccxxviii
DocumentationConventions | dcccxxix
DocumentationFeedback | dcccxxxi
RequestingTechnicalSupport | dcccxxxii
Self-HelpOnlineToolsandResources | dcccxxxii
CreatingaServiceRequestwithJTAC | dcccxxxiii
MappingBetweenOperationalTagElements,PerlMethods,andCLI
1
Commands
MappingBetweenOperationalTagElements,PerlMethods,andCLICommandsfor
ACXSeries,MXSeries,andPTXSeries | 2
MappingBetweenOperationalTagElements,PerlMethods,andCLICommandsforEX
SeriesandQFXSeries | 399
MappingBetweenOperationalTagElements,PerlMethods,andCLICommandsfor
SRXSeries | 416
2 SummaryofOperationalRequestTagElements
OperationalRequestTagElementsApplicabletoAllPlatforms | 452
<clear-arp-inspection-statistics> | 452
<clear-dhcp-binding-information> | 452
<clear-dhcp-conflict-information> | 453
<clear-dhcp-snooping> | 453
<clear-dhcp-snooping-statistics> | 453
iv
<clear-dhcp-statistics-information> | 454
<clear-ethernet-ring-information> | 454
<clear-ethernet-ring-statistics> | 454
<clear-fip-snooping-enode> | 455
<clear-fip-snooping-statistics> | 455
<clear-fip-snooping-vlan> | 456
<clear-fip-snooping-vlandiscovery-statistics> | 456
<clear-lldp-neighbors> | 457
<clear-lldp-statistics> | 457
<clear-mka-interface-statistics> | 457
<clear-mka-statistics> | 458
<clear-protection-group-information> | 458
<get-arp-inspection-statistics> | 459
<get-authentication-whitelist-mac-bypassed-users> | 459
<get-autoinstallation-status-information> | 459
<get-dcbx-information> | 459
<get-dcbx-neighbor-information> | 460
<clear-protection-group-information> | 460
<get-arp-inspection-statistics> | 461
<get-authentication-whitelist-mac-bypassed-users> | 461
<get-autoinstallation-status-information> | 461
<get-dcbx-information> | 462
<get-dcbx-neighbor-information> | 462
<get-dcbx-neighbor-information-terse> | 462
<get-dcbx-neighbor-interface-information> | 463
<get-dhcp-binding-information> | 463
<get-dhcp-conflict-information> | 464
<get-dhcp-global-information> | 464
<get-dhcp-pool-information> | 464
<get-dhcp-snoop-binding> | 465
<get-dhcp-snooping-statistics> | 465
<get-dhcp-statistics-information> | 465
<get-ethernet-switching-authentication-whitelist-mac> | 466
<get-ethernet-switching-interface-mac-addresses> | 466
v
<get-fip-snooping> | 467
<get-fip-snooping-enode> | 467
<get-fip-snooping-fcf> | 468
<get-fip-snooping-interface-information> | 468
<get-fip-snooping-statistics> | 469
<get-fip-snooping-vlan> | 469
<get-fip-snooping-vlandiscovery-enodes> | 470
<get-fip-snooping-vlandiscovery-statistics> | 470
<get-ip-source-guard-information> | 471
<get-lldp-information> | 471
<get-lldp-information-detail> | 471
<get-lldp-local-info> | 472
<get-lldp-remote-global-statistics> | 472
<get-lldp-statistics-information> | 472
<get-macsec-connection-information> | 473
<get-macsec-connection-interface-information> | 473
<get-macsec-interface-statistics> | 474
<get-macsec-statistics> | 474
<get-mka-interface-statistics> | 475
<get-mka-session-information> | 475
<get-mka-session-interface-information> | 475
<get-mka-statistics> | 476
<get-macsec-connection-information> | 476
<get-macsec-connection-interface-information> | 477
<get-macsec-interface-statistics> | 477
<get-macsec-statistics> | 478
<get-mka-interface-statistics> | 478
<get-mka-session-information> | 478
<get-mka-session-interface-information> | 479
<get-mka-statistics> | 479
<get-raps-pdu-information> | 480
<get-raps-state-machine-information> | 480
<get-ring-data-channel-information> | 481
<get-ring-flush-information> | 481
vi
<get-ring-interface-information> | 482
<get-ring-vlan-information> | 482
<get-rtg-information> | 483
<get-rtg-information-pergrp> | 483
<load-dhcp-snooping> | 484
<get-ring-data-channel-information> | 484
<get-ring-flush-information> | 485
<get-ring-interface-information> | 485
<get-ring-vlan-information> | 486
<get-rtg-information> | 486
<get-rtg-information-pergrp> | 487
<load-dhcp-snooping> | 487
<save-dhcp-snooping> | 487
OperationalRequestTagElementsCommontoEXSeries,MXSeries,PTXSeries,and
QFXSeries | 489
<clear-all-firewall-conters> | 489
<clear-all-firewall-policer-counter-statistics> | 489
<clear-firewall-counters> | 490
<clear-firewall-log> | 490
<clear-firewall-policer-counter-statistics> | 491
<clear-ike-security-associations> | 491
<clear-ike-statistics> | 492
<clear-ipsec-certificates-service-set> | 492
<clear-ipsec-security-associations> | 493
<clear-ipsec-vpn-statistics> | 493
<clear-services-ike-security-associations> | 494
<clear-firewall-counters> | 494
<clear-firewall-log> | 495
<clear-firewall-policer-counter-statistics> | 495
<clear-ike-security-associations> | 496
<clear-ike-statistics> | 496
<clear-ipsec-certificates-service-set> | 497
<clear-ipsec-security-associations> | 497
vii
<clear-ipsec-vpn-statistics> | 498
<clear-services-ike-security-associations> | 498
<clear-services-ike-statistics> | 499
<clear-services-ipsec-vpn-security-associations> | 499
<get-certificates-information> | 500
<get-crl-information> | 501
<get-filter-version> | 501
<clear-ipsec-security-associations> | 502
<clear-ipsec-vpn-statistics> | 502
<clear-services-ike-security-associations> | 502
<clear-services-ike-statistics> | 503
<clear-services-ipsec-vpn-security-associations> | 504
<get-certificates-information> | 504
<get-crl-information> | 505
<get-filter-version> | 505
<get-fips-pic-status-information> | 506
<get-firewall-counter-information> | 506
<get-firewall-filter-information> | 507
<get-firewall-filter-regex-information> | 508
<get-firewall-information> | 509
<get-firewall-log-information> | 510
<get-firewall-policer-counter-information> | 510
<get-firewall-policer-per-counter-information> | 511
<get-firewall-prefix-action-information> | 511
<get-firewall-templates-reference-counts> | 512
<get-ike-security-associations-information> | 512
<get-ike-services-security-associations-information> | 513
<get-ike-services-statistics> | 514
<get-ipsec-pic-redundancy-information> | 514
<get-ipsec-tunnel-redundancy-information> | 514
<get-policer-information> | 515
<get-ike-security-associations-information> | 515
<get-ike-services-security-associations-information> | 516
<get-ike-services-statistics> | 517
viii
<get-ipsec-pic-redundancy-information> | 517
<get-ipsec-tunnel-redundancy-information> | 517
<get-policer-information> | 518
<get-security-associations-information> | 518
<get-services-ipsec-statistics-information> | 519
<get-services-security-associations-information> | 520
OperationalRequestTagElementsCommontoEXSeriesandSRXSeries | 521
<clear-edge-virtual-bridging> | 521
<clear-edge-virtual-bridging-ecp-statistics> | 521
<clear-edge-virtual-bridging-firewall-information> | 522
<clear-edge-virtual-bridging-firewall-interface> | 522
<clear-edge-virtual-bridging-vsi-profiles> | 523
<clear-edge-virtual-bridging-vsi-profiles-interface> | 523
<clear-ethernet-switching-bpdu-error> | 524
<clear-ethernet-switching-mac-learning-log> | 524
<clear-ethernet-switching-mac-learning-statistics> | 524
<clear-ethernet-switching-port-error> | 525
<clear-ethernet-switching-statistics-aging> | 525
<clear-ethernet-switching-table> | 525
<clear-ethernet-switching-table-management-vlan> | 526
<clear-ethernet-switching-table-persistent-mac> | 526
<clear-gvrp-statistics> | 527
<clear-igmp-snooping> | 527
<clear-igmp-snooping-membership> | 528
<clear-igmp-snooping-statistics> | 528
<clear-l2pt-error> | 528
<clear-l2pt-interface-statistics> | 529
<clear-ethernet-switching-port-error> | 529
<clear-ethernet-switching-statistics-aging> | 529
<clear-ethernet-switching-table> | 530
<clear-ethernet-switching-table-management-vlan> | 530
<clear-ethernet-switching-table-persistent-mac> | 531
<clear-gvrp-statistics> | 531
ix
<clear-igmp-snooping> | 531
<clear-igmp-snooping-membership> | 532
<clear-igmp-snooping-statistics> | 532
<clear-l2pt-error> | 533
<clear-l2pt-interface-statistics> | 533
<clear-l2pt-statistics> | 533
<clear-l2pt-vlan-statistics> | 534
<clear-lldp-interface-neighbors> | 534
<clear-lldp-interface-statistics> | 535
<clear-mld-snooping> | 535
<clear-mld-snooping-membership> | 535
<clear-mld-snooping-statistics> | 536
<clear-multicast-route-counter> | 536
<clear-mvrp-statistics> | 536
<clear-mvrp-statistics-interface> | 537
<clear-stp-statistics-interface> | 537
<get-analyzer-information> | 538
<get-dhcp-client-information> | 538
<get-dhcp-helper-statistics> | 539
<get-download-information> | 539
<get-edge-virtual-bridging-ecp-interface-statistics> | 539
<get-edge-virtual-bridging-ecp-statistics> | 540
<get-edge-virtual-bridging-firewall-information> | 540
<get-edge-virtual-bridging-information> | 540
<get-edge-virtual-bridging-interface-firewall-information> | 541
<get-edge-virtual-bridging-interface-information> | 542
<get-edge-virtual-bridging-vsi-interface-profiles> | 542
<get-edge-virtual-bridging-vsi-profiles> | 543
<get-erp-statistics-interface-information> | 543
<get-ethernet-switching-aging-statistics> | 544
<get-ethernet-switching-interface-information> | 544
<get-ethernet-switching-log-information> | 545
<get-ethernet-switching-mac-learning-statistics> | 545
<get-ethernet-switching-mac-notification-information> | 545
x
<get-ethernet-switching-next-hop-information> | 546
<get-ethernet-switching-persistent-information> | 546
<get-ethernet-switching-table-information> | 547
<get-gvrp-information> | 548
<get-gvrp-statistics> | 548
<get-gvrp-timers> | 549
<get-igmp-snooping-flow-information> | 549
<get-igmp-snooping-membership-information> | 550
<get-igmp-snooping-routing-information> | 550
<get-igmp-snooping-statistics-information> | 551
<get-igmp-snooping-task-accounting> | 551
<get-igmp-snooping-task-information> | 552
<get-igmp-snooping-task-io> | 552
<get-igmp-snooping-task-jobs> | 553
<get-igmp-snooping-task-memory> | 553
<get-igmp-snooping-task-statistics> | 554
<get-igmp-snooping-task-timers> | 554
<get-igmp-snooping-vlan-information> | 554
<get-interface-ethernet-switching-table> | 555
<get-l2pt-interface-information> | 555
<get-l2pt-interface-statistics> | 556
<get-l2pt-statistics> | 556
<get-l2pt-vlan-information> | 557
<get-l2pt-vlan-statistics> | 557
<get-lldp-interface-neighbors-information> | 557
<get-lldp-interface-statistics> | 558
<get-lldp-neighbors-information> | 558
<get-management-vlan-ethernet-switching-table> | 559
<get-management-vlan-information> | 559
<get-mld-snooping-membership-information> | 560
<get-mld-snooping-routing-information> | 560
<get-mld-snooping-statistics> | 561
<get-mld-snooping-vlan-information> | 561
<get-mstp-bridge-configuration-information> | 562