0% found this document useful (0 votes)
145 views

B Command Reference 2 0 PDF

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
145 views

B Command Reference 2 0 PDF

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 1798

Cisco UCS Manager CLI Command Reference, Release 2.

0
First Published: September 06, 2011
Last Modified: June 20, 2012

Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883

Text Part Number: OL-25718-02


THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version
of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://
www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)

Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown
for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.

© 2012 Cisco Systems, Inc. All rights reserved.


CONTENTS

Preface Preface xlvii


Audience xlvii
Organization xlvii
Conventions xlviii
Related Cisco UCS Documentation xlix
Documentation Feedback l
Obtaining Documentation and Submitting a Service Request l

CHAPTER 1 Overview of Cisco Unified Computing System 1


About Cisco Unified Computing System 1
Unified Fabric 2
Fibre Channel over Ethernet 3
Link-Level Flow Control 3
Priority Flow Control 3
Server Architecture and Connectivity 4
Overview of Service Profiles 4
Network Connectivity through Service Profiles 4
Configuration through Service Profiles 4
Service Profiles that Override Server Identity 5
Service Profiles that Inherit Server Identity 6
Service Profile Templates 7
Policies 7
Configuration Policies 7
Boot Policy 7
Chassis Discovery Policy 8
Dynamic vNIC Connection Policy 11
Ethernet and Fibre Channel Adapter Policies 11

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 iii
Contents

Global Cap Policy 12


Host Firmware Package 13
IPMI Access Profile 13
Local Disk Configuration Policy 14
Management Firmware Package 14
Management Interfaces Monitoring Policy 15
Network Control Policy 15
Power Control Policy 16
Power Policy 17
Quality of Service Policy 17
Rack Server Discovery Policy 17
Server Autoconfiguration Policy 17
Server Discovery Policy 17
Server Inheritance Policy 18
Server Pool Policy 18
Server Pool Policy Qualifications 18
vHBA Template 19
VM Lifecycle Policy 19
vNIC Template 19
vNIC/vHBA Placement Policies 20
Operational Policies 20
Fault Collection Policy 20
Flow Control Policy 21
Maintenance Policy 21
Scrub Policy 21
Serial over LAN Policy 22
Statistics Collection Policy 22
Statistics Threshold Policy 22
Pools 23
Server Pools 23
MAC Pools 24
UUID Suffix Pools 24
WWN Pools 24
Management IP Pool 25
Traffic Management 25

Cisco UCS Manager CLI Command Reference, Release 2.0


iv OL-25718-02
Contents

Oversubscription 25
Oversubscription Considerations 25
Guidelines for Estimating Oversubscription 26
Pinning 27
Pinning Server Traffic to Server Ports 27
Guidelines for Pinning 29
Quality of Service 29
System Classes 29
Quality of Service Policy 30
Flow Control Policy 30
Opt-In Features 30
Stateless Computing 31
Multi-Tenancy 32
Virtualization in Cisco UCS 33
Overview of Virtualization 33
Overview of Cisco Virtual Machine Fabric Extender 33
Virtualization with Network Interface Cards and Converged Network Adapters 33
Virtualization with a Virtual Interface Card Adapter 34

CHAPTER 2 Overview of Cisco UCS Manager 35


About Cisco UCS Manager 35
Tasks You Can Perform in Cisco UCS Manager 36
Tasks You Cannot Perform in Cisco UCS Manager 38
Cisco UCS Manager in a High Availability Environment 38

CHAPTER 3 Overview of Cisco UCS Manager CLI 39


Managed Objects 39
Command Modes 39
Object Commands 41
Complete a Command 42
Command History 42
Committing, Discarding, and Viewing Pending Commands 43
Online Help for the CLI 43
CLI Session Limits 43
Web Session Limits 43

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 v
Contents

Setting the Web Session Limit for Cisco UCS Manager from the CLI 44
Pre-Login Banner 44
Creating the Pre-Login Banner 45
Modifying the Pre-Login Banner 46
Deleting the Pre-Login Banner 47

CHAPTER 4 Commands 49
acknowledge chassis 92
acknowledge fex 93
acknowledge fault 94
acknowledge server 95
acknowledge slot 96
activate firmware 97
activate firmware (fabric) 99
activate internal firmware 101
add alertgroups 102
add backup action 104
add privilege 105
apply pending-changes immediate 108
associate server 109
associate server-pool 111
backup sel 112
cd 113
clear alertgroups 115
clear auth-server-group 116
clear backup action 117
clear cores 118
clear file 119
clear message 120
clear password-history 121
clear sel (/chassis/server) 122
clear sel (/chassis/server) 123
clear sshkey 124
cluster force primary 125
cluster lead 126

Cisco UCS Manager CLI Command Reference, Release 2.0


vi OL-25718-02
Contents

commit-buffer 128
connect adapter 129
connect bmc 130
connect clp 131
connect iom 132
connect local-mgmt 133
connect nxos 134
copy 135
create adapter 137
create auth-domain 138
create auth-profile 139
create auth-server-group 141
create auto-target-if 142
create backup 143
create bios-policy 145
create bladeserver-disc-policy 146
create block 147
create boot-definition 149
create boot-policy 150
create boot-target 151
create cap-qual 152
create certreq 154
create chassis 156
create class chassis-stats 157
create class cmc-stats 158
create class cpu-env-stats 159
create class dimm-env-stats 160
create class dimm-stats 161
create class env-stats 162
create class ether-error-stats 163
create class ether-if-stats 164
create class ether-loss-stats 165
create class ether-pause-stats 166
create class ethernet-port-err-stats 167
create class ethernet-port-multicast-stats 168

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 vii
Contents

create class ethernet-port-over-under-sized-stats 169


create class ethernet-port-stats 170
create class ethernet-port-stats-by-size-large-packets 171
create class ethernet-port-stats-by-size-small-packets 172
create class ether-rx-stats 173
create class ether-tx-stats 174
create class fan-module-stats 175
create class fan-stats 176
create class fc-error-stats 177
create class fc-if-event-stats 178
create class fc-if-fc4-counters 179
create class fc-if-frame-stats 180
create class fc-port-stats 181
create class fc-stats 182
create class fex-env-stats 183
create class fex-power-summary 184
create class fex-psu-input-stats 185
create class io-card-stats 186
create class mb-power-stats 187
create class mb-temp-stats 188
create class memory-array-env-stats 189
create class memory-runtime 190
create class menlo-dce-port-stats 191
create class menlo-eth-error-stats 192
create class menlo-eth-stats 193
create class menlo-fc-error-stats 194
create class menlo-fc-stats 195
create class menlo-host-port-stats 196
create class menlo-mcpu-error-stats 197
create class menlo-mcpu-stats 198
create class menlo-net-eg-stats 199
create class menlo-net-in-stats 200
create class menlo-q-error-stats 201
create class menlo-q-stats 202
create class motherboard-temp-stats 203

Cisco UCS Manager CLI Command Reference, Release 2.0


viii OL-25718-02
Contents

create class pcie-fatal-completion-error-stats 204


create class pcie-fatal-error-stats 205
create class pcie-fatal-protocol-error-stats 206
create class pcie-fatal-receiving-error-stats 207
create class processor-runtime 208
create class psu-input-stats 209
create class psu-stats 210
create class rack-unit-fan-stats 211
create class rack-unit-psu-stats 212
create class system-stats 213
create class vnic-stats 214
create client 215
create cluster 216
create cpu 217
create data-center 218
create default-auth 219
create default-behavior 220
create destination 221
create dest-interface 222
create dhcp-ip-params 223
create distributed-virtual-switch 224
create dns 225
create dynamic-vnic-conn 226
create dynamic-vnic-conn-policy 227
create egress-policy 228
create eth-if 229
create eth-if (vnic-iscsi) 230
create eth-mon-session 231
create eth-policy 232
create eth-target 233
create ext-static-ip 234
create fc-mon-session 235
create fcoe-if 236
create fc-policy 237
create folder 238

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 ix
Contents

create fw-host-pack 239


create fw-mgmt-pack 240
create hv-conn 241
create import-config 242
create initiator 244
create interface 245
create interface fc 247
create interface fcoe 248
create ip-if 249
create ipmi-access-profile 250
create ipmi-user 251
create iqn-pool 252
create iscsi-policy 254
create iscsi 255
create keyring 256
create lan 257
create ldap-group 258
create ldap-group-rule 259
create local 260
create local-disk-config 261
create local-disk-config-policy 262
create locale 263
create local-user 264
create lun 265
create mac-pool 266
create mac-security 267
create maint-policy 268
create member-port 269
create member-port fc 271
create member-port fcoe 273
create member-port (/port-channel) 274
create member-port-channel 276
create memory 278
create mon-src 279
create network (/eth-uplink/port-profile) 281

Cisco UCS Manager CLI Command Reference, Release 2.0


x OL-25718-02
Contents

create network (/profile-set/port-profile) 282


create ntp-server 283
create nw-ctrl-policy 284
create occurrence one-time 286
create occurrence recurring 287
create org 289
create org-ref 290
create pack-image 292
create path 294
create path (iscsi) 296
create physical-qual 297
create pin-group 298
create policy 299
create pooled-ip-params 301
create pooling-policy 302
create port-channel 303
create port-profile (/eth-uplink) 304
create port-profile (/profile-set) 305
create power-control-policy 306
create power-group 307
create processor 308
create profile 309
create qos-policy 310
create rack 311
create role 312
create san-image 313
create scheduler 314
create scrub-policy 315
create server 316
create server (/org/server-pool) 318
create server-autoconfig-policy 319
create server-disc-policy 320
create server-inherit-policy 321
create server-pool 322
create server-qual 323

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xi
Contents

create server-ref 324


create service-profile 325
create slot 326
create snmp-trap 327
create snmp-user 328
create sol-config 329
create sol-policy 330
create static-ip-params 331
create static-target-if 333
create stats-threshold-policy 334
create storage 335
create threshold-value 336
create trustpoint 338
create uuid-suffix-pool 339
create vcenter 340
create vcon 341
create vcon-policy 342
create vhba 343
create vhba-templ 345
create virtual-media 347
create vlan 348
create vlan (/port-profile) 350
create vnic 351
create vnic-egress-policy 353
create vnic-iscsi 354
create vnic-templ 355
create vsan 357
create wwn-pool 359
cycle 360
decommission chassis 361
decommission fex 362
decommission server 363
decommission server (chassis) 364
delete adapter 365
delete auth-domain 366

Cisco UCS Manager CLI Command Reference, Release 2.0


xii OL-25718-02
Contents

delete auth-profile 367


delete auth-server-group 368
delete auto-target-if 369
delete backup 370
delete bladeserver-disc-policy 371
delete block 372
delete boot-definition 374
delete boot-policy 375
delete boot-target 376
delete cap-qual 377
delete certreq 379
delete chassis 380
delete class chassis-stats 381
delete class cpu-env-stats 382
delete class dimm-env-stats 383
delete class dimm-stats 384
delete class env-stats 385
delete class ether-error-stats 386
delete class ether-if-stats 387
delete class ether-loss-stats 388
delete class ethernet-port-err-stats 389
delete class ethernet-port-multicast-stats 390
delete class ethernet-port-over-under-sized-stats 391
delete class ethernet-port-stats 392
delete class ethernet-port-stats-by-size-large-packets 393
delete class ethernet-port-stats-by-size-small-packets 394
delete class ether-pause-stats 395
delete class ether-rx-stats 396
delete class ether-tx-stats 397
delete class fan-module-stats 398
delete class fan-stats 399
delete class fc-error-stats 400
delete class fc-port-stats 401
delete class fc-stats 402
delete class fex-env-stats 403

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xiii
Contents

delete class fex-power-summary 404


delete class fex-psu-input-stats 405
delete class io-card-stats 406
delete class mb-power-stats 407
delete class mb-temp-stats 408
delete class memory-array-env-stats 409
delete class motherboard-temp-stats 410
delete class pcie-fatal-completion-error-stats 411
delete class pcie-fatal-error-stats 412
delete class pcie-fatal-protocol-error-stats 413
delete class pcie-fatal-receiving-error-stats 414
delete class psu-input-stats 415
delete class psu-stats 416
delete class rack-unit-fan-stats 417
delete class rack-unit-psu-stats 418
delete class system-stats 419
delete class vnic-stats 420
delete client 421
delete cluster 422
delete cpu 423
delete data-center 424
delete default-auth 425
delete default-behavior 426
delete destination 427
delete dest-interface 428
delete dhcp-ip-params 429
delete distributed-virtual-switch 430
delete dns 431
delete download-task 432
delete dynamic-vnic-conn 433
delete dynamic-vnic-conn-policy 434
delete egress-policy 435
delete eth-if 436
delete eth-mon-session 437
delete eth-policy 438

Cisco UCS Manager CLI Command Reference, Release 2.0


xiv OL-25718-02
Contents

delete eth-target 439


delete ext-static-ip 440
delete fc-mon-session 441
delete fc-policy 442
delete folder 443
delete fw-host-pack 444
delete fw-mgmt-pack 445
delete image 446
delete import-config 448
delete initiator 449
delete interface 450
delete interface fc 451
delete interface fcoe 452
delete ip-if 453
delete ipmi-access-profile 454
delete ipmi-user 455
delete iqn-pool 456
delete iscsi-policy 457
delete iscsi 458
delete keyring 459
delete lan 460
delete ldap-group 461
delete ldap-group-rule 462
delete local 463
delete locale 464
delete local-disk-config 465
delete local-disk-config-policy 466
delete local-user 467
delete lun 468
delete mac-pool 469
delete mac-security 470
delete maint-policy 471
delete member-port 472
delete member-port fc 474
delete member-port fcoe 476

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xv
Contents

delete member-port-channel 478


delete memory 480
delete mon-src 481
delete network 483
delete network (/profile-set/port-profile) 484
delete ntp-server 485
delete nw-ctrl-policy 486
delete occurrence one-time 487
delete occurrence recurring 488
delete org 489
delete org-ref 490
delete pack-image 491
delete path 493
delete path (iscsi) 494
delete pending-deletion 495
delete physical-qual 496
delete pin-group 497
delete policy 498
delete pooled-ip-params 500
delete pooling-policy 501
delete port-channel 502
delete port-profile (profile-set) 503
delete power-control-policy 504
delete power-group 505
delete processor 506
delete profile 507
delete qos-policy 508
delete rack 509
delete remote-user 510
delete role 511
delete san-image 512
delete scheduler 513
delete scrub-policy 514
delete server 515
delete server (/security) 517

Cisco UCS Manager CLI Command Reference, Release 2.0


xvi OL-25718-02
Contents

delete server-autoconfig-policy 518


delete server-disc-policy 519
delete server-inherit-policy 520
delete server-pool 521
delete server-qual 522
delete server-ref 523
delete service-profile 524
delete slot 525
delete snmp-trap 526
delete snmp-user 527
delete sol-config 528
delete sol-policy 529
delete static-ip-params 530
delete static-target-if 531
delete stats-threshold-policy 532
delete storage 533
delete target 534
delete threshold-value 535
delete trustpoint 537
delete user-sessions 538
delete user-sessions local 539
delete user-sessions remote 540
delete uuid-suffix-pool 541
delete vcenter 542
delete vcon 543
delete vcon-policy 544
delete vhba 545
delete vhba-templ 546
delete virtual-media 547
delete vlan 548
delete vlan-group-permit 549
delete vlan-permit 550
delete vnic 551
delete vnic-iscsi 552
delete vnic-templ 553

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xvii
Contents

delete vsan 554


delete wwn-pool 555
diagnostic-interrupt 556
dir 557
disable (distributed-virtual-switch) 559
disable cdp 560
disable cimxml 561
disable core-export-target 562
disable http 563
disable http-redirect 564
disable https 565
disable locator-led 566
disable (port-channel) 567
disable snmp 568
disable syslog 569
disable telnet-server 570
disassociate 571
discard-buffer 572
download image 573
download license 574
enable (distributed-virtual-switch) 575
enable cdp 576
enable cimxml 577
enable cluster 578
enable core-export-target 579
enable http 580
enable http-redirect 581
enable https 582
enable locator-led 583
enable (port-channel) 584
enable snmp 585
enable syslog 586
enable telnet-server 588
end 589
enter adapter 590

Cisco UCS Manager CLI Command Reference, Release 2.0


xviii OL-25718-02
Contents

enter auth-domain 591


enter auth-profile 592
enter auth-server-group 593
enter auto-target-if 594
enter backup 595
enter bladeserver-disc-policy 597
enter block 598
enter boot-definition 600
enter boot-policy 601
enter boot-target 602
enter cap-qual 603
enter chassis 605
enter class chassis-stats 606
enter class cpu-env-stats 607
enter class dimm-env-stats 608
enter class env-stats 609
enter class ether-error-stats 610
enter class ether-loss-stats 611
enter class ethernet-port-err-stats 612
enter class ethernet-port-multicast-stats 613
enter class ethernet-port-over-under-sized-stats 614
enter class ethernet-port-stats 615
enter class ethernet-port-stats-by-size-large-packets 616
enter class ethernet-port-stats-by-size-small-packets 617
enter class ether-pause-stats 618
enter class ether-rx-stats 619
enter class ether-tx-stats 620
enter class fan-module-stats 621
enter class fan-stats 622
enter class fc-error-stats 623
enter class fc-port-stats 624
enter class fc-stats 625
enter class fex-env-stats 626
enter class fex-power-summary 627
enter class fex-psu-input-stats 628

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xix
Contents

enter class io-card-stats 629


enter class mb-power-stats 630
enter class mb-temp-stats 631
enter class memory-array-env-stats 632
enter class motherboard-temp-stats 633
enter class pcie-fatal-completion-error-stats 634
enter class pcie-fatal-error-stats 635
enter class pcie-fatal-protocol-error-stats 636
enter class pcie-fatal-receiving-error-stats 637
enter class psu-input-stats 638
enter class rack-unit-fan-stats 639
enter class rack-unit-psu-stats 640
enter class system-stats 641
enter class vnic-stats 642
enter client 643
enter cluster 644
enter cpu 645
enter data-center 646
enter default-auth 647
enter default-behavior 648
enter destination 649
enter dest-interface 650
enter dhcp-ip-params 651
enter distributed-virtual-switch 652
enter dynamic-vnic-conn 653
enter dynamic-vnic-conn-policy 654
enter egress-policy 655
enter eth-if 656
enter eth-if (vnic-iscsi) 657
enter eth-mon-session 658
enter eth-policy 659
enter eth-target 660
enter ext-static-ip 661
enter fc-mon-session 662
enter fc-policy 663

Cisco UCS Manager CLI Command Reference, Release 2.0


xx OL-25718-02
Contents

enter folder 664


enter fw-host-pack 665
enter fw-mgmt-pack 666
enter import-config 667
enter initiator 669
enter interface 670
enter interface fc 671
enter interface fcoe 672
enter ip-if 673
enter ipmi-access-profile 674
enter ipmi-user 675
enter iqn-pool 677
enter iscsi-policy 678
enter iscsi 679
enter keyring 680
enter lan 681
enter ldap-group 682
enter ldap-group-rule 683
enter local 684
enter local-disk-config 685
enter local-disk-config-policy 686
enter locale 687
enter local-user 688
enter lun 689
enter mac-pool 690
enter mac-security 691
enter maint-policy 692
enter member-port 693
enter member-port fc 695
enter member-port fcoe 696
enter member-port (/fc-storage/vsan) 698
enter member-port (/port-channel) 700
enter member-port-channel 701
enter memory 703
enter mon-src 704

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xxi
Contents

enter network 706


enter nw-ctrl-policy 707
enter occurrence one-time 708
enter occurrence recurring 709
enter org 710
enter pack-image 711
enter path 713
enter path (iscsi) 714
enter pin-group 715
enter policy 716
enter pooled-ip-params 718
enter pooling-policy 719
enter port-channel 720
enter port-profile (profile-set) 721
enter power-control-policy 722
enter power-group 723
enter processor 724
enter qos-policy 725
enter rack 726
enter scheduler 727
enter server 728
enter server-ref 729
enter static-ip-params 730
enter static-target-if 732
enter storage 733
enter threshold-value 734
enter vcenter 736
enter vcon 737
enter vcon-policy 738
enter vlan 739
enter vlan (port-profile) 741
enter vnic-iscsi 742
enter vsan 743
erase configuration 745
erase-log-config 746

Cisco UCS Manager CLI Command Reference, Release 2.0


xxii OL-25718-02
Contents

install file 747


ls 748
mkdir 750
move 752
ping 754
power 756
power down soft-followed-by-hard 757
power down soft-shut-down 758
pwd 759
reboot 760
recommission chassis 761
recommission fex 762
recommission server 763
recover-bios 764
remove alertgroups 765
remove backup action 767
remove fex 769
remove privilege 770
remove server 773
reset 774
reset-cmos 776
reset-errors 777
reset-kvm 778
reset pers-bind 779
restart 780
rmdir 781
run-script 783
save 784
scope adapter 785
scope auth-domain 786
scope auth-profile 787
scope auth-server-group 788
scope auto-target-if 789
scope backup 790
scope banner 791

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xxiii
Contents

scope beacon-led 792


scope bios-settings 793
scope bios 795
scope bladeserver-disc-policy 796
scope block 797
scope boardcontroller 798
scope boot-definition 799
scope boot-policy 800
scope boot-target 801
scope callhome 802
scope capability 803
scope cap-qual 804
scope card 806
scope cat-updater 807
scope cert-store 808
scope chassis 809
scope chassis (/capability) 810
scope chassis-conn-policy 811
scope chassis-disc-policy 812
scope cimc 813
scope class chassis-stats 814
scope class cpu-env-stats 815
scope class dimm-env-stats 816
scope class ether-error-stats 817
scope class ether-loss-stats 818
scope class ethernet-port-err-stats 819
scope class ethernet-port-multicast-stats 820
scope class ethernet-port-over-under-sized-stats 821
scope class ethernet-port-stats 822
scope class ethernet-port-stats-by-size-large-packets 823
scope class ethernet-port-stats-by-size-small-packets 824
scope class ether-pause-stats 825
scope class ether-rx-stats 826
scope class ether-tx-stats 827
scope class fan-module-stats 828

Cisco UCS Manager CLI Command Reference, Release 2.0


xxiv OL-25718-02
Contents

scope class fan-stats 829


scope class fc-error-stats 830
scope class fc-stats 831
scope class fex-env-stats 832
scope class fex-power-summary 833
scope class fex-psu-input-stats 834
scope class io-card-stats 835
scope class memory-array-env-stats 836
scope class memory-error-correctable-codes-stats 837
scope class memory-mirroring-error-stats 838
scope class memory-sparing-error-stats 839
scope class motherboard-temp-stats 840
scope class pc-ie-correctable-stats 841
scope class pcie-fatal-completion-error-stats 842
scope class pcie-fatal-error-stats 843
scope class pcie-fatal-protocol-error-stats 844
scope class pcie-fatal-receiving-error-stats 845
scope class rack-unit-fan-stats 846
scope class rack-unit-psu-stats 847
scope client 848
scope cluster-set 849
scope cluster 850
scope console-auth 851
scope cpu 852
scope cpu (/system/capability) 853
scope data-center 854
scope default-auth 855
scope default-behavior 856
scope dest-interface 857
scope dhcp-ip-params 858
scope diag 859
scope dimm 860
scope distributed-virtual-switch 861
scope download-task 862
scope dynamic-vnic-conn 863

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xxv
Contents

scope dynamic-vnic-conn-policy 864


scope egress-policy 865
scope eth-best-effort 866
scope eth-classified 867
scope eth-if 868
scope eth-if (vnic-iscsi) 869
scope eth-mon-session 870
scope eth-policy 871
scope eth-server 872
scope eth-storage 873
scope eth-target 874
scope eth-traffic-mon 875
scope eth-uplink 876
scope ext-eth-if 877
scope extension-key 878
scope ext-pooled-ip 879
scope ext-static-ip 880
scope fabric 881
scope fabric-if 883
scope fabric-interconnect 884
scope fabric-port-channel 885
scope fan 886
scope fan-module 887
scope fc 888
scope fc-mon-session 889
scope fc-policy 890
scope fc-storage 891
scope fc-traffic-mon 892
scope fc-uplink 893
scope fex 894
scope firmware 895
scope flow-control 896
scope folder 897
scope fw-host-pack 898
scope fw-mgmt-pack 899

Cisco UCS Manager CLI Command Reference, Release 2.0


xxvi OL-25718-02
Contents

scope host-eth-if 900


scope host-eth-if dynamic-mac 901
scope host-fc-if 902
scope host-fc-if wwn 903
scope host-iscsi-if 904
scope host-port-channel 905
scope import-config 906
scope instance 907
scope interface 908
scope interface fc 909
scope interface fcoe 910
scope inventory 911
scope iom (/chassis) 912
scope iom (/capability) 913
scope iom (/fex) 914
scope ip-if 915
scope ipmi-access-profile 916
scope ipmi-user 917
scope iqn-pool 918
scope iscsi-policy 919
scope iscsi 920
scope lan 921
scope ldap 922
scope ldap-group 923
scope ldap-group-rule 924
scope license 925
scope locale 926
scope local-disk-config 927
scope lun 928
scope lun (static-target-if) 929
scope mac-security 930
scope maint-policy 931
scope management-extension 932
scope member-port-channel 933
scope member-port 935

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xxvii
Contents

scope member-port fc 937


scope member-port fcoe 938
scope memory-array 940
scope mon-flt 941
scope monitoring 942
scope mon-src 943
scope network 945
scope nw-ctrl-policy 946
scope occurrence one-time 947
scope occurrence recurring 948
scope org 949
scope password-profile 950
scope path (iscsi) 951
scope policy 952
scope pooled-ip-params 954
scope port-channel 955
scope port-profile 956
scope post-code-reporter 957
scope post-code-template 958
scope power-cap-mgmt 959
scope power-control-policy 960
scope power-group 961
scope pre-login-banner 962
scope priority-weight 963
scope profile 964
scope profile-set 965
scope psu 966
scope psu-policy 967
scope qos 968
scope qos-policy 969
scope rack 970
scope rack-mount 971
scope rackserver-disc-policy 972
scope radius 973
scope raid-controller 974

Cisco UCS Manager CLI Command Reference, Release 2.0


xxviii OL-25718-02
Contents

scope role 975


scope scheduler 976
scope security 977
scope server 978
scope server (/ldap) 979
scope server (vm-mgmt) 980
scope server-if 981
scope server-qual 982
scope server-ref 983
scope services 984
scope service-profile 985
scope service-profile (/org) 987
scope snmp-user 988
scope static-ip-params 989
scope static-target-if 991
scope stats-threshold-policy 992
scope storage-controller 993
scope sys-defaults 994
scope system 995
scope tacacs 996
scope threshold-value 997
scope update 999
scope vcenter 1000
scope vcon-policy 1001
scope vhba 1002
scope vhba-templ 1003
scope virtual-machine 1004
scope virtual-machine (vm-mgmt) 1005
scope vlan 1006
scope vlan (port-profile) 1007
scope vm-life-cycle-policy 1008
scope vm-mgmt 1009
scope vmware 1010
scope vnic 1011
scope vnic-iscsi 1012

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xxix
Contents

scope vnic-templ 1013


scope vsan 1014
scope web-session-limits 1015
scope wwn-pool 1016
send 1017
send-syslog 1018
send-test-alert 1020
set account-status 1022
set action 1024
set adaptor-policy 1026
set adaptor-policy 1027
set addr 1028
set adminspeed 1029
set adminstate 1030
set admin-state 1032
set admin-state (beacon-led) 1033
set admin-vcon 1034
set aes-128 1035
set agent-policy 1036
set alertgroups 1037
set all 1039
set arch 1041
set attribute 1043
set auth 1044
set authentication console 1045
set authentication default 1046
set authport 1047
set authorization 1048
set auth-server-group 1049
set backup action 1050
set backup clear-on-backup 1052
set backup destination 1053
set backup format 1055
set backup hostname 1056
set backup interval 1057

Cisco UCS Manager CLI Command Reference, Release 2.0


xxx OL-25718-02
Contents

set backup password 1058


set backup protocol 1059
set backup remote-path 1060
set backup user 1061
set basedn 1062
set binddn 1063
set bios-settings-scrub 1064
set blocksize 1066
set boot-option-retry-config retry 1067
set boot-policy 1068
set cap-policy 1069
set cert 1070
set certchain 1071
set certificate 1072
set change-count 1073
set change-during-interval 1074
set change-interval 1075
set cimxml port 1076
set clear-action 1077
set clear password-history 1078
set cli suppress-field-spillover 1079
set cli suppress-headers 1081
set cli table-field-delimiter 1082
set clock (memory) 1084
set clock (system) 1085
set cluster 1086
set collection-interval 1087
set communication-policy-ctrl 1088
set community 1090
set comp-queue count 1091
set concur-tasks 1092
set console-redir-config baud-rate 1093
set console-redir-config console-redir 1094
set console-redir-config flow-control 1096
set console-redir-config legacy-os-redir 1097

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xxxi
Contents

set console-redir-config terminal-type 1098


set contact 1100
set contract-id 1101
set core-export-target path 1102
set core-export-target port 1103
set core-export-target server-description 1104
set core-export-target server-name 1105
set correctible-memory-error-log-threshold-config 1106
set cos 1107
set country 1108
set cpu-performance-config cpu-performance 1110
set customer-id 1112
set data-center 1113
set data-center-folder 1114
set data-center (/client) 1115
set date 1116
set day 1118
set deescalating 1120
set default-gw 1121
set default-net 1122
set defaultzoning 1123
set descr 1124
set description 1126
set descr (vcon-policy) 1127
set destination org 1128
set dhcp-vendor-id 1129
set direct-cache-access-config access 1130
set direction 1131
set diskless 1133
set disk-scrub 1134
set dns-policy-ctrl 1135
set dns 1137
set domain-name 1139
set drop 1140
set dvs 1141

Cisco UCS Manager CLI Command Reference, Release 2.0


xxxii OL-25718-02
Contents

set dynamic-eth 1142


set email 1143
set e-mail (/keyring) 1144
set enforce-vnic-name 1146
set enhanced-intel-speedstep-config 1147
set error-recovery fcp-error-recovery 1148
set error-recovery link-down-timeout 1149
set error-recovery port-down-io-retry-count 1150
set error-recovery port-down-timeout 1151
set escalating 1152
set execute-disable bit 1153
set expiration 1154
set expire-warn-interval 1156
set ext-mgmt-ip-state 1157
set fabric 1158
set failover timeout 1159
set fc-if name 1160
set fcoe-vlan 1161
set fcoe-storage-native-vlan 1162
set file size 1163
set filter 1164
set firstname 1165
set flap-interval 1166
set flow-control-policy 1167
set folder 1168
set folder (/client) 1169
set forged-transmit 1170
set format 1171
set from-email 1173
set front-panel-lockout-config 1174
set history-count 1175
set host 1176
set host-cos-control 1177
set host-fw-policy 1178
set host-nwio-perf 1179

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xxxiii
Contents

set hostname 1180


set hostname 1181
set hour 1182
set http port 1183
set https cipher-suite-mode 1184
set https cipher-suite 1185
set https keyring 1186
set https port 1187
set hyper-threading-config 1188
set id 1189
set identity dynamic-mac 1190
set identity dynamic-uuid 1191
set identity dynamic-wwnn 1192
set identity dynamic-wwpn 1193
set identity mac-pool 1194
set identity uuid-suffix-pool 1195
set identity wwnn-pool 1196
set identity wwpn-pool 1197
set intel-turbo-boost-config 1198
set intel-vt-config 1199
set intel-vt-directed-io-config 1200
set interrupt coalescing-time 1202
set interrupt coalescing-type 1203
set interrupt count 1204
set interrupt mode 1205
set interval-days 1206
set ip 1207
set ipmi-access-profile 1209
set iqn-prefix 1210
set iscsi-adaptor-policy 1211
set iscsi-identity initiator-name 1212
set iscsi-protocol-item boottotarget 1213
set iscsi-protocol-item connection-timeout 1214
set iscsi-protocol-item dhcp-timeout 1215
set iscsi-protocol-item hbamode 1216

Cisco UCS Manager CLI Command Reference, Release 2.0


xxxiv OL-25718-02
Contents

set iscsi-protocol-item lun-busy-retrycount 1217


set iscsi-protocol-item tcp-time-stamp 1218
set iscsi-targetname 1219
set iscsivnicname 1220
set isnative 1221
set key (server) 1222
set key (extension-key) 1223
set lastname 1224
set level 1225
set link-aggregation-pref 1227
set link-aggregation-pref (/chassis-disc-policy) 1228
set local-disk-policy 1229
set locality 1230
set lun 1232
set lv-dimm-support-config 1233
set macaddress 1234
set mac-aging 1235
set mac-pool 1236
set maint-policy 1237
set maxcap 1238
set maxcores 1239
set max-duration 1240
set max-field-size 1242
set max-http-user-sessions 1243
set maximum 1244
set max-ports 1245
set processor-c1e-config c1e 1246
set max-memory-below-4gb-config max-memory 1248
set max-variable-mtrr-setting-config processor-mtrr 1249
set maxprocs 1251
set maxsize 1252
set maxthreads 1253
set member-of-attribute 1254
set memory-mirroring-mode 1255
set memory-ras-config 1256

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xxxv
Contents

set memory-sparing-mode sparing-mode 1258


set message 1259
set mgmt-fw-policy 1260
set mgmt-if-mon-policy arp-deadline 1261
set mgmt-if-mon-policy monitor-mechanism 1263
set mgmt-if-mon-policy ping-requests 1265
set mgmt-if-mon-policy poll-interval 1266
set mincap 1267
set mincores 1268
set min-interval 1269
set minprocs 1271
set minthreads 1272
set minute 1273
set mode (eth-uplink) 1274
set mode (fc-uplink) 1275
set mode (fw-pack) 1276
set mode (local-disk) 1277
set model-regex 1279
set module 1280
set modulus 1282
set mtu 1283
set mtu (eth-best-effort) 1284
set mtu (vnic) 1285
set multicast-optimize 1286
set multicastoptimize (eth-best-effort) 1287
set name 1288
set native 1289
set no-change-interval 1290
set normal-value 1291
set notificationtype 1292
set numa-config 1293
set numberofblocks 1294
set nw-control-policy 1295
set offload large-receive 1296
set offload tcp-rx-checksum 1297

Cisco UCS Manager CLI Command Reference, Release 2.0


xxxvi OL-25718-02
Contents

set offload tcp-segment 1298


set offload tcp-tx-checksum 1299
set onboard-scu-storage-support 1300
set order (device boot order) 1301
set order (vhba pci scan order) 1302
set order (vnic relative order) 1303
set org-unit-name 1304
set org-name 1306
set out-of-band 1308
set overlay-vnic-name 1309
set password 1310
set password (auth-profile) 1312
set password (snmp-user) 1313
set path 1314
set peak 1315
set per-user 1316
set perdiskcap 1317
set pers-bind 1318
set phone 1319
set phone-contact 1320
set pid-regex 1321
set pin-group 1323
set pingroupname 1324
set pool 1325
set port 1326
set port io-throttle-count 1328
set port max-luns 1329
set port-f-logi retries 1330
set port-f-logi timeout 1331
set portmode 1332
set port-p-logi retries 1333
set port-p-logi timeout 1334
set post-error-pause-config port-error-pause 1335
set power-budget committed 1336
set power-control-policy 1337

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xxxvii
Contents

set preserve-pooled-values 1338


set prio 1339
set priority 1341
set privilege 1342
set priv-password 1343
set proc-cap 1344
set processor-c-state-config c-state 1346
set processor-c3-report-config 1348
set processor-c6-report-config 1350
set protect 1351
set protocol 1352
set pubnwname 1353
set qos-policy 1354
set qualifier 1355
set quiet-boot-config 1356
set rate 1357
set realloc 1359
set realm 1360
set realm 1361
set reboot-on-update 1362
set reboot-policy 1363
set receive 1365
set recv-queue count 1366
set recv-queue ring-size 1367
set redundancy 1368
set refresh-period 1370
set regenerate 1371
set remote-file 1372
set reply-to-email 1373
set reporting-interval 1374
set resume-ac-on-power-loss-config 1375
set retention-interval 1377
set retries 1379
set rootdn 1380
set rss receivesidescaling 1381

Cisco UCS Manager CLI Command Reference, Release 2.0


xxxviii OL-25718-02
Contents

set scheduler 1382


set scrub-policy 1383
set scsi-io count 1384
set scsi-io ring-size 1385
set send 1386
set send-periodically 1387
set server 1388
set session-timeout 1389
set sharing 1390
set site-id 1391
set size 1392
set snmp community 1393
set sol-policy 1394
set speed 1395
set speed (/eth-mon-session) 1397
set speed (/fc-mon-session) 1398
set speed (Uplink Ethernet Port) 1399
set src-templ-name 1400
set sshkey 1401
set ssl 1402
set uefi-os-legacy-video-config legacy-video 1403
set state 1404
set stats-policy 1406
set stepping 1407
set street-address 1408
set subject-name 1409
set subnet 1411
set switch-priority 1412
set syslog console 1414
set syslog file 1416
set syslog monitor 1418
set syslog remote-destination 1420
set target 1422
set template 1424
set template-name 1425

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xxxix
Contents

set throttling 1426


set timeofday-hour 1427
set timeofday-minute 1428
set timeout 1429
set timezone 1430
set total 1432
set trans-queue count 1433
set trans-queue ring-size 1434
set trustpoint 1435
set type (backup) 1436
set type (partition) 1437
set type (template) 1438
set units 1439
set uplink-fail-action 1440
set uplink-trunking 1441
set usb-boot-config make-device-non-bootable 1442
set usb-front-panel-access-lock-config usb-front-panel-lock 1443
set usb-system-idle-power-optimizing-setting-config usb-idle-power-optimizing 1444
set user 1445
set user-id 1446
set userid 1447
set user-label 1448
set uuid-prefix 1449
set v3privilege 1450
set vcon 1451
set vcon-profile 1453
set version 1454
set version (snmp-trap) 1455
set vhba 1456
set virtual-ip 1457
set vlan-id 1458
set vmretention 1459
set vnic 1460
set vnicretention 1461
set weight 1462

Cisco UCS Manager CLI Command Reference, Release 2.0


xl OL-25718-02
Contents

set width 1463


set wwn 1464
set wwpn-pool 1465
show activate status 1466
show adapter 1467
show assoc 1469
show audit-logs 1470
show auth-domain 1472
show authentication 1473
show auth-server-group 1474
show backup 1475
show backup (ep-log-policy) 1477
show beacon-led 1478
show beacon-led fsm status 1479
show bios 1480
show bladeserver-disc-policy 1481
show boot-definition 1483
show boot-order 1484
show boot-option-retry-config 1485
show boot-policy 1486
show boot-target 1488
show callhome 1490
show cap-qual 1492
show card Command 1494
show cat-updater 1495
show certreq 1496
show chassis-conn-policy 1498
show chassis 1500
show cimc 1502
show cimxml 1504
show class cpu-stats 1505
show class dimm-env-stats 1507
show class env-stats 1508
show class ethernet-port-err-stats 1509
show class ethernet-port-multicast-stats 1510

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xli
Contents

show class ethernet-port-over-under-sized-stats 1511


show class ethernet-port-stats 1512
show class ethernet-port-stats-by-size-large-packets 1513
show class ethernet-port-stats-by-size-small-packets 1514
show class ether-pause-stats 1515
show class io-card-stats 1516
show class memory-array-env-stats 1517
show class motherboard-temp-stats 1518
show class pcie-fatal-completion-error-stats 1520
show class pcie-fatal-error-stats 1521
show class pcie-fatal-protocol-error-stats 1522
show class pcie-fatal-receiving-error-stats 1523
show cli 1524
show cli history 1525
show clock (system) 1526
show cluster 1527
show connectivity 1528
show console-auth 1529
show core-export-target 1530
show cores 1531
show cpu 1533
show default-auth 1534
show destination 1535
show disk 1537
show distributed-virtual-switch 1539
show dns 1540
show download-task 1541
show dynamic-conn-policy 1543
show egress-policy 1544
show environment 1545
show error-recovery 1547
show eth-classified 1548
show eth-if 1550
show eth-if (vnic-iscsi) 1552
show eth-mon-session 1554

Cisco UCS Manager CLI Command Reference, Release 2.0


xlii OL-25718-02
Contents

show eth-profile 1555


show eth-target 1557
show eth-uplink 1558
show event 1560
show execute-disable 1562
show extension-key 1563
show ext-eth-if 1564
show ext-ipv6-rss-hash 1566
show fabric 1567
show fabric-interconnect 1569
show fabric-interconnect inventory 1570
show fabric-interconnect mode 1571
show fabric-port-channel 1572
show failover 1574
show fan 1575
show fan-module 1577
show fault policy 1579
show fc 1580
show fc-if 1581
show fc-profile 1582
show fc-storage 1584
show feature 1586
show file 1587
show host-port-channel 1589
show identity iqn 1590
show identity (server) 1591
show identity (service-profile) 1592
show identity mac-addr 1593
show identity uuid 1595
show identity wwn 1597
show interface 1599
show inventory 1601
show inventory (fabric-interconnect) 1602
show ipmi-user 1604
show iqn-pool 1606

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xliii
Contents

show iscsi-policy 1608


show iscsi-protocol-profile 1609
show iscsi 1610
show ldap-group 1611
show ldap-group-rule 1613
show local-disk-config-policy 1614
show maint-policy 1615
show member-port-channel 1617
show member-port 1619
show member-port fc 1621
show member-port fcoe 1623
show mgmt-if-mon-policy 1625
show mon-src 1627
show nw-ctrl-policy 1629
show occurrence one-time 1631
show occurrence recurring 1633
show password-profile 1635
show pending-changes 1637
show pooled 1638
show port-channel 1640
show power-budget 1642
show power-control-policy 1643
show power-group 1645
show pre-login-banner 1647
show psu-policy 1648
show rackserver-disc-policy 1649
show raid-battery 1650
show scheduler 1651
show security fsm status 1653
show sel 1654
show server actual-boot-order 1656
show server adapter 1658
show server adapter identity 1660
show server adapter inventory 1662
show server adapter layer2 1664

Cisco UCS Manager CLI Command Reference, Release 2.0


xliv OL-25718-02
Contents

show server adapter status 1665


show server boot-order 1667
show server cpu 1669
show server identity 1671
show server-host-id 1672
show server status 1673
show service-profile assoc 1674
show service-profile circuit 1676
show service-profile detail 1678
show service-profile expand 1680
show service-profile fsm 1682
show service-profile identity 1684
show service-profile inventory 1686
show service-profile status 1689
show snmp-user 1691
show sol-policy 1692
show sshkey 1694
show static-target-if 1696
show stats 1697
show storage-controller 1698
show tech-support 1700
show usage 1702
show vcenter 1704
show vcon 1705
show vcon-policy 1706
show vif-ns 1707
show virtual-machine 1708
show vlan-port-count 1709
show vm-life-cycle-policy 1711
show web-session-limits 1712
ssh 1713
tail-mgmt-log 1714
telnet 1716
terminal length 1718
terminal monitor 1719

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xlv
Contents

terminal session-timeout 1720


terminal width 1721
top 1722
traceroute 1723
up 1725
update catalog 1726
update firmware 1728
where 1729

Cisco UCS Manager CLI Command Reference, Release 2.0


xlvi OL-25718-02
Preface
This preface includes the following sections:

• Audience, page xlvii


• Organization, page xlvii
• Conventions, page xlviii
• Related Cisco UCS Documentation, page xlix
• Documentation Feedback, page l
• Obtaining Documentation and Submitting a Service Request, page l

Audience
This guide is intended primarily for data center administrators with responsibilities and expertise in one or
more of the following:
• Server administration
• Storage administration
• Network administration
• Network security

Organization
This document includes the following parts:

Part Title Description


Part 1 Introduction Contains chapters that provide an overview of Cisco Unified
Computing System (Cisco UCS) and Cisco UCS Manager.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xlvii
Preface
Conventions

Part Title Description


Part 2 System Contains chapters that describe how to configure fabric
Configuration interconnects, ports, communication services, primary
authentication, and role-based access control configuration, and
how to manage firmware and the Capability Catalog on a system.

Part 3 Network Contains chapters that describe how to configure named VLANs,
Configuration LAN pin groups, MAC pools, and Quality of Service (QoS).

Part 4 Storage Contains chapters that describe how to configure named VSANs,
Configuration SAN pin groups, and WWN pools.

Part 5 Server Configuration Contains chapters that describe how to configure server-related
policies, server-related pools, service profiles, and server power
usage.

Part 6 System Management Contains chapters that describe how to manage a Cisco UCS
domain, including managing the chassis, servers, and I/O modules,
and how to back up and restore the configuration.

Part 7 System Monitoring Contains chapters that describe how use Cisco UCS Manager to
monitor a Cisco UCS domain, including configuring Call Home,
monitoring data traffic, monitoring hardware, configuring
statistics-related policies, and configuring faults, events, and logs.
For more information about Cisco UCS faults and logs, see the
Cisco UCS Manager B-Series Troubleshooting Guide and the
Cisco UCS Faults and Error Messages Reference.

Conventions
This document uses the following conventions:

Convention Indication
bold font Commands, keywords, GUI elements, and user-entered text
appear in bold font.

italic font Document titles, new or emphasized terms, and arguments for
which you supply values are in italic font.

courierfont Terminal sessions and information that the system displays


appear in courier font.

[] Elements in square brackets are optional.

{x | y | z} Required alternative keywords are grouped in braces and


separated by vertical bars.

Cisco UCS Manager CLI Command Reference, Release 2.0


xlviii OL-25718-02
Preface
Related Cisco UCS Documentation

Convention Indication
[x | y | z] Optional alternative keywords are grouped in brackets and
separated by vertical bars.

string A nonquoted set of characters. Do not use quotation marks


around the string or the string will include the quotation marks.

<> Nonprinting characters such as passwords are in angle brackets.

[] Default responses to system prompts are in square brackets.

!, # An exclamation point (!) or a pound sign (#) at the beginning of


a line of code indicates a comment line.

Note Means reader take note.

Tip Means the following information will help you solve a problem.

Caution Means reader be careful. In this situation, you might perform an action that could result in equipment
damage or loss of data.

Timesaver Means the described action saves time. You can save time by performing the action described in the
paragraph.

Warning Means reader be warned. In this situation, you might perform an action that could result in bodily injury.

Related Cisco UCS Documentation


Documentation Roadmaps
For a complete list of all B-Series documentation, see the Cisco UCS B-Series Servers Documentation Roadmap
available at the following URL: http://www.cisco.com/go/unifiedcomputing/b-series-doc.
For a complete list of all C-Series documentation, see the Cisco UCS C-Series Servers Documentation Roadmap
available at the following URL: http://www.cisco.com/go/unifiedcomputing/c-series-doc .

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 xlix
Preface
Documentation Feedback

Other Documentation Resources


An ISO file containing all B and C-Series documents is available at the following URL: http://www.cisco.com/
cisco/software/type.html?mdfid=283853163&flowid=25821. From this page, click Unified Computing
System (UCS) Documentation Roadmap Bundle.
The ISO file is updated after every major documentation release.
Follow Cisco UCS Docs on Twitter to receive document update notifications.

Documentation Feedback
To provide technical feedback on this document, or to report an error or omission, please send your comments
to ucs-docfeedback@external.cisco.com. We appreciate your feedback.

Obtaining Documentation and Submitting a Service Request


For information on obtaining documentation, submitting a service request, and gathering additional information,
see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco
technical documentation.
Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed
and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free
service and Cisco currently supports RSS version 2.0.
Follow Cisco UCS Docs on Twitter to receive document update notifications.

Cisco UCS Manager CLI Command Reference, Release 2.0


l OL-25718-02
Overview of Cisco Unified Computing System
This chapter includes the following sections:

• About Cisco Unified Computing System , page 1


• Unified Fabric, page 2
• Server Architecture and Connectivity, page 4
• Traffic Management, page 25
• Opt-In Features, page 30
• Virtualization in Cisco UCS , page 33

About Cisco Unified Computing System


Cisco Unified Computing System (Cisco UCS) fuses access layer networking and servers. This
high-performance, next-generation server system provides a data center with a high degree of workload agility
and scalability.
The hardware and software components support Cisco's unified fabric, which runs multiple types of data
center traffic over a single converged network adapter.

Architectural Simplification
The simplified architecture of Cisco UCS reduces the number of required devices and centralizes switching
resources. By eliminating switching inside a chassis, network access-layer fragmentation is significantly
reduced.
Cisco UCS implements Cisco unified fabric within racks and groups of racks, supporting Ethernet and Fibre
Channel protocols over 10 Gigabit Cisco Data Center Ethernet and Fibre Channel over Ethernet (FCoE) links.
This radical simplification reduces the number of switches, cables, adapters, and management points by up
to two-thirds. All devices in a Cisco UCS domain remain under a single management domain, which remains
highly available through the use of redundant components.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1
Overview of Cisco Unified Computing System
Unified Fabric

High Availability
The management and data plane of Cisco UCS is designed for high availability and redundant access layer
fabric interconnects. In addition, Cisco UCS supports existing high availability and disaster recovery solutions
for the data center, such as data replication and application-level clustering technologies.

Scalability
A single Cisco UCS domain supports multiple chassis and their servers, all of which are administered through
one Cisco UCS Manager. For more detailed information about the scalability, speak to your Cisco representative.

Flexibility
A Cisco UCS domain allows you to quickly align computing resources in the data center with rapidly changing
business requirements. This built-in flexibility is determined by whether you choose to fully implement the
stateless computing feature.
Pools of servers and other system resources can be applied as necessary to respond to workload fluctuations,
support new applications, scale existing software and business services, and accommodate both scheduled
and unscheduled downtime. Server identity can be abstracted into a mobile service profile that can be moved
from server to server with minimal downtime and no need for additional network configuration.
With this level of flexibility, you can quickly and easily scale server capacity without having to change the
server identity or reconfigure the server, LAN, or SAN. During a maintenance window, you can quickly do
the following:
• Deploy new servers to meet unexpected workload demand and rebalance resources and traffic.
• Shut down an application, such as a database management system, on one server and then boot it up
again on another server with increased I/O capacity and memory resources.

Optimized for Server Virtualization


Cisco UCS has been optimized to implement VM-FEX technology. This technology provides improved
support for server virtualization, including better policy-based configuration and security, conformance with
a company's operational model, and accommodation for VMware's VMotion.

Unified Fabric
With unified fabric, multiple types of data center traffic can run over a single Data Center Ethernet (DCE)
network. Instead of having a series of different host bus adapters (HBAs) and network interface cards (NICs)
present in a server, unified fabric uses a single converged network adapter. This type of adapter can carry
LAN and SAN traffic on the same cable.
Cisco UCS uses Fibre Channel over Ethernet (FCoE) to carry Fibre Channel and Ethernet traffic on the same
physical Ethernet connection between the fabric interconnect and the server. This connection terminates at a
converged network adapter on the server, and the unified fabric terminates on the uplink ports of the fabric
interconnect. On the core network, the LAN and SAN traffic remains separated. Cisco UCS does not require
that you implement unified fabric across the data center.
The converged network adapter presents an Ethernet interface and Fibre Channel interface to the operating
system. At the server, the operating system is not aware of the FCoE encapsulation because it sees a standard
Fibre Channel HBA.

Cisco UCS Manager CLI Command Reference, Release 2.0


2 OL-25718-02
Overview of Cisco Unified Computing System
Fibre Channel over Ethernet

At the fabric interconnect, the server-facing Ethernet port receives the Ethernet and Fibre Channel traffic. The
fabric interconnect (using Ethertype to differentiate the frames) separates the two traffic types. Ethernet frames
and Fibre Channel frames are switched to their respective uplink interfaces.

Fibre Channel over Ethernet


Cisco UCS leverages Fibre Channel over Ethernet (FCoE) standard protocol to deliver Fibre Channel. The
upper Fibre Channel layers are unchanged, so the Fibre Channel operational model is maintained. FCoE
network management and configuration is similar to a native Fibre Channel network.
FCoE encapsulates Fibre Channel traffic over a physical Ethernet link. FCoE is encapsulated over Ethernet
with the use of a dedicated Ethertype, 0x8906, so that FCoE traffic and standard Ethernet traffic can be carried
on the same link. FCoE has been standardized by the ANSI T11 Standards Committee.
Fibre Channel traffic requires a lossless transport layer. Instead of the buffer-to-buffer credit system used by
native Fibre Channel, FCoE depends upon the Ethernet link to implement lossless service.
Ethernet links on the fabric interconnect provide two mechanisms to ensure lossless transport for FCoE traffic:
• Link-level flow control
• Priority flow control

Link-Level Flow Control


IEEE 802.3x link-level flow control allows a congested receiver to signal the endpoint to pause data transmission
for a short time. This link-level flow control pauses all traffic on the link.
The transmit and receive directions are separately configurable. By default, link-level flow control is disabled
for both directions.
On each Ethernet interface, the fabric interconnect can enable either priority flow control or link-level flow
control (but not both).

Priority Flow Control


The priority flow control (PFC) feature applies pause functionality to specific classes of traffic on the Ethernet
link. For example, PFC can provide lossless service for the FCoE traffic, and best-effort service for the standard
Ethernet traffic. PFC can provide different levels of service to specific classes of Ethernet traffic (using IEEE
802.1p traffic classes).
PFC decides whether to apply pause based on the IEEE 802.1p CoS value. When the fabric interconnect
enables PFC, it configures the connected adapter to apply the pause functionality to packets with specific CoS
values.
By default, the fabric interconnect negotiates to enable the PFC capability. If the negotiation succeeds, PFC
is enabled and link-level flow control remains disabled (regardless of its configuration settings). If the PFC
negotiation fails, you can either force PFC to be enabled on the interface or you can enable IEEE 802.x
link-level flow control.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 3
Overview of Cisco Unified Computing System
Server Architecture and Connectivity

Server Architecture and Connectivity

Overview of Service Profiles


Service profiles are the central concept of Cisco UCS. Each service profile serves a specific purpose: ensuring
that the associated server hardware has the configuration required to support the applications it will host.
The service profile maintains configuration information about the server hardware, interfaces, fabric
connectivity, and server and network identity. This information is stored in a format that you can manage
through Cisco UCS Manager. All service profiles are centrally managed and stored in a database on the fabric
interconnect.
Every server must be associated with a service profile.

Important At any given time, each server can be associated with only one service profile. Similarly, each service
profile can be associated with only one server at a time.

After you associate a service profile with a server, the server is ready to have an operating system and
applications installed, and you can use the service profile to review the configuration of the server. If the
server associated with a service profile fails, the service profile does not automatically fail over to another
server.
When a service profile is disassociated from a server, the identity and connectivity information for the server
is reset to factory defaults.

Network Connectivity through Service Profiles


Each service profile specifies the LAN and SAN network connections for the server through the Cisco UCS
infrastructure and out to the external network. You do not need to manually configure the network connections
for Cisco UCS servers and other components. All network configuration is performed through the service
profile.
When you associate a service profile with a server, the Cisco UCS internal fabric is configured with the
information in the service profile. If the profile was previously associated with a different server, the network
infrastructure reconfigures to support identical network connectivity to the new server.

Configuration through Service Profiles


A service profile can take advantage of resource pools and policies to handle server and connectivity
configuration.

Hardware Components Configured by Service Profiles


When a service profile is associated with a server, the following components are configured according to the
data in the profile:
• Server, including BIOS and CIMC
• Adapters

Cisco UCS Manager CLI Command Reference, Release 2.0


4 OL-25718-02
Overview of Cisco Unified Computing System
Overview of Service Profiles

• Fabric interconnects

You do not need to configure these hardware components directly.

Server Identity Management through Service Profiles


You can use the network and device identities burned into the server hardware at manufacture or you can use
identities that you specify in the associated service profile either directly or through identity pools, such as
MAC, WWN, and UUID.
The following are examples of configuration information that you can include in a service profile:
• Profile name and description
• Unique server identity (UUID)
• LAN connectivity attributes, such as the MAC address
• SAN connectivity attributes, such as the WWN

Operational Aspects configured by Service Profiles


You can configure some of the operational functions for a server in a service profile, such as the following:
• Firmware packages and versions
• Operating system boot order and configuration
• IPMI and KVM access

vNIC Configuration by Service Profiles


A vNIC is a virtualized network interface that is configured on a physical network adapter and appears to be
a physical NIC to the operating system of the server. The type of adapter in the system determines how many
vNICs you can create. For example, a converged network adapter has two NICs, which means you can create
a maximum of two vNICs for each adapter.
A vNIC communicates over Ethernet and handles LAN traffic. At a minimum, each vNIC must be configured
with a name and with fabric and network connectivity.

vHBA Configuration by Service Profiles


A vHBA is a virtualized host bus adapter that is configured on a physical network adapter and appears to be
a physical HBA to the operating system of the server. The type of adapter in the system determines how many
vHBAs you can create. For example, a converged network adapter has two HBAs, which means you can
create a maximum of two vHBAs for each of those adapters. In contrast, a network interface card does not
have any HBAs, which means you cannot create any vHBAs for those adapters.
A vHBA communicates over FCoE and handles SAN traffic. At a minimum, each vHBA must be configured
with a name and fabric connectivity.

Service Profiles that Override Server Identity


This type of service profile provides the maximum amount of flexibility and control. This profile allows you
to override the identity values that are on the server at the time of association and use the resource pools and
policies set up in Cisco UCS Manager to automate some administration tasks.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 5
Overview of Cisco Unified Computing System
Overview of Service Profiles

You can disassociate this service profile from one server and then associate it with another server. This
re-association can be done either manually or through an automated server pool policy. The burned-in settings,
such as UUID and MAC address, on the new server are overwritten with the configuration in the service
profile. As a result, the change in server is transparent to your network. You do not need to reconfigure any
component or application on your network to begin using the new server.
This profile allows you to take advantage of and manage system resources through resource pools and policies,
such as the following:
• Virtualized identity information, including pools of MAC addresses, WWN addresses, and UUIDs
• Ethernet and Fibre Channel adapter profile policies
• Firmware package policies
• Operating system boot order policies

Unless the service profile contains power management policies, a server pool qualification policy, or another
policy that requires a specific hardware configuration, the profile can be used for any type of server in the
Cisco UCS domain.
You can associate these service profiles with either a rack-mount server or a blade server. The ability to
migrate the service profile depends upon whether you choose to restrict migration of the service profile.

Note If you choose not to restrict migration, Cisco UCS Manager does not perform any compatibility checks
on the new server before migrating the existing service profile. If the hardware of both servers are not
similar, the association might fail.

Service Profiles that Inherit Server Identity


This hardware-based service profile is the simplest to use and create. This profile uses the default values in
the server and mimics the management of a rack-mounted server. It is tied to a specific server and cannot be
moved or migrated to another server.
You do not need to create pools or configuration policies to use this service profile.
This service profile inherits and applies the identity and configuration information that is present at the time
of association, such as the following:
• MAC addresses for the two NICs
• For a converged network adapter or a virtual interface card, the WWN addresses for the two HBAs
• BIOS versions
• Server UUID

Important The server identity and configuration information inherited through this service profile may not be the
values burned into the server hardware at manufacture if those values were changed before this profile is
associated with the server.

Cisco UCS Manager CLI Command Reference, Release 2.0


6 OL-25718-02
Overview of Cisco Unified Computing System
Policies

Service Profile Templates


With a service profile template, you can quickly create several service profiles with the same basic parameters,
such as the number of vNICs and vHBAs, and with identity information drawn from the same pools.

Tip If you need only one service profile with similar values to an existing service profile, you can clone a
service profile in the Cisco UCS Manager GUI.

For example, if you need several service profiles with similar values to configure servers to host database
software, you can create a service profile template, either manually or from an existing service profile. You
then use the template to create the service profiles.
Cisco UCS supports the following types of service profile templates:
Initial template
Service profiles created from an initial template inherit all the properties of the template. However,
after you create the profile, it is no longer connected to the template. If you need to make changes to
one or more profiles created from this template, you must change each profile individually.

Updating template
Service profiles created from an updating template inherit all the properties of the template and remain
connected to the template. Any changes to the template automatically update the service profiles created
from the template.

Policies
Policies determine how Cisco UCS components will act in specific circumstances. You can create multiple
instances of most policies. For example, you might want different boot policies, so that some servers can PXE
boot, some can SAN boot, and others can boot from local storage.
Policies allow separation of functions within the system. A subject matter expert can define policies that are
used in a service profile, which is created by someone without that subject matter expertise. For example, a
LAN administrator can create adapter policies and quality of service policies for the system. These policies
can then be used in a service profile that is created by someone who has limited or no subject matter expertise
with LAN administration.
You can create and use two types of policies in Cisco UCS Manager:
• Configuration policies that configure the servers and other components
• Operational policies that control certain management, monitoring, and access control functions

Configuration Policies

Boot Policy
The boot policy determines the following:

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 7
Overview of Cisco Unified Computing System
Configuration Policies

• Configuration of the boot device


• Location from which the server boots
• Order in which boot devices are invoked

For example, you can choose to have associated servers boot from a local device, such as a local disk or
CD-ROM (VMedia), or you can select a SAN boot or a LAN (PXE) boot.
You must include this policy in a service profile, and that service profile must be associated with a server for
it to take effect. If you do not include a boot policy in a service profile, the server uses the default settings in
the BIOS to determine the boot order.

Important Changes to a boot policy may be propagated to all servers created with an updating service profile template
that includes that boot policy. Reassociation of the service profile with the server to rewrite the boot order
information in the BIOS is auto-triggered.

Chassis Discovery Policy


The chassis discovery policy determines how the system reacts when you add a new chassis. Cisco UCS
Manager uses the settings in the chassis discovery policy to determine the minimum threshold for the number
of links between the chassis and the fabric interconnect and whether to group links from the IOM to the fabric
interconnect in a fabric port channel.

Chassis Links
If you have a Cisco UCS domain that has some chassis wired with 1 link, some with 2 links, some with 4
links, and some with 8 links we recommend that you configure the chassis discovery policy for the minimum
number links in the domain so that Cisco UCS Manager can discover all chassis.

Tip For Cisco UCS implementations that mix IOMs with different numbers of links, we recommend using
the platform max value. Using platform max insures that Cisco UCS Manager uses the maximum number
of IOM uplinks available.

After the initial discovery, you must reacknowledge the chassis that are wired for a greater number of links
and Cisco UCS Manager configures the chassis to use all available links.
Cisco UCS Manager cannot discover any chassis that is wired for fewer links than are configured in the chassis
discovery policy. For example, if the chassis discovery policy is configured for 4 links, Cisco UCS Manager
cannot discover any chassis that is wired for 1 link or 2 links. Reacknowledgement of the chassis does not
resolve this issue.
The following table provides an overview of how the chassis discovery policy works in a multi-chassis Cisco
UCS domain:

Cisco UCS Manager CLI Command Reference, Release 2.0


8 OL-25718-02
Overview of Cisco Unified Computing System
Configuration Policies

Table 1: Chassis Discovery Policy and Chassis Links

Number of 1-Link Chassis 2-Link Chassis 4-Link Chassis 8-Link Chassis Platform-Max
Links Wired Discovery Discovery Discovery Discovery Policy Discovery Policy
for the Chassis Policy Policy Policy
1 link between Chassis is Chassis cannot Chassis cannot Chassis cannot be Chassis is
IOM and discovered by be discovered be discovered discovered by discovered by
fabric Cisco UCS by Cisco UCS by Cisco UCS Cisco UCS Cisco UCS
interconnects Manager and Manager and is Manager and is Manager and is not Manager and added
added to the not added to not added to added to the Cisco to the Cisco UCS
Cisco UCS the Cisco UCS the Cisco UCS UCS domain. domain as a chassis
domain as a domain. domain. wired with 1 link.
chassis wired
with 1 link.

2 links Chassis is Chassis is Chassis cannot Chassis cannot be Chassis cannot be


between IOM discovered by discovered by be discovered discovered by discovered by
and fabric Cisco UCS Cisco UCS by Cisco UCS Cisco UCS Cisco UCS
interconnects Manager and Manager and Manager and is Manager and is not Manager and is not
added to the added to the not added to added to the Cisco added to the Cisco
Cisco UCS Cisco UCS the Cisco UCS UCS domain. UCS domain.
domain as a domain as a domain.
chassis wired chassis wired
with 1 link. with 2 link.
After initial
discovery,
reacknowledge
the chassis and
Cisco UCS
Manager
recognizes and
uses the
additional
links.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 9
Overview of Cisco Unified Computing System
Configuration Policies

Number of 1-Link Chassis 2-Link Chassis 4-Link Chassis 8-Link Chassis Platform-Max
Links Wired Discovery Discovery Discovery Discovery Policy Discovery Policy
for the Chassis Policy Policy Policy
4 links Chassis is Chassis is Chassis is Chassis cannot be If the IOM has 4
between IOM discovered by discovered by discovered by discovered by links, the chassis is
and fabric Cisco UCS Cisco UCS Cisco UCS Cisco UCS discovered by
interconnects Manager and Manager and Manager and Manager and is not Cisco UCS
added to the added to the added to the added to the Cisco Manager and added
Cisco UCS Cisco UCS Cisco UCS UCS domain. to the Cisco UCS
domain as a domain as a domain as a domain as a chassis
chassis wired chassis wired chassis wired wired with 4 links.
with 1 link. with 2 links. with 4 link. If the IOM has 8
After initial After initial links, the chassis is
discovery, discovery, not fully
reacknowledge reacknowledge discovered by
the chassis and the chassis and Cisco UCS
Cisco UCS Cisco UCS Manager.
Manager Manager
recognizes and recognizes and
uses the uses the
additional additional
links. links.

8 links Chassis is Chassis is Chassis is Chassis is Chassis is


between IOM discovered by discovered by discovered by discovered by discovered by
and fabric Cisco UCS Cisco UCS Cisco UCS Cisco UCS Cisco UCS
interconnects Manager and Manager and Manager and Manager and added Manager and added
added to the added to the added to the to the Cisco UCS to the Cisco UCS
Cisco UCS Cisco UCS Cisco UCS domain as a chassis domain as a chassis
domain as a domain as a domain as a wired with 8 links. wired with 8 links.
chassis wired chassis wired chassis wired
with 1 link. with 2 links. with 4 links.
After initial After initial After initial
discovery, discovery, discovery,
reacknowledge reacknowledge reacknowledge
the chassis and the chassis and the chassis and
Cisco UCS Cisco UCS Cisco UCS
Manager Manager Manager
recognizes and recognizes and recognizes and
uses the uses the uses the
additional additional additional
links. links. links.

Link Grouping
For hardware configurations that support fabric port channels, link grouping determines whether all of the
links from the IOM to the fabric interconnect are grouped into a fabric port channel during chassis discovery.
If the link grouping preference is set to port channel, all of the links from the IOM to the fabric interconnect

Cisco UCS Manager CLI Command Reference, Release 2.0


10 OL-25718-02
Overview of Cisco Unified Computing System
Configuration Policies

are grouped in a fabric port channel. If set to no group, links from the IOM to the fabric interconnect are not
grouped in a fabric port channel.
Once a fabric port channel is created, links can be added or removed by changing the link group preference
and reacknowledging the chassis, or by enabling or disabling the chassis from the port channel.

Note The link grouping preference only takes effect if both sides of the links between an IOM or FEX and the
fabric interconnect support fabric port channels. If one side of the links does not support fabric port
channels, this preference is ignored and the links are not grouped in a port channel.

Dynamic vNIC Connection Policy


The dynamic vNIC connection policy determines how the connectivity between VMs and dynamic vNICs is
configured. This policy is required for Cisco UCS domains that include servers with VIC adapters on which
you have installed VMs and configured dynamic vNICs.
Each dynamic vNIC connection policy includes an Ethernet adapter policy and designates the number of
vNICs that can be configured for any server associated with a service profile that includes the policy.

Note If you migrate a server that is configured with dynamic vNICs, the dynamic interface used by the vNICs
fails and Cisco UCS Manager notifies you of that failure.
When the server comes back up, Cisco UCS Manager assigns new dynamic vNICs to the server. If you
are monitoring traffic on the dynamic vNIC, you must reconfigure the monitoring source.

Ethernet and Fibre Channel Adapter Policies


These policies govern the host-side behavior of the adapter, including how the adapter handles traffic. For
example, you can use these policies to change default settings for the following:
• Queues
• Interrupt handling
• Performance enhancement
• RSS hash
• Failover in an cluster configuration with two fabric interconnects

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 11
Overview of Cisco Unified Computing System
Configuration Policies

Note For Fibre Channel adapter policies, the values displayed by Cisco UCS Manager may not match those
displayed by applications such as QLogic SANsurfer. For example, the following values may result in an
apparent mismatch between SANsurfer and Cisco UCS Manager:
• Max LUNs Per Target—SANsurfer has a maximum of 256 LUNs and does not display more than
that number. Cisco UCS Manager supports a higher maximum number of LUNs.
• Link Down Timeout—In SANsurfer, you configure the timeout threshold for link down in seconds.
In Cisco UCS Manager, you configure this value in milliseconds. Therefore, a value of 5500 ms in
Cisco UCS Manager displays as 5s in SANsurfer.
• Max Data Field Size—SANsurfer has allowed values of 512, 1024, and 2048. Cisco UCS Manager
allows you to set values of any size. Therefore, a value of 900 in Cisco UCS Manager displays as
512 in SANsurfer.

Operating System Specific Adapter Policies


By default, Cisco UCS provides a set of Ethernet adapter policies and Fibre Channel adapter policies. These
policies include the recommended settings for each supported server operating system. Operating systems are
sensitive to the settings in these policies. Storage vendors typically require non-default adapter settings. You
can find the details of these required settings on the support list provided by those vendors.

Important We recommend that you use the values in these policies for the applicable operating system. Do not modify
any of the values in the default policies unless directed to do so by Cisco Technical Support.
However, if you are creating an Ethernet adapter policy for a Windows OS (instead of using the default
Windows adapter policy), you must use the following formulas to calculate values that work with Windows:

Completion Queues = Transmit Queues + Receive Queues


Interrupt Count = (Completion Queues + 2) rounded up to nearest power of 2

For example, if Transmit Queues = 1 and Receive Queues = 8 then:

Completion Queues = 1 + 8 = 9
Interrupt Count = (9 + 2) rounded up to the nearest power of 2 = 16

Global Cap Policy


The global cap policy is a global policy that specifies whether policy-driven chassis group power capping or
manual blade-level power capping will be applied to all servers in a chassis.
We recommend that you use the default power capping method: policy-driven chassis group power capping.

Important Any change to the manual blade-level power cap configuration will result in the loss of any groups or
configuration options set for policy-driven chassis group power capping.

Cisco UCS Manager CLI Command Reference, Release 2.0


12 OL-25718-02
Overview of Cisco Unified Computing System
Configuration Policies

Host Firmware Package


This policy enables you to specify a set of firmware versions that make up the host firmware package (also
known as the host firmware pack). The host firmware includes the following firmware for server and adapter
endpoints:
• Adapter
• BIOS
• Board Controller
• FC Adapters
• HBA Option ROM
• Storage Controller

Tip You can include more than one type of firmware in the same host firmware package. For example, a host
firmware package can include both BIOS firmware and storage controller firmware or adapter firmware
for two different models of adapters. However, you can only have one firmware version with the same
type, vendor, and model number. The system recognizes which firmware version is required for an endpoint
and ignores all other firmware versions.

The firmware package is pushed to all servers associated with service profiles that include this policy.
This policy ensures that the host firmware is identical on all servers associated with service profiles which
use the same policy. Therefore, if you move the service profile from one server to another, the firmware
versions are maintained. Also, if you change the firmware version for an endpoint in the firmware package,
new versions are applied to all the affected service profiles immediately, which could cause server reboots.
You must include this policy in a service profile, and that service profile must be associated with a server for
it to take effect.

Prerequisites
This policy is not dependent upon any other policies. However, you must ensure that the appropriate firmware
has been downloaded to the fabric interconnect. If the firmware image is not available when Cisco UCS
Manager is associating a server with a service profile, Cisco UCS Manager ignores the firmware upgrade and
completes the association.

IPMI Access Profile


This policy allows you to determine whether IPMI commands can be sent directly to the server, using the IP
address. For example, you can send commands to retrieve sensor data from the CIMC. This policy defines
the IPMI access, including a username and password that can be authenticated locally on the server, and
whether the access is read-only or read-write.
You must include this policy in a service profile and that service profile must be associated with a server for
it to take effect.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 13
Overview of Cisco Unified Computing System
Configuration Policies

Local Disk Configuration Policy


This policy configures any optional SAS local drives that have been installed on a server through the onboard
RAID controller of the local drive. This policy enables you to set a local disk mode for all servers that are
associated with a service profile that includes the local disk configuration policy.
The local disk modes include the following:
• No Local Storage—For a diskless server or a SAN only configuration. If you select this option, you
cannot associate any service profile which uses this policy with a server that has a local disk.
• RAID 0 Striped—Data is striped across all disks in the array, providing fast throughput. There is no
data redundancy, and all data is lost if any disk fails.
• RAID 1 Mirrored—Data is written to two disks, providing complete data redundancy if one disk fails.
The maximum array size is equal to the available space on the smaller of the two drives.
• Any Configuration—For a server configuration that carries forward the local disk configuration without
any changes.
• No RAID—For a server configuration that removes the RAID and leaves the disk MBR and payload
unaltered.
• RAID 5 Striped Parity—Data is striped across all disks in the array. Part of the capacity of each disk
stores parity information that can be used to reconstruct data if a disk fails. RAID 5 provides good data
throughput for applications with high read request rates.
• RAID 6 Striped Dual Parity—Data is striped across all disks in the array and two parity disks are used
to provide protection against the failure of up to two physical disks. In each row of data blocks, two sets
of parity data are stored.
• RAID10 Mirrored and Striped— RAID 10 uses mirrored pairs of disks to provide complete data
redundancy and high throughput rates.

You must include this policy in a service profile, and that service profile must be associated with a server for
the policy to take effect.

Management Firmware Package


This policy enables you to specify a set of firmware versions that make up the management firmware package
(also known as a management firmware pack). The management firmware package includes the Cisco Integrated
Management Controller (CIMC) on the server. You do not need to use this package if you upgrade the CIMC
directly.
The firmware package is pushed to all servers associated with service profiles that include this policy. This
policy ensures that the CIMC firmware is identical on all servers associated with service profiles which use
the same policy. Therefore, if you move the service profile from one server to another, the firmware versions
are maintained.
You must include this policy in a service profile, and that service profile must be associated with a server for
it to take effect.
This policy is not dependent upon any other policies. However, you must ensure that the appropriate firmware
has been downloaded to the fabric interconnect.

Cisco UCS Manager CLI Command Reference, Release 2.0


14 OL-25718-02
Overview of Cisco Unified Computing System
Configuration Policies

Management Interfaces Monitoring Policy


This policy defines how the mgmt0 Ethernet interface on the fabric interconnect should be monitored. If Cisco
UCS detects a management interface failure, a failure report is generated. If the configured number of failure
reports is reached, the system assumes that the management interface is unavailable and generates a fault. By
default, the management interfaces monitoring policy is disabled.
If the affected management interface belongs to a fabric interconnect which is the managing instance, Cisco
UCS confirms that the subordinate fabric interconnect's status is up, that there are no current failure reports
logged against it, and then modifies the managing instance for the end-points.
If the affected fabric interconnect is currently the primary inside of a high availability setup, a failover of the
management plane is triggered. The data plane is not affected by this failover.
You can set the following properties related to monitoring the management interface:
• Type of mechanism used to monitor the management interface.
• Interval at which the management interface's status is monitored.
• Maximum number of monitoring attempts that can fail before the system assumes that the management
is unavailable and generates a fault message.

Important In the event of a management interface failure on a fabric interconnect, the managing instance may not
change if one of the following occurs:
• A path to the end-point through the subordinate fabric interconnect does not exist.
• The management interface for the subordinate fabric interconnect has failed.
• The path to the end-point through the subordinate fabric interconnect has failed.

Network Control Policy


This policy configures the network control settings for the Cisco UCS domain, including the following:
• Whether the Cisco Discovery Protocol (CDP) is enabled or disabled
• How the VIF behaves if no uplink port is available in end-host mode
• The action that Cisco UCS Manager takes on the remote Ethernet interface, vEthernet interface , or
vFibreChannel interface when the associated border port fails
• Whether the server can use different MAC addresses when sending packets to the fabric interconnect
• Whether MAC registration occurs on a per-VNIC basis or for all VLANs.

Action on Uplink Fail


By default, the Action on Uplink Fail property in the network control policy is configured with a value of
link-down. For adapters such as the Cisco UCS M81KR Virtual Interface Card, this default behavior directs
Cisco UCS Manager to bring the vEthernet or vFibreChannel interface down if the associated border port
fails. For Cisco UCS systems using a non-VM-FEX capable converged network adapter that supports both

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 15
Overview of Cisco Unified Computing System
Configuration Policies

Ethernet and FCoE traffic, such as Cisco UCS CNA M72KR-Q and the Cisco UCS CNA M72KR-E, this
default behavior directs Cisco UCS Manager to bring the remote Ethernet interface down if the associated
border port fails. In this scenario, any vFibreChannel interfaces that are bound to the remote Ethernet interface
are brought down as well.

Note Cisco UCS Manager, release 1.4(2) and earlier did not enforce the Action on Uplink Fail property for
those types of non-VM-FEX capable converged network adapters mentioned above. If the Action on
Uplink Fail property was set to link-down, Cisco UCS Manager would ignore this setting and instead
issue a warning. In the current version of Cisco UCS Manager this setting is enforced. Therefore, if your
implementation includes one of those converged network adapters and the adapter is expected to handle
both Ethernet and FCoE traffic, we recommend that you configure the Action on Uplink Fail property
with a value of warning.
Please note that this configuration may result in an Ethernet teaming driver not being able to detect a link
failure when the border port goes down.

MAC Registration Mode


In Cisco UCS Manager, releases 1.4 and earlier, MAC addresses were installed on all of the VLANs belonging
to an interface. Starting in release 2.0, MAC addresses are installed only on the native VLAN by default. In
most implementations this maximizes the VLAN port count.

Note If a trunking driver is being run on the host and the interface is in promiscuous mode, we recommend that
you set the Mac Registration Mode to All VLANs.

Power Control Policy


Cisco UCS uses the priority set in the power control policy, along with the blade type and configuration, to
calculate the initial power allocation for each blade within a chassis. During normal operation, the active
blades within a chassis can borrow power from idle blades within the same chassis. If all blades are active
and reach the power cap, service profiles with higher priority power control policies take precedence over
service profiles with lower priority power control policies.
Priority is ranked on a scale of 1-10, where 1 indicates the highest priority and 10 indicates lowest priority.
The default priority is 5.
For mission-critical application a special priority called no-cap is also available. Setting the priority to no-cap
prevents Cisco UCS from leveraging unused power from that particular blade server. The server is allocated
the maximum amount of power that that blade can reach.

Note You must include this policy in a service profile and that service profile must be associated with a server
for it to take effect.

Cisco UCS Manager CLI Command Reference, Release 2.0


16 OL-25718-02
Overview of Cisco Unified Computing System
Configuration Policies

Power Policy
The power policy is a global policy that specifies the redundancy for power supplies in all chassis in the Cisco
UCS domain. This policy is also known as the PSU policy.
For more information about power supply redundancy, see Cisco UCS 5108 Server Chassis Hardware
Installation Guide.

Quality of Service Policy


A quality of service (QoS) policy assigns a system class to the outgoing traffic for a vNIC or vHBA. This
system class determines the quality of service for that traffic. For certain adapters you can also specify additional
controls on the outgoing traffic, such as burst and rate.
You must include a QoS policy in a vNIC policy or vHBA policy and then include that policy in a service
profile to configure the vNIC or vHBA.

Rack Server Discovery Policy


The rack server discovery policy determines how the system reacts when you add a new rack-mount server.
Cisco UCS Manager uses the settings in the rack server discovery policy to determine whether any data on
the hard disks are scrubbed and whether server discovery occurs immediately or needs to wait for explicit
user acknowledgement.
Cisco UCS Manager cannot discover any rack-mount server that has not been correctly cabled and connected
to the fabric interconnects. For information about how to integrate a supported Cisco UCS rack-mount server
with Cisco UCS Manager, see the hardware installation guide for that server.

Server Autoconfiguration Policy


Cisco UCS Manager uses this policy to determine how to configure a new server. If you create a server
autoconfiguration policy, the following occurs when a new server starts:
1 The qualification in the server autoconfiguration policy is executed against the server.
2 If the server meets the required qualifications, the server is associated with a service profile created from
the service profile template configured in the server autoconfiguration policy. The name of that service
profile is based on the name given to the server by Cisco UCS Manager.
3 The service profile is assigned to the organization configured in the server autoconfiguration policy.

Server Discovery Policy


This discovery policy determines how the system reacts when you add a new server. If you create a server
discovery policy, you can control whether the system conducts a deep discovery when a server is added to a
chassis, or whether a user must first acknowledge the new server. By default, the system conducts a full
discovery.
If you create a server discovery policy, the following occurs when a new server starts:
1 The qualification in the server discovery policy is executed against the server.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 17
Overview of Cisco Unified Computing System
Configuration Policies

2 If the server meets the required qualifications, Cisco UCS Manager applies the following to the server:
• Depending upon the option selected for the action, either discovers the new server immediately or
waits for a user to acknowledge the new server
• Applies the scrub policy to the server

Server Inheritance Policy


This policy is invoked during the server discovery process to create a service profile for the server. All service
profiles created from this policy use the values burned into the blade at manufacture. The policy performs the
following:
• Analyzes the inventory of the server
• If configured, assigns the server to the selected organization
• Creates a service profile for the server with the identity burned into the server at manufacture

You cannot migrate a service profile created with this policy to another server.

Server Pool Policy


This policy is invoked during the server discovery process. It determines what happens if server pool policy
qualifications match a server to the target pool specified in the policy.
If a server qualifies for more than one pool and those pools have server pool policies, the server is added to
all those pools.

Server Pool Policy Qualifications


This policy qualifies servers based on the inventory of a server conducted during the discovery process. The
qualifications are individual rules that you configure in the policy to determine whether a server meets the
selection criteria. For example, you can create a rule that specifies the minimum memory capacity for servers
in a data center pool.
Qualifications are used in other policies to place servers, not just by the server pool policies. For example, if
a server meets the criteria in a qualification policy, it can be added to one or more server pools or have a
service profile automatically associated with it.
You can use the server pool policy qualifications to qualify servers according to the following criteria:
• Adapter type
• Chassis location
• Memory type and configuration
• Power group
• CPU cores, type, and configuration
• Storage configuration and capacity
• Server model

Cisco UCS Manager CLI Command Reference, Release 2.0


18 OL-25718-02
Overview of Cisco Unified Computing System
Configuration Policies

Depending upon the implementation, you may configure several policies with server pool policy qualifications
including the following:
• Autoconfiguration policy
• Chassis discovery policy
• Server discovery policy
• Server inheritance policy
• Server pool policy

vHBA Template
This template is a policy that defines how a vHBA on a server connects to the SAN. It is also referred to as
a vHBA SAN connectivity template.
You need to include this policy in a service profile for it to take effect.

VM Lifecycle Policy
The VM lifecycle policy determines how long Cisco UCS Manager retains offline VMs and offline dynamic
vNICs in its database. If a VM or dynamic vNIC remains offline after that period, Cisco UCS Manager deletes
the object from its database.
All virtual machines (VMs) on Cisco UCS servers are managed by vCenter. Cisco UCS Manager cannot
determine whether an inactive VM is temporarily shutdown, has been deleted, or is in some other state that
renders it inaccessible. Therefore, Cisco UCS Manager considers all inactive VMs to be in an offline state.
Cisco UCS Manager considers a dynamic vNIC to be offline when the associated VM is shutdown, or the
link between the fabric interconnect and the I/O module fails. On rare occasions, an internal error can also
cause Cisco UCS Manager to consider a dynamic vNIC to be offline.
The default VM and dynamic vNIC retention period is 15 minutes. You can set that for any period of time
between 1 minute and 7200 minutes (or 5 days).

Note The VMs that Cisco UCS Manager displays are for information and monitoring only. You cannot manage
VMs through Cisco UCS Manager. Therefore, when you delete a VM from the Cisco UCS Manager
database, you do not delete the VM from the server or from vCenter.

vNIC Template
This policy defines how a vNIC on a server connects to the LAN. This policy is also referred to as a vNIC
LAN connectivity policy.
Beginning in Cisco UCS, Release 2.0(2), Cisco UCS Manager does not automatically create a VM-FEX port
profile with the correct settings when you create a vNIC template. If you want to create a VM-FEX port
profile, you must configure the target of the vNIC template as a VM.
You need to include this policy in a service profile for it to take effect.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 19
Overview of Cisco Unified Computing System
Operational Policies

Note If your server has two Emulex or QLogic NICs (Cisco UCS CNA M71KR-E or Cisco UCS CNA
M71KR-Q), you must configure vNIC policies for both adapters in your service profile to get a user-defined
MAC address for both NICs. If you do not configure policies for both NICs, Windows still detects both
of them in the PCI bus. Then because the second eth is not part of your service profile, Windows assigns
it a hardware MAC address. If you then move the service profile to a different server, Windows sees
additional NICs because one NIC did not have a user-defined MAC address.

vNIC/vHBA Placement Policies


vNIC/vHBA placement policies are used to determine what types of vNICs or vHBAs can be assigned to the
physical adapters on a server. Each vNIC/vHBA placement policy contains four virtual network interface
connections (vCons) that are virtual representations of the physical adapters. When a vNIC/vHBA placement
policy is assigned to a service profile, and the service profile is associated with a server, the vCons in the
vNIC/vHBA placement policy are assigned to the physical adapters.
If you do not include a vNIC/vHBA placement policy in the service profile or you use the default configuration
for a server with two adapters, Cisco UCS Manager defaults to the All configuration and equally distributes
the vNICs and vHBAs between the adapters.
You can use this policy to assign vNICs or vHBAs to either of the two vCons. Cisco UCS Manager uses the
vCon assignment to determine how to assign the vNICs and vHBAs to the physical adapter during service
profile association.
• All—All configured vNICs and vHBAs can be assigned to the vCon, whether they are explicitly assigned
to it, unassigned, or dynamic.
• Assigned Only—vNICs and vHBAs must be explicitly assigned to the vCon. You can assign them
explicitly through the service profile or the properties of the vNIC or vHBA.
• Exclude Dynamic—Dynamic vNICs and vHBAs cannot be assigned to the vCon. The vCon can be
used for all static vNICs and vHBAs, whether they are unassigned or explicitly assigned to it.
• Exclude Unassigned—Unassigned vNICs and vHBAs cannot be assigned to the vCon. The vCon can
be used for dynamic vNICs and vHBAs and for static vNICs and vHBAs that are explicitly assigned to
it.

Operational Policies

Fault Collection Policy


The fault collection policy controls the lifecycle of a fault in a Cisco UCS domain, including when faults are
cleared, the flapping interval (the length of time between the fault being raised and the condition being cleared),
and the retention interval (the length of time a fault is retained in the system).

Cisco UCS Manager CLI Command Reference, Release 2.0


20 OL-25718-02
Overview of Cisco Unified Computing System
Operational Policies

Flow Control Policy


Flow control policies determine whether the uplink Ethernet ports in a Cisco UCS domain send and receive
IEEE 802.3x pause frames when the receive buffer for a port fills. These pause frames request that the
transmitting port stop sending data for a few milliseconds until the buffer clears.
For flow control to work between a LAN port and an uplink Ethernet port, you must enable the corresponding
receive and send flow control parameters for both ports. For Cisco UCS, the flow control policies configure
these parameters.
When you enable the send function, the uplink Ethernet port sends a pause request to the network port if the
incoming packet rate becomes too high. The pause remains in effect for a few milliseconds before traffic is
reset to normal levels. If you enable the receive function, the uplink Ethernet port honors all pause requests
from the network port. All traffic is halted on that uplink port until the network port cancels the pause request.
Because you assign the flow control policy to the port, changes to the policy have an immediate effect on how
the port reacts to a pause frame or a full receive buffer.

Maintenance Policy
A maintenance policy determines how Cisco UCS Manager reacts when a change that requires a server reboot
is made to a service profile associated with a server or to an updating service profile bound to one or more
service profiles.
The maintenance policy specifies how Cisco UCS Manager deploys the service profile changes. The deployment
can occur in one of the following ways:
• Immediately
• When acknowledged by a user with admin privileges
• Automatically at the time specified in the schedule

If the maintenance policy is configured to deploy the change during a scheduled maintenance window, the
policy must include a valid schedule. The schedule deploys the changes in the first available maintenance
window.

Scrub Policy
This policy determines what happens to local data and to the BIOS settings on a server during the discovery
process and when the server is disassociated from a service profile. Depending upon how you configure a
scrub policy, the following can occur at those times:
Disk Scrub
One of the following occurs to the data on any local drives on disassociation:
• If enabled, destroys all data on any local drives
• If disabled, preserves all data on any local drives, including local storage configuration

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 21
Overview of Cisco Unified Computing System
Operational Policies

BIOS Settings Scrub


One of the following occurs to the BIOS settings when a service profile containing the scrub policy is
disassociated from a server:
• If enabled, erases all BIOS settings for the server and and resets them to the BIOS defaults for
that server type and vendor
• If disabled, preserves the existing BIOS settings on the server

Serial over LAN Policy


This policy sets the configuration for the serial over LAN connection for all servers associated with service
profiles that use the policy. By default, the serial over LAN connection is disabled.
If you implement a serial over LAN policy, we recommend that you also create an IPMI profile.
You must include this policy in a service profile and that service profile must be associated with a server for
it to take effect.

Statistics Collection Policy


A statistics collection policy defines how frequently statistics are to be collected (collection interval) and how
frequently the statistics are to be reported (reporting interval). Reporting intervals are longer than collection
intervals so that multiple statistical data points can be collected during the reporting interval, which provides
Cisco UCS Manager with sufficient data to calculate and report minimum, maximum, and average values.
For NIC statistics, Cisco UCS Manager displays the average, minimum, and maximum of the change since
the last collection of statistics. If the values are 0, there has been no change since the last collection.
Statistics can be collected and reported for the following five functional areas of the Cisco UCS system:
• Adapter—statistics related to the adapters
• Chassis—statistics related to the blade chassis
• Host—this policy is a placeholder for future support
• Port—statistics related to the ports, including server ports, uplink Ethernet ports, and uplink Fibre
Channel ports
• Server—statistics related to servers

Note Cisco UCS Manager has one default statistics collection policy for each of the five functional areas. You
cannot create additional statistics collection policies and you cannot delete the existing default policies.
You can only modify the default policies.

Statistics Threshold Policy


A statistics threshold policy monitors statistics about certain aspects of the system and generates an event if
the threshold is crossed. You can set both minimum and maximum thresholds. For example, you can configure

Cisco UCS Manager CLI Command Reference, Release 2.0


22 OL-25718-02
Overview of Cisco Unified Computing System
Pools

the policy to raise an alarm if the CPU temperature exceeds a certain value, or if a server is overutilized or
underutilized.
These threshold policies do not control the hardware or device-level thresholds enforced by endpoints, such
as the CIMC. Those thresholds are burned in to the hardware components at manufacture.
Cisco UCS enables you to configure statistics threshold policies for the following components:
• Servers and server components
• Uplink Ethernet ports
• Ethernet server ports, chassis, and fabric interconnects
• Fibre Channel port

Note You cannot create or delete a statistics threshold policy for Ethernet server ports, uplink Ethernet ports,
or uplink Fibre Channel ports. You can only configure the existing default policy.

Pools
Pools are collections of identities, or physical or logical resources, that are available in the system. All pools
increase the flexibility of service profiles and allow you to centrally manage your system resources.
You can use pools to segment unconfigured servers or available ranges of server identity information into
groupings that make sense for the data center. For example, if you create a pool of unconfigured servers with
similar characteristics and include that pool in a service profile, you can use a policy to associate that service
profile with an available, unconfigured server.
If you pool identifying information, such as MAC addresses, you can pre-assign ranges for servers that will
host specific applications. For example, all database servers could be configured within the same range of
MAC addresses, UUIDs, and WWNs.

Server Pools
A server pool contains a set of servers. These servers typically share the same characteristics. Those
characteristics can be their location in the chassis, or an attribute such as server type, amount of memory,
local storage, type of CPU, or local drive configuration. You can manually assign a server to a server pool,
or use server pool policies and server pool policy qualifications to automate the assignment.
If your system implements multi-tenancy through organizations, you can designate one or more server pools
to be used by a specific organization. For example, a pool that includes all servers with two CPUs could be
assigned to the Marketing organization, while all servers with 64 GB memory could be assigned to the Finance
organization.
A server pool can include servers from any chassis in the system. A given server can belong to multiple server
pools.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 23
Overview of Cisco Unified Computing System
Pools

MAC Pools
A MAC pool is a collection of network identities, or MAC addresses, that are unique in their layer 2
environment and are available to be assigned to vNICs on a server. If you use MAC pools in service profiles,
you do not have to manually configure the MAC addresses to be used by the server associated with the service
profile.
In a system that implements multi-tenancy, you can use the organizational hierarchy to ensure that MAC pools
can only be used by specific applications or business services. Cisco UCS Manager uses the name resolution
policy to assign MAC addresses from the pool.
To assign a MAC address to a server, you must include the MAC pool in a vNIC policy. The vNIC policy is
then included in the service profile assigned to that server.
You can specify your own MAC addresses or use a group of MAC addresses provided by Cisco.

UUID Suffix Pools


A UUID suffix pool is a collection of SMBIOS UUIDs that are available to be assigned to servers. The first
number of digits that constitute the prefix of the UUID are fixed. The remaining digits, the UUID suffix, are
variable. A UUID suffix pool ensures that these variable values are unique for each server associated with a
service profile which uses that particular pool to avoid conflicts.
If you use UUID suffix pools in service profiles, you do not have to manually configure the UUID of the
server associated with the service profile.

WWN Pools
A WWN pool is a collection of WWNs for use by the Fibre Channel vHBAs in a Cisco UCS domain. You
create separate pools for the following:
• WW node names assigned to the server
• WW port names assigned to the vHBA

Important A WWN pool can include only WWNNs or WWPNs in the ranges from 20:00:00:00:00:00:00:00 to
20:FF:FF:FF:FF:FF:FF:FF or from 50:00:00:00:00:00:00:00 to 5F:FF:FF:FF:FF:FF:FF:FF. All other
WWN ranges are reserved. To ensure the uniqueness of the Cisco UCS WWNNs and WWPNs in the SAN
fabric, we recommend that you use the following WWN prefix for all blocks in a pool:
20:00:00:25:B5:XX:XX:XX

If you use WWN pools in service profiles, you do not have to manually configure the WWNs that will be
used by the server associated with the service profile. In a system that implements multi-tenancy, you can use
a WWN pool to control the WWNs used by each organization.
You assign WWNs to pools in blocks. For each block or individual WWN, you can assign a boot target.

WWNN Pools
A WWNN pool is a WWN pool that contains only WW node names. If you include a pool of WWNNs in a
service profile, the associated server is assigned a WWNN from that pool.

Cisco UCS Manager CLI Command Reference, Release 2.0


24 OL-25718-02
Overview of Cisco Unified Computing System
Traffic Management

WWPN Pools
A WWPN pool is a WWN pool that contains only WW port names. If you include a pool of WWPNs in a
service profile, the port on each vHBA of the associated server is assigned a WWPN from that pool.

Management IP Pool
The management IP pool is a collection of external IP addresses. Cisco UCS Manager reserves each block of
IP addresses in the management IP pool for external access that terminates in the CIMC on a server.
You can configure service profiles and service profile templates to use IP addresses from the management IP
pool. You cannot configure servers to use the management IP pool.
All IP addresses in the management IP pool must be in the same subnet as the IP address of the fabric
interconnect.

Note The management IP pool must not contain any IP addresses that have been assigned as static IP addresses
for a server or service profile.

Traffic Management

Oversubscription
Oversubscription occurs when multiple network devices are connected to the same fabric interconnect port.
This practice optimizes fabric interconnect use, since ports rarely run at maximum speed for any length of
time. As a result, when configured correctly, oversubscription allows you to take advantage of unused
bandwidth. However, incorrectly configured oversubscription can result in contention for bandwidth and a
lower quality of service to all services that use the oversubscribed port.
For example, oversubscription can occur if four servers share a single uplink port, and all four servers attempt
to send data at a cumulative rate higher than available bandwidth of uplink port.

Oversubscription Considerations
The following elements can impact how you configure oversubscription in a Cisco UCS domain:

Ratio of Server-Facing Ports to Uplink Ports


You need to know what how many server-facing ports and uplink ports are in the system, because that ratio
can impact performance. For example, if your system has twenty ports that can communicate down to the
servers and only two ports that can communicate up to the network, your uplink ports will be oversubscribed.
In this situation, the amount of traffic created by the servers can also affect performance.

Number of Uplink Ports from Fabric Interconnect to Network


You can choose to add more uplink ports between the Cisco UCS fabric interconnect and the upper layers of
the LAN to increase bandwidth. In Cisco UCS, you must have at least one uplink port per fabric interconnect

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 25
Overview of Cisco Unified Computing System
Oversubscription

to ensure that all servers and NICs to have access to the LAN. The number of LAN uplinks should be determined
by the aggregate bandwidth needed by all Cisco UCS servers.
For the 6100 series fabric interconnects, Fibre Channel uplink ports are available on the expansion slots only.
You must add more expansion slots to increase number of available Fibre Channel uplinks. Ethernet uplink
ports can exist on the fixed slot and on expansion slots.
For the 6200 series fabric interconnects running Cisco UCS Manager, version 2.0 and higher, Ethernet uplink
ports and Fibre Channel uplink ports are both configurable on the base module, as well as on the expansion
module.
For example, if you have two Cisco UCS 5100 series chassis that are fully populated with half width Cisco
UCS B200-M1 servers, you have 16 servers. In a cluster configuration, with one LAN uplink per fabric
interconnect, these 16 servers share 20GbE of LAN bandwidth. If more capacity is needed, more uplinks from
the fabric interconnect should be added. We recommend that you have symmetric configuration of the uplink
in cluster configurations. In the same example, if 4 uplinks are used in each fabric interconnect, the 16 servers
are sharing 80 GB of bandwidth, so each has approximately 5 GB of capacity. When multiple uplinks are
used on a Cisco UCS fabric interconnect the network design team should consider using a port channel to
make best use of the capacity.

Number of Uplink Ports from I/O Module to Fabric Interconnect


You can choose to add more bandwidth between I/O module and fabric interconnect by using more uplink
ports and increasing the number of cables. In Cisco UCS, you can have one, two, or four cables connecting
a I/O module to a Cisco UCS 6100 series fabric interconnect. You can have up to eight cables if you're
connecting a 2208 I/O module and a 6248 fabric interconnect. The number of cables determines the number
of active uplink ports and the oversubscription ratio.

Number of Active Links from Server to Fabric Interconnect


The amount of non-oversubscribed bandwidth available to each server depends on the number of I/O modules
used and the number of cables used to connect those I/O modules to the fabric interconnects. Having a second
I/O module in place provides additional bandwidth and redundancy to the servers. This level of flexibility in
design ensures that you can provide anywhere from 80 Gbps (two I/O modules with four links each) to 10
Gbps (one I/O module with one link) to the chassis.
With 80 Gbps to the chassis, each half-width server in the Cisco UCS domain can get up to 10 Gbps in a
non-oversubscribed configuration, with an ability to use up to 20 Gbps with 2:1 oversubscription.

Guidelines for Estimating Oversubscription


When you estimate the optimal oversubscription ratio for a fabric interconnect port, consider the following
guidelines:

Cost/Performance Slider
The prioritization of cost and performance is different for each data center and has a direct impact on the
configuration of oversubscription. When you plan hardware usage for oversubscription, you need to know
where the data center is located on this slider. For example, oversubscription can be minimized if the data
center is more concerned with performance than cost. However, cost is a significant factor in most data centers,
and oversubscription requires careful planning.

Cisco UCS Manager CLI Command Reference, Release 2.0


26 OL-25718-02
Overview of Cisco Unified Computing System
Pinning

Bandwidth Usage
The estimated bandwidth that you expect each server to actually use is important when you determine the
assignment of each server to a fabric interconnect port and, as a result, the oversubscription ratio of the ports.
For oversubscription, you must consider how many GBs of traffic the server will consume on average, the
ratio of configured bandwidth to used bandwidth, and the times when high bandwidth use will occur.

Network Type
The network type is only relevant to traffic on uplink ports, because FCoE does not exist outside Cisco UCS.
The rest of the data center network only differentiates between LAN and SAN traffic. Therefore, you do not
need to take the network type into consideration when you estimate oversubscription of a fabric interconnect
port.

Pinning
Pinning in Cisco UCS is only relevant to uplink ports. You can pin Ethernet or FCoE traffic from a given
server to a specific uplink Ethernet port or uplink FC port.
When you pin the NIC and HBA of both physical and virtual servers to uplink ports, you give the fabric
interconnect greater control over the unified fabric. This control ensures more optimal utilization of uplink
port bandwidth.
Cisco UCS uses pin groups to manage which NICs, vNICs, HBAs, and vHBAs are pinned to an uplink port.
To configure pinning for a server, you can either assign a pin group directly, or include a pin group in a vNIC
policy, and then add that vNIC policy to the service profile assigned to that server. All traffic from the vNIC
or vHBA on the server travels through the I/O module to the same uplink port.

Pinning Server Traffic to Server Ports


All server traffic travels through the I/O module to server ports on the fabric interconnect. The number of
links for which the chassis is configured determines how this traffic is pinned.
The pinning determines which server traffic goes to which server port on the fabric interconnect. This pinning
is fixed. You cannot modify it. As a result, you must consider the server location when you determine the
appropriate allocation of bandwidth for a chassis.

Note You must review the allocation of ports to links before you allocate servers to slots. The cabled ports are
not necessarily port 1 and port 2 on the I/O module. If you change the number of links between the fabric
interconnect and the I/O module, you must reacknowledge the chassis to have the traffic rerouted.

All port numbers refer to the fabric interconnect-side ports on the I/O module.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 27
Overview of Cisco Unified Computing System
Pinning

Chassis with One I/O Module (Not Configured for Fabric Port Channels)

Note If the adapter in a server supports and is configured for adapter port channels, those port channels are
pinned to the same link as described in the following table. If the I/O module in the chassis supports and
is configured for fabric port channels, the server slots are pinned to a fabric port channel rather than to an
individual link.

Links on Link 1 / Link 2 Link 3 Link 4 Link 5 Link 6 Link 7 Link 8


Chassis Fabric
Port
Channel
1 link All server None None None None None None None
slots

2 links Server Server None None None None None None


slots 1, 3, slots 2, 4,
5, and 7 6, and 8

4 links Server Server Server Server None None None None


slots 1 and slots 2 and slots 3 and slots 4 and
5 6 7 8

8 links Server Server Server Server Server Server Server Server


slot 1 slot 2 slot 3 slot 4 slot 5 slot 6 slot 7 slot 8

Fabric All server N/A N/A N/A N/A N/A N/A N/A
Port slots
Channel

Chassis with Two I/O Modules


If a chassis has two I/O modules, traffic from one I/O module goes to one of the fabric interconnects and
traffic from the other I/O module goes to the second fabric interconnect. You cannot connect two I/O modules
to a single fabric interconnect.

Fabric Interconnect Configured in vNIC Server Traffic Path


A Server traffic goes to fabric interconnect A. If A fails, the server
traffic does not fail over to B.

B All server traffic goes to fabric interconnect B. If B fails, the


server traffic does not fail over to A.

A-B All server traffic goes to fabric interconnect A. If A fails, the


server traffic fails over to B.

B-A All server traffic goes to fabric interconnect B. If B fails, the


server traffic fails over to A.

Cisco UCS Manager CLI Command Reference, Release 2.0


28 OL-25718-02
Overview of Cisco Unified Computing System
Quality of Service

Guidelines for Pinning


When you determine the optimal configuration for pin groups and pinning for an uplink port, consider the
estimated bandwidth usage for the servers. If you know that some servers in the system will use a lot of
bandwidth, ensure that you pin these servers to different uplink ports.

Quality of Service
Cisco UCS provides the following methods to implement quality of service:
• System classes that specify the global configuration for certain types of traffic across the entire system
• QoS policies that assign system classes for individual vNICs
• Flow control policies that determine how uplink Ethernet ports handle pause frames

System Classes
Cisco UCS uses Data Center Ethernet (DCE) to handle all traffic inside a Cisco UCS domain. This industry
standard enhancement to Ethernet divides the bandwidth of the Ethernet pipe into eight virtual lanes. Two
virtual lanes are reserved for internal system and management traffic. You can configure quality of service
for the other six virtual lanes. System classes determine how the DCE bandwidth in these six virtual lanes is
allocated across the entire Cisco UCS domain.
Each system class reserves a specific segment of the bandwidth for a specific type of traffic. This provides a
level of traffic management, even in an oversubscribed system. For example, you can configure the Fibre
Channel Priority system class to determine the percentage of DCE bandwidth allocated to FCoE traffic.
The following table describes the system classes that you can configure:

Table 2: System Classes

System Class Description


Platinum A configurable set of system classes that you can include in the QoS policy
Gold for a service profile. Each system class manages one lane of traffic.
All properties of these system classes are available for you to assign custom
Silver
settings and policies.
Bronze

Best Effort A system class that sets the quality of service for the lane reserved for Basic
Ethernet traffic.
Some properties of this system class are preset and cannot be modified. For
example, this class has a drop policy that allows it to drop data packets if
required. You cannot disable this system class.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 29
Overview of Cisco Unified Computing System
Opt-In Features

System Class Description


Fibre Channel A system class that sets the quality of service for the lane reserved for Fibre
Channel over Ethernet traffic.
Some properties of this system class are preset and cannot be modified. For
example, this class has a no-drop policy that ensures it never drops data packets.
You cannot disable this system class.

Quality of Service Policy


A quality of service (QoS) policy assigns a system class to the outgoing traffic for a vNIC or vHBA. This
system class determines the quality of service for that traffic. For certain adapters you can also specify additional
controls on the outgoing traffic, such as burst and rate.
You must include a QoS policy in a vNIC policy or vHBA policy and then include that policy in a service
profile to configure the vNIC or vHBA.

Flow Control Policy


Flow control policies determine whether the uplink Ethernet ports in a Cisco UCS domain send and receive
IEEE 802.3x pause frames when the receive buffer for a port fills. These pause frames request that the
transmitting port stop sending data for a few milliseconds until the buffer clears.
For flow control to work between a LAN port and an uplink Ethernet port, you must enable the corresponding
receive and send flow control parameters for both ports. For Cisco UCS, the flow control policies configure
these parameters.
When you enable the send function, the uplink Ethernet port sends a pause request to the network port if the
incoming packet rate becomes too high. The pause remains in effect for a few milliseconds before traffic is
reset to normal levels. If you enable the receive function, the uplink Ethernet port honors all pause requests
from the network port. All traffic is halted on that uplink port until the network port cancels the pause request.
Because you assign the flow control policy to the port, changes to the policy have an immediate effect on how
the port reacts to a pause frame or a full receive buffer.

Opt-In Features
Each Cisco UCS domain is licensed for all functionality. Depending upon how the system is configured, you
can decide to opt in to some features or opt out of them for easier integration into existing environment. If a
process change happens, you can change your system configuration and include one or both of the opt-in
features.
The opt-in features are as follows:
• Stateless computing, which takes advantage of mobile service profiles with pools and policies where
each component, such as a server or an adapter, is stateless.
• Multi-tenancy, which uses organizations and role-based access control to divide the system into smaller
logical segments.

Cisco UCS Manager CLI Command Reference, Release 2.0


30 OL-25718-02
Overview of Cisco Unified Computing System
Stateless Computing

Stateless Computing
Stateless computing allows you to use a service profile to apply the personality of one server to a different
server in the same Cisco UCS domain. The personality of the server includes the elements that identify that
server and make it unique in the Cisco UCS domain. If you change any of these elements, the server could
lose its ability to access, use, or even achieve booted status.
The elements that make up a server's personality include the following:
• Firmware versions
• UUID (used for server identification)
• MAC address (used for LAN connectivity)
• World Wide Names (used for SAN connectivity)
• Boot settings

Stateless computing creates a dynamic server environment with highly flexible servers. Every physical server
in a Cisco UCS domain remains anonymous until you associate a service profile with it, then the server gets
the identity configured in the service profile. If you no longer need a business service on that server, you can
shut it down, disassociate the service profile, and then associate another service profile to create a different
identity for the same physical server. The "new" server can then host another business service.
To take full advantage of the flexibility of statelessness, the optional local disks on the servers should only
be used for swap or temp space and not to store operating system or application data.
You can choose to fully implement stateless computing for all physical servers in a Cisco UCS domain, to
not have any stateless servers, or to have a mix of the two types.

If You Opt In to Stateless Computing


Each physical server in the Cisco UCS domain is defined through a service profile. Any server can be used
to host one set of applications, then reassigned to another set of applications or business services, if required
by the needs of the data center.
You create service profiles that point to policies and pools of resources that are defined in the Cisco UCS
domain. The server pools, WWN pools, and MAC pools ensure that all unassigned resources are available
on an as-needed basis. For example, if a physical server fails, you can immediately assign the service profile
to another server. Because the service profile provides the new server with the same identity as the original
server, including WWN and MAC address, the rest of the data center infrastructure sees it as the same server
and you do not need to make any configuration changes in the LAN or SAN.

If You Opt Out of Stateless Computing


Each server in the Cisco UCS domain is treated as a traditional rack mount server.
You create service profiles that inherit the identify information burned into the hardware and use these profiles
to configure LAN or SAN connectivity for the server. However, if the server hardware fails, you cannot
reassign the service profile to a new server.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 31
Overview of Cisco Unified Computing System
Multi-Tenancy

Multi-Tenancy
Multi-tenancy allows you to divide up the large physical infrastructure of an Cisco UCS domain into logical
entities known as organizations. As a result, you can achieve a logical isolation between organizations without
providing a dedicated physical infrastructure for each organization.
You can assign unique resources to each tenant through the related organization, in the multi-tenant
environment. These resources can include different policies, pools, and quality of service definitions. You
can also implement locales to assign or restrict user privileges and roles by organization, if you do not want
all users to have access to all organizations.
If you set up a multi-tenant environment, all organizations are hierarchical. The top-level organization is
always root. The policies and pools that you create in root are system-wide and are available to all organizations
in the system. However, any policies and pools created in other organizations are only available to organizations
that are above it in the same hierarchy. For example, if a system has organizations named Finance and HR
that are not in the same hierarchy, Finance cannot use any policies in the HR organization, and HR cannot
access any policies in the Finance organization. However, both Finance and HR can use policies and pools
in the root organization.
If you create organizations in a multi-tenant environment, you can also set up one or more of the following
for each organization or for a sub-organization in the same hierarchy:
• Resource pools
• Policies
• Service profiles
• Service profile templates

If You Opt In to Multi-Tenancy


Each Cisco UCS domain is divided into several distinct organizations. The types of organizations you create
in a multi-tenancy implementation depends upon the business needs of the company. Examples include
organizations that represent the following:
• Enterprise groups or divisions within a company, such as marketing, finance, engineering, or human
resources
• Different customers or name service domains, for service providers

You can create locales to ensure that users have access only to those organizations that they are authorized
to administer.

If You Opt Out of Multi-Tenancy


The Cisco UCS domain remains a single logical entity with everything in the root organization. All policies
and resource pools can be assigned to any server in the Cisco UCS domain.

Cisco UCS Manager CLI Command Reference, Release 2.0


32 OL-25718-02
Overview of Cisco Unified Computing System
Virtualization in Cisco UCS

Virtualization in Cisco UCS

Overview of Virtualization
Virtualization allows the creation of multiple virtual machines (VMs) to run in isolation, side by side on the
same physical machine.
Each virtual machine has its own set of virtual hardware (RAM, CPU, NIC) upon which an operating system
and fully configured applications are loaded. The operating system sees a consistent, normalized set of hardware
regardless of the actual physical hardware components.
In a virtual machine, both hardware and software are encapsulated in a single file for rapid copying,
provisioning, and moving between physical servers. You can move a virtual machine, within seconds, from
one physical server to another for zero-downtime maintenance and continuous workload consolidation.
The virtual hardware makes it possible for many servers, each running in an independent virtual machine, to
run on a single physical server. The advantages of virtualization include better use of computing resources,
greater server density, and seamless server migration.

Overview of Cisco Virtual Machine Fabric Extender


A virtualized server implementation consists of one or more VMs running as 'guests' on a single physical
server. The guest VMs are hosted and managed by a software layer called the hypervisor or virtual machine
manager (VMM). The hypervisor typically presents a virtual network interface to each VM and performs
Layer 2 switching of traffic from a VM to other local VMs or to a physical interface to the external network.
Working with a Cisco virtual interface card (VIC) adapter, Cisco Virtual Machine Fabric Extender (VM-FEX)
bypasses software-based switching of VM traffic by the hypervisor in favor of external hardware-based
switching in the fabric interconnect. This method results in a reduced load on the server CPU, faster switching,
and the ability to apply a rich set of network management features to local and remote traffic.
VM-FEX extends the (prestandard) IEEE 802.1Qbh port extender architecture to the VMs, providing each
VM interface with a virtual Peripheral Component Interconnect Express (PCIe) device and a virtual port on
a switch. This solution allows precise rate limiting and quality of service (QoS) guarantees on the VM interface.

Virtualization with Network Interface Cards and Converged Network Adapters


Network interface card (NIC) and converged network adapters support virtualized environments with the
standard VMware integration with ESX installed on the server and all virtual machine management performed
through the VC.

Portability of Virtual Machines


If you implement service profiles you retain the ability to easily move a server identity from one server to
another. After you image the new server, the ESX treats that server as if it were the original.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 33
Overview of Cisco Unified Computing System
Virtualization with a Virtual Interface Card Adapter

Communication between Virtual Machines on the Same Server


These adapters implement the standard communications between virtual machines on the same server. If an
ESX host includes multiple virtual machines, all communications must go through the virtual switch on the
server.
If the system uses the native VMware drivers, the virtual switch is out of the network administrator's domain
and is not subject to any network policies. As a result, for example, QoS policies on the network are not
applied to any data packets traveling from VM1 to VM2 through the virtual switch.
If the system includes another virtual switch, such as the Nexus 1000, that virtual switch is subject to the
network policies configured on that switch by the network administrator.

Virtualization with a Virtual Interface Card Adapter


A Cisco VIC adapter, such as the Cisco UCS M81KR Virtual Interface Card, is a converged network adapter
(CNA) designed for both single-OS and VM-based deployments. The VIC adapter supports static or dynamic
virtualized interfaces, including up to 128 virtual network interface cards (vNICs).
VIC adapters support VM-FEX to provide hardware-based switching of traffic to and from virtual machine
interfaces.

Cisco UCS Manager CLI Command Reference, Release 2.0


34 OL-25718-02
Overview of Cisco UCS Manager
This chapter includes the following sections:

• About Cisco UCS Manager , page 35


• Tasks You Can Perform in Cisco UCS Manager , page 36
• Tasks You Cannot Perform in Cisco UCS Manager , page 38
• Cisco UCS Manager in a High Availability Environment, page 38

About Cisco UCS Manager


Cisco UCS Manager is the management system for all components in a UCS Manager. Cisco UCS Manager
runs within the fabric interconnect. You can use any of the interfaces available with this management service
to access, configure, administer, and monitor the network and server resources for all chassis connected to
the fabric interconnect.

Multiple Management Interfaces


Cisco UCS Manager includes the following interfaces you can use to manage a Cisco UCS domain:
• Cisco UCS Manager GUI
• Cisco UCS Manager CLI
• XML API
• KVM
• IPMI

Almost all tasks can be performed in any of the interfaces, and the results of tasks performed in one interface
are automatically displayed in another.
However, you cannot do the following:
• Use Cisco UCS Manager GUI to invoke Cisco UCS Manager CLI.
• View the results of a command invoked through Cisco UCS Manager CLI in Cisco UCS Manager GUI.
• Generate CLI output from Cisco UCS Manager GUI.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 35
Overview of Cisco UCS Manager
Tasks You Can Perform in Cisco UCS Manager

Centralized Management
Cisco UCS Manager centralizes the management of resources and devices, rather than using multiple
management points. This centralized management includes management of the following devices in a Cisco
UCS domain:
• Fabric interconnects.
• Software switches for virtual servers.
• Power and environmental management for chassis and servers.
• Configuration and firmware updates for server network interfaces (Ethernet NICs and converged network
adapters).
• Firmware and BIOS settings for servers.

Support for Virtual and Physical Servers


Cisco UCS Manager abstracts server state information—including server identity, I/O configuration, MAC
addresses and World Wide Names, firmware revision, and network profiles—into a service profile. You can
apply the service profile to any server resource in the system, providing the same flexibility and support to
physical servers, virtual servers, and virtual machines connected to a virtual device provided by a VIC adapter.

Role-Based Administration and Multi-Tenancy Support


Cisco UCS Manager supports flexibly defined roles so that data centers can use the same best practices with
which they manage discrete servers, storage, and networks to operate a Cisco UCS domain. You can create
user roles with privileges that reflect user responsibilities in the data center. For example, you can create the
following:
• Server administrator roles with control over server-related configurations.
• Storage administrator roles with control over tasks related to the SAN.
• Network administrator roles with control over tasks related to the LAN.

Cisco UCS is multi-tenancy ready, exposing primitives that allow systems management software using the
API to get controlled access to Cisco UCS resources. In a multi-tenancy environment, Cisco UCS Manager
enables you to create locales for user roles that can limit the scope of a user to a particular organization.

Tasks You Can Perform in Cisco UCS Manager


You can use Cisco UCS Manager to perform management tasks for all physical and virtual devices within a
Cisco UCS domain.

Cisco UCS Hardware Management


You can use Cisco UCS Manager to manage all hardware within a Cisco UCS domain, including the following:
• Chassis
• Servers
• Fabric interconnects
• Fans

Cisco UCS Manager CLI Command Reference, Release 2.0


36 OL-25718-02
Overview of Cisco UCS Manager
Tasks You Can Perform in Cisco UCS Manager

• Ports
• Interface cards
• I/O modules

Cisco UCS Resource Management


You can use Cisco UCS Manager to create and manage all resources within a Cisco UCS domain, including
the following:
• Servers
• WWN addresses
• MAC addresses
• UUIDs
• Bandwidth

Server Administration
A server administrator can use Cisco UCS Manager to perform server management tasks within a Cisco UCS
domain, including the following:
• Create server pools and policies related to those pools, such as qualification policies
• Create policies for the servers, such as discovery policies, scrub policies, and IPMI policies
• Create service profiles and, if desired, service profile templates
• Apply service profiles to servers
• Monitor faults, alarms, and the status of equipment

Network Administration
A network administrator can use Cisco UCS Manager to perform tasks required to create LAN configuration
for a Cisco UCS domain, including the following:
• Configure uplink ports, port channels, and LAN PIN groups
• Create VLANs
• Configure the quality of service classes and definitions
• Create the pools and policies related to network configuration, such as MAC address pools and Ethernet
adapter profiles

Storage Administration
A storage administrator can use Cisco UCS Manager to perform tasks required to create SAN configuration
for a Cisco UCS domain, including the following:
• Configure ports, port channels, and SAN PIN groups
• Create VSANs
• Configure the quality of service classes and definitions

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 37
Overview of Cisco UCS Manager
Tasks You Cannot Perform in Cisco UCS Manager

• Create the pools and policies related to the network configuration, such as WWN pools and Fibre Channel
adapter profiles

Tasks You Cannot Perform in Cisco UCS Manager


You cannot use Cisco UCS Manager to perform certain system management tasks that are not specifically
related to device management within a Cisco UCS domain.

No Cross-System Management
You cannot use Cisco UCS Manager to manage systems or devices that are outside the Cisco UCS domain
where Cisco UCS Manager is located. For example, you cannot manage heterogeneous environments, such
as non-Cisco UCS x86 systems, SPARC systems, or PowerPC systems.

No Operating System or Application Provisioning or Management


Cisco UCS Manager provisions servers and, as a result, exists below the operating system on a server. Therefore,
you cannot use it to provision or manage operating systems or applications on servers. For example, you
cannot do the following:
• Deploy an OS, such as Windows or Linux
• Deploy patches for software, such as an OS or an application
• Install base software components, such as anti-virus software, monitoring agents, or backup clients
• Install software applications, such as databases, application server software, or web servers
• Perform operator actions, including restarting an Oracle database, restarting printer queues, or handling
non-Cisco UCS user accounts
• Configure or manage external storage on the SAN or NAS storage

Cisco UCS Manager in a High Availability Environment


In a high availability environment with two fabric interconnects, you can run a separate instance of Cisco
UCS Manager on each fabric interconnect. The Cisco UCS Manager on the primary fabric interconnect acts
as the primary management instance, and the Cisco UCS Manager on the other fabric interconnect is the
subordinate management instance.
The two instances of Cisco UCS Manager communicate across a private network between the L1 and L2
Ethernet ports on the fabric interconnects. Configuration and status information is communicated across this
private network to ensure that all management information is replicated. This ongoing communication ensures
that the management information for Cisco UCS persists even if the primary fabric interconnect fails. In
addition, the "floating" management IP address that runs on the primary Cisco UCS Manager ensures a smooth
transition in the event of a failover to the subordinate fabric interconnect.

Cisco UCS Manager CLI Command Reference, Release 2.0


38 OL-25718-02
Overview of Cisco UCS Manager CLI
This chapter includes the following sections:

• Managed Objects, page 39


• Command Modes, page 39
• Object Commands, page 41
• Complete a Command, page 42
• Command History, page 42
• Committing, Discarding, and Viewing Pending Commands, page 43
• Online Help for the CLI, page 43
• CLI Session Limits, page 43
• Web Session Limits, page 43
• Pre-Login Banner, page 44

Managed Objects
Cisco UCS uses a managed object model, where managed objects are abstract representations of physical or
logical entities that can be managed. For example, servers, chassis, I/O cards, and processors are physical
entities represented as managed objects, and resource pools, user roles, service profiles, and policies are logical
entities represented as managed objects.
Managed objects may have one or more associated properties that can be configured.

Command Modes
The CLI is organized into a hierarchy of command modes, with the EXEC mode being the highest-level mode
of the hierarchy. Higher-level modes branch into lower-level modes. You use create, enter, and scope
commands to move from higher-level modes to modes in the next lower level , and you use the exit command
to move up one level in the mode hierarchy.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 39
Overview of Cisco UCS Manager CLI
Command Modes

Note Most command modes are associated with managed objects, so you must create an object before you can
access the mode associated with that object. You use create and enter commands to create managed
objects for the modes being accessed. The scope commands do not create managed objects and can only
access modes for which managed objects already exist.

Each mode contains a set of commands that can be entered in that mode. Most of the commands available in
each mode pertain to the associated managed object. Depending on your assigned role and locale, you may
have access to only a subset of the commands available in a mode; commands to which you do not have access
are hidden.
The CLI prompt for each mode shows the full path down the mode hierarchy to the current mode. This helps
you to determine where you are in the command mode hierarchy, and it can be an invaluable tool when you
need to navigate through the hierarchy.
The following table lists the main command modes, the commands used to access each mode, and the CLI
prompt associated with each mode.

Table 3: Main Command Modes and Prompts

Mode Name Commands Used to Access Mode Prompt


EXEC top command from any mode #

adapter scope adapter command from /adapter #


EXEC mode

chassis scope chassis command from /chassis #


EXEC mode

Ethernet server scope eth-server command from /eth-server #


EXEC mode

Ethernet uplink scope eth-uplink command from /eth-uplink #


EXEC mode

fabric-interconnect scope fabric-interconnect /fabric-interconnect #


command from EXEC mode

Fibre Channel uplink scope fc-uplink command from /fc-uplink #


EXEC mode

firmware scope firmware command from /firmware #


EXEC mode

Host Ethernet interface scope host-eth-if command from /host-eth-if #


EXEC mode

Host Fibre Channel interface scope host-fc-if command from /host-fc-if #


EXEC mode

Cisco UCS Manager CLI Command Reference, Release 2.0


40 OL-25718-02
Overview of Cisco UCS Manager CLI
Object Commands

Mode Name Commands Used to Access Mode Prompt


monitoring scope monitoring command from /monitoring #
EXEC mode

organization scope org command from EXEC /org #


mode

security scope security command from /security #


EXEC mode

server scope server command from /server #


EXEC mode

service-profile scope service-profile command /service-profile #


from EXEC mode

system scope system command from /system #


EXEC mode

virtual HBA scope vhba command from EXEC /vhba #


mode

virtual NIC scope vnic command from EXEC /vnic #


mode

Object Commands
Four general commands are available for object management:
• create object
• delete object
• enter object
• scope object

You can use the scope command with any managed object, whether a permanent object or a user-instantiated
object. The other commands allow you to create and manage user-instantiated objects. For every create object
command, a corresponding delete object and enter object command exists.
In the management of user-instantiated objects, the behavior of these commands depends on whether the
object exists, as described in the following tables:

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 41
Overview of Cisco UCS Manager CLI
Complete a Command

Table 4: Command behavior if the object does not exist

Command Behavior
create object The object is created and its configuration mode, if
applicable, is entered.

delete object An error message is generated.

enter object The object is created and its configuration mode, if


applicable, is entered.

scope object An error message is generated.

Table 5: Command behavior if the object exists

Command Behavior
create object An error message is generated.

delete object The object is deleted.

enter object The configuration mode, if applicable, of the object is


entered.

scope object The configuration mode of the object is entered.

Complete a Command
You can use the Tab key in any mode to complete a command. Partially typing a command name and pressing
Tab causes the command to be displayed in full or to the point where another keyword must be chosen or an
argument value must be entered.

Command History
The CLI stores all commands used in the current session. You can step through the previously used commands
by using the Up Arrow or Down Arrow keys. The Up Arrow key steps to the previous command in the history,
and the Down Arrow key steps to the next command in the history. If you get to the end of the history, pressing
the Down Arrow key does nothing.
All commands in the history can be entered again by simply stepping through the history to recall the desired
command and pressing Enter. The command is entered as if you had manually typed it. You can also recall
a command and change it before you enter it.

Cisco UCS Manager CLI Command Reference, Release 2.0


42 OL-25718-02
Overview of Cisco UCS Manager CLI
Committing, Discarding, and Viewing Pending Commands

Committing, Discarding, and Viewing Pending Commands


When you enter a configuration command in the CLI, the command is not applied until you enter the
commit-buffer command. Until committed, a configuration command is pending and can be discarded by
entering a discard-buffer command.
You can accumulate pending changes in multiple command modes and apply them together with a single
commit-buffer command. You can view the pending commands by entering the show configuration pending
command in any command mode.

Note Committing multiple commands together is not an atomic operation. If any command fails, the successful
commands are applied despite the failure. Failed commands are reported in an error message.

While any commands are pending, an asterisk (*) appears before the command prompt. The asterisk disappears
when you enter the commit-buffer command, as shown in this example:
switch-1# scope chassis 1
switch-1 /chassis # enable locator-led
switch-1 /chassis* # show configuration pending
scope chassis 1
+ enable locator-led
exit
switch-1 /chassis* # commit-buffer
switch-1 /chassis #

Online Help for the CLI


At any time, you can type the ? character to display the options available at the current state of the command
syntax. If you have not typed anything at the prompt, typing ? lists all available commands for the mode you
are in. If you have partially typed a command, typing ? lists all available keywords and arguments available
at your current position in the command syntax.

CLI Session Limits


Cisco UCS Manager limits the number of CLI sessions that can be active at one time to 32 total sessions. This
value is not configurable.

Web Session Limits


Web session limits are used by Cisco UCS Manager to restrict the number of web sessions (both GUI and
XML) permitted access to the system at any one time.
By default, the number of concurrent web sessions allowed by Cisco UCS Manager is set to the maximum
value: 256.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 43
Overview of Cisco UCS Manager CLI
Setting the Web Session Limit for Cisco UCS Manager from the CLI

Setting the Web Session Limit for Cisco UCS Manager from the CLI
SUMMARY STEPS

1. UCS-A# scope system


2. UCS-A /system # scope services
3. UCS-A /system/services # scope web-session-limits
4. UCS-A /system/services/web-session-limits # set total num-of-logins-total
5. UCS-A /system/services/web-session-limits # commit-buffer

DETAILED STEPS

Command or Action Purpose


Step 1 UCS-A# scope system Enters system mode.

Step 2 UCS-A /system # scope services Enters system services mode.

Step 3 UCS-A /system/services # scope web-session-limits Enters system services web session limits mode.

Step 4 UCS-A /system/services/web-session-limits # set total The maximum number of concurrent HTTP and HTTPS
num-of-logins-total sessions allowed for all users within the system.
Enter an integer between 1 and 256.

Step 5 UCS-A /system/services/web-session-limits # Commits the transaction to the system configuration.


commit-buffer

Examples The following example sets the maximum number of HTTP and HTTPS sessions allowed by the system to
200 and commits the transaction:
UCS-A# scope system
UCS-A /system # scope services
UCS-A /system/services # scope web-session-limits
UCS-A /system/services/web-session-limits* # set total 200
UCS-A /system/services/web-session-limits* # commit-buffer
UCS-A /system/services/web-session-limits #

Pre-Login Banner
With a pre-login banner, when a user logs into Cisco UCS Manager GUI, Cisco UCS Manager displays the
banner text in the Create Pre-Login Banner dialog box and waits until the user dismisses that dialog box
before it prompts for the username and password. When a user logs into Cisco UCS Manager CLI, Cisco UCS
Manager displays the banner text in a dialog box and waits for the user to dismiss that dialog box before it
prompts for the password. It then repeats the banner text above the copyright block that it displays to the user.

Cisco UCS Manager CLI Command Reference, Release 2.0


44 OL-25718-02
Overview of Cisco UCS Manager CLI
Creating the Pre-Login Banner

Creating the Pre-Login Banner


SUMMARY STEPS

1. UCS-A# scope security


2. UCS-A /security # scope banner
3. UCS-A /security/banner # create pre-login-banner
4. UCS-A /security/banner/pre-login-banner # set message
5. At the prompt, type a pre-login banner message and press Enter.
6. UCS-A /security/banner/pre-login-banner # commit-buffer

DETAILED STEPS

Command or Action Purpose


Step 1 UCS-A# scope security Enters security mode.

Step 2 UCS-A /security # scope banner Enters banner security mode.

Step 3 UCS-A /security/banner # create Creates a pre login banner.


pre-login-banner
Step 4 UCS-A /security/banner/pre-login-banner # set Specifies the message that Cisco UCS Manager displays to the
message user before it displays the login prompt for the Cisco UCS
Manager GUI or CLI.
You can enter any standard ASCII character in this field.
Launches a dialog for entering the pre-login banner message text.

Step 5 At the prompt, type a pre-login banner message On the line following your input, type ENDOFBUF to finish.
and press Enter. Press Ctrl and C to cancel out of the set message dialog.

Step 6 UCS-A /security/banner/pre-login-banner # Commits the transaction to the system configuration.


commit-buffer

Examples The following example creates the pre-login banner:


UCS-A# scope security
UCS-A /security # scope banner
UCS-A /security/banner # create pre-login-banner
UCS-A /security/banner/pre-login-banner* # set message
Enter lines one at a time. Enter ENDOFBUF to finish. Press ^C to abort.
Enter prelogin banner:
>Welcome to UCS System 1
>ENDOFBUF
UCS-A /security/banner/pre-login-banner* # commit-buffer
UCS-A /security/banner/pre-login-banner #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 45
Overview of Cisco UCS Manager CLI
Modifying the Pre-Login Banner

Modifying the Pre-Login Banner


SUMMARY STEPS

1. UCS-A# scope security


2. UCS-A /security # scope banner
3. UCS-A /security/banner # scope pre-login-banner
4. UCS-A /security/banner/pre-login-banner # set message
5. At the prompt, modify the pre-login banner message and press Enter.
6. UCS-A /security/banner/pre-login-banner # commit-buffer

DETAILED STEPS

Command or Action Purpose


Step 1 UCS-A# scope security Enters security mode.

Step 2 UCS-A /security # scope banner Enters banner security mode.

Step 3 UCS-A /security/banner # scope Enters pre-login-banner banner security mode.


pre-login-banner
Step 4 UCS-A /security/banner/pre-login-banner # set Specifies the message that Cisco UCS Manager displays to the
message user before it displays the login prompt for the Cisco UCS
Manager GUI or CLI.
You can enter any standard ASCII character in this field.
Launches a dialog for entering the pre-login banner message text.

Step 5 At the prompt, modify the pre-login banner On the line following your input, type ENDOFBUF to finish.
message and press Enter. Press Ctrl and C to cancel out of the set message dialog.

Step 6 UCS-A /security/banner/pre-login-banner # Commits the transaction to the system configuration.


commit-buffer

Examples The following example modifies the pre-login banner:


UCS-A# scope security
UCS-A /security # scope banner
UCS-A /security/banner # create pre-login-banner
UCS-A /security/banner/pre-login-banner* # set message
Enter lines one at a time. Enter ENDOFBUF to finish. Press ^C to abort.
Enter prelogin banner:
Welcome to UCS System 1
ENDOFBUF
UCS-A /security/banner/pre-login-banner* # commit-buffer
UCS-A /security/banner/pre-login-banner #

Cisco UCS Manager CLI Command Reference, Release 2.0


46 OL-25718-02
Overview of Cisco UCS Manager CLI
Deleting the Pre-Login Banner

Deleting the Pre-Login Banner


SUMMARY STEPS

1. UCS-A# scope security


2. UCS-A /security # scope banner
3. UCS-A /security/banner # delete pre-login-banner
4. UCS-A /security/banner # commit-buffer

DETAILED STEPS

Command or Action Purpose


Step 1 UCS-A# scope security Enters security mode.

Step 2 UCS-A /security # scope banner Enters banner security mode.

Step 3 UCS-A /security/banner # delete pre-login-banner Deletes the pre-login banner from the system.

Step 4 UCS-A /security/banner # commit-buffer Commits the transaction to the system configuration.

Examples The following example deletes the pre-login banner:


UCS-A# scope security
UCS-A /security # scope banner
UCS-A /security/banner # delete pre-login-banner
UCS-A /security/banner* # commit-buffer
UCS-A /security/banner #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 47
Overview of Cisco UCS Manager CLI
Deleting the Pre-Login Banner

Cisco UCS Manager CLI Command Reference, Release 2.0


48 OL-25718-02
Commands
• acknowledge chassis, page 92
• acknowledge fex, page 93
• acknowledge fault, page 94
• acknowledge server, page 95
• acknowledge slot, page 96
• activate firmware, page 97
• activate firmware (fabric), page 99
• activate internal firmware, page 101
• add alertgroups, page 102
• add backup action, page 104
• add privilege, page 105
• apply pending-changes immediate, page 108
• associate server, page 109
• associate server-pool, page 111
• backup sel, page 112
• cd, page 113
• clear alertgroups, page 115
• clear auth-server-group, page 116
• clear backup action, page 117
• clear cores, page 118
• clear file, page 119
• clear message, page 120
• clear password-history, page 121
• clear sel (/chassis/server), page 122

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 49
Commands

• clear sel (/chassis/server), page 123


• clear sshkey, page 124
• cluster force primary, page 125
• cluster lead, page 126
• commit-buffer, page 128
• connect adapter, page 129
• connect bmc, page 130
• connect clp, page 131
• connect iom, page 132
• connect local-mgmt, page 133
• connect nxos, page 134
• copy, page 135
• create adapter, page 137
• create auth-domain, page 138
• create auth-profile, page 139
• create auth-server-group, page 141
• create auto-target-if, page 142
• create backup, page 143
• create bios-policy, page 145
• create bladeserver-disc-policy, page 146
• create block, page 147
• create boot-definition, page 149
• create boot-policy, page 150
• create boot-target, page 151
• create cap-qual, page 152
• create certreq, page 154
• create chassis, page 156
• create class chassis-stats, page 157
• create class cmc-stats, page 158
• create class cpu-env-stats, page 159
• create class dimm-env-stats, page 160
• create class dimm-stats, page 161
• create class env-stats, page 162

Cisco UCS Manager CLI Command Reference, Release 2.0


50 OL-25718-02
Commands

• create class ether-error-stats, page 163


• create class ether-if-stats, page 164
• create class ether-loss-stats, page 165
• create class ether-pause-stats, page 166
• create class ethernet-port-err-stats, page 167
• create class ethernet-port-multicast-stats, page 168
• create class ethernet-port-over-under-sized-stats, page 169
• create class ethernet-port-stats, page 170
• create class ethernet-port-stats-by-size-large-packets, page 171
• create class ethernet-port-stats-by-size-small-packets, page 172
• create class ether-rx-stats, page 173
• create class ether-tx-stats, page 174
• create class fan-module-stats, page 175
• create class fan-stats, page 176
• create class fc-error-stats, page 177
• create class fc-if-event-stats, page 178
• create class fc-if-fc4-counters, page 179
• create class fc-if-frame-stats, page 180
• create class fc-port-stats, page 181
• create class fc-stats, page 182
• create class fex-env-stats, page 183
• create class fex-power-summary, page 184
• create class fex-psu-input-stats, page 185
• create class io-card-stats, page 186
• create class mb-power-stats, page 187
• create class mb-temp-stats, page 188
• create class memory-array-env-stats, page 189
• create class memory-runtime, page 190
• create class menlo-dce-port-stats, page 191
• create class menlo-eth-error-stats, page 192
• create class menlo-eth-stats, page 193
• create class menlo-fc-error-stats, page 194
• create class menlo-fc-stats, page 195

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 51
Commands

• create class menlo-host-port-stats, page 196


• create class menlo-mcpu-error-stats, page 197
• create class menlo-mcpu-stats, page 198
• create class menlo-net-eg-stats, page 199
• create class menlo-net-in-stats, page 200
• create class menlo-q-error-stats, page 201
• create class menlo-q-stats, page 202
• create class motherboard-temp-stats, page 203
• create class pcie-fatal-completion-error-stats, page 204
• create class pcie-fatal-error-stats, page 205
• create class pcie-fatal-protocol-error-stats, page 206
• create class pcie-fatal-receiving-error-stats, page 207
• create class processor-runtime, page 208
• create class psu-input-stats, page 209
• create class psu-stats, page 210
• create class rack-unit-fan-stats, page 211
• create class rack-unit-psu-stats, page 212
• create class system-stats, page 213
• create class vnic-stats, page 214
• create client, page 215
• create cluster, page 216
• create cpu, page 217
• create data-center, page 218
• create default-auth, page 219
• create default-behavior, page 220
• create destination, page 221
• create dest-interface, page 222
• create dhcp-ip-params, page 223
• create distributed-virtual-switch, page 224
• create dns, page 225
• create dynamic-vnic-conn, page 226
• create dynamic-vnic-conn-policy, page 227
• create egress-policy, page 228

Cisco UCS Manager CLI Command Reference, Release 2.0


52 OL-25718-02
Commands

• create eth-if, page 229


• create eth-if (vnic-iscsi), page 230
• create eth-mon-session, page 231
• create eth-policy, page 232
• create eth-target, page 233
• create ext-static-ip, page 234
• create fc-mon-session, page 235
• create fcoe-if, page 236
• create fc-policy, page 237
• create folder, page 238
• create fw-host-pack, page 239
• create fw-mgmt-pack, page 240
• create hv-conn, page 241
• create import-config, page 242
• create initiator, page 244
• create interface, page 245
• create interface fc, page 247
• create interface fcoe, page 248
• create ip-if, page 249
• create ipmi-access-profile, page 250
• create ipmi-user, page 251
• create iqn-pool, page 252
• create iscsi-policy, page 254
• create iscsi, page 255
• create keyring, page 256
• create lan, page 257
• create ldap-group, page 258
• create ldap-group-rule, page 259
• create local, page 260
• create local-disk-config, page 261
• create local-disk-config-policy, page 262
• create locale, page 263
• create local-user, page 264

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 53
Commands

• create lun, page 265


• create mac-pool, page 266
• create mac-security, page 267
• create maint-policy, page 268
• create member-port, page 269
• create member-port fc, page 271
• create member-port fcoe, page 273
• create member-port (/port-channel), page 274
• create member-port-channel, page 276
• create memory, page 278
• create mon-src, page 279
• create network (/eth-uplink/port-profile), page 281
• create network (/profile-set/port-profile), page 282
• create ntp-server, page 283
• create nw-ctrl-policy, page 284
• create occurrence one-time, page 286
• create occurrence recurring, page 287
• create org, page 289
• create org-ref, page 290
• create pack-image, page 292
• create path, page 294
• create path (iscsi), page 296
• create physical-qual, page 297
• create pin-group, page 298
• create policy, page 299
• create pooled-ip-params, page 301
• create pooling-policy, page 302
• create port-channel, page 303
• create port-profile (/eth-uplink), page 304
• create port-profile (/profile-set), page 305
• create power-control-policy, page 306
• create power-group, page 307
• create processor, page 308

Cisco UCS Manager CLI Command Reference, Release 2.0


54 OL-25718-02
Commands

• create profile, page 309


• create qos-policy, page 310
• create rack, page 311
• create role, page 312
• create san-image, page 313
• create scheduler, page 314
• create scrub-policy, page 315
• create server, page 316
• create server (/org/server-pool), page 318
• create server-autoconfig-policy, page 319
• create server-disc-policy, page 320
• create server-inherit-policy, page 321
• create server-pool, page 322
• create server-qual, page 323
• create server-ref, page 324
• create service-profile, page 325
• create slot, page 326
• create snmp-trap, page 327
• create snmp-user, page 328
• create sol-config, page 329
• create sol-policy, page 330
• create static-ip-params, page 331
• create static-target-if, page 333
• create stats-threshold-policy, page 334
• create storage, page 335
• create threshold-value, page 336
• create trustpoint, page 338
• create uuid-suffix-pool, page 339
• create vcenter, page 340
• create vcon, page 341
• create vcon-policy, page 342
• create vhba, page 343
• create vhba-templ, page 345

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 55
Commands

• create virtual-media, page 347


• create vlan, page 348
• create vlan (/port-profile), page 350
• create vnic, page 351
• create vnic-egress-policy, page 353
• create vnic-iscsi, page 354
• create vnic-templ, page 355
• create vsan, page 357
• create wwn-pool, page 359
• cycle, page 360
• decommission chassis, page 361
• decommission fex, page 362
• decommission server, page 363
• decommission server (chassis), page 364
• delete adapter, page 365
• delete auth-domain, page 366
• delete auth-profile, page 367
• delete auth-server-group, page 368
• delete auto-target-if, page 369
• delete backup, page 370
• delete bladeserver-disc-policy, page 371
• delete block, page 372
• delete boot-definition, page 374
• delete boot-policy, page 375
• delete boot-target, page 376
• delete cap-qual, page 377
• delete certreq, page 379
• delete chassis, page 380
• delete class chassis-stats, page 381
• delete class cpu-env-stats, page 382
• delete class dimm-env-stats, page 383
• delete class dimm-stats, page 384
• delete class env-stats, page 385

Cisco UCS Manager CLI Command Reference, Release 2.0


56 OL-25718-02
Commands

• delete class ether-error-stats, page 386


• delete class ether-if-stats, page 387
• delete class ether-loss-stats, page 388
• delete class ethernet-port-err-stats, page 389
• delete class ethernet-port-multicast-stats, page 390
• delete class ethernet-port-over-under-sized-stats, page 391
• delete class ethernet-port-stats, page 392
• delete class ethernet-port-stats-by-size-large-packets, page 393
• delete class ethernet-port-stats-by-size-small-packets, page 394
• delete class ether-pause-stats, page 395
• delete class ether-rx-stats, page 396
• delete class ether-tx-stats, page 397
• delete class fan-module-stats, page 398
• delete class fan-stats, page 399
• delete class fc-error-stats, page 400
• delete class fc-port-stats, page 401
• delete class fc-stats, page 402
• delete class fex-env-stats, page 403
• delete class fex-power-summary, page 404
• delete class fex-psu-input-stats, page 405
• delete class io-card-stats, page 406
• delete class mb-power-stats, page 407
• delete class mb-temp-stats, page 408
• delete class memory-array-env-stats, page 409
• delete class motherboard-temp-stats, page 410
• delete class pcie-fatal-completion-error-stats, page 411
• delete class pcie-fatal-error-stats, page 412
• delete class pcie-fatal-protocol-error-stats, page 413
• delete class pcie-fatal-receiving-error-stats, page 414
• delete class psu-input-stats, page 415
• delete class psu-stats, page 416
• delete class rack-unit-fan-stats, page 417
• delete class rack-unit-psu-stats, page 418

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 57
Commands

• delete class system-stats, page 419


• delete class vnic-stats, page 420
• delete client, page 421
• delete cluster, page 422
• delete cpu, page 423
• delete data-center, page 424
• delete default-auth, page 425
• delete default-behavior, page 426
• delete destination, page 427
• delete dest-interface, page 428
• delete dhcp-ip-params, page 429
• delete distributed-virtual-switch, page 430
• delete dns, page 431
• delete download-task, page 432
• delete dynamic-vnic-conn, page 433
• delete dynamic-vnic-conn-policy, page 434
• delete egress-policy, page 435
• delete eth-if, page 436
• delete eth-mon-session, page 437
• delete eth-policy, page 438
• delete eth-target, page 439
• delete ext-static-ip, page 440
• delete fc-mon-session, page 441
• delete fc-policy, page 442
• delete folder, page 443
• delete fw-host-pack, page 444
• delete fw-mgmt-pack, page 445
• delete image, page 446
• delete import-config, page 448
• delete initiator, page 449
• delete interface, page 450
• delete interface fc, page 451
• delete interface fcoe, page 452

Cisco UCS Manager CLI Command Reference, Release 2.0


58 OL-25718-02
Commands

• delete ip-if, page 453


• delete ipmi-access-profile, page 454
• delete ipmi-user, page 455
• delete iqn-pool, page 456
• delete iscsi-policy, page 457
• delete iscsi, page 458
• delete keyring, page 459
• delete lan, page 460
• delete ldap-group, page 461
• delete ldap-group-rule, page 462
• delete local, page 463
• delete locale, page 464
• delete local-disk-config, page 465
• delete local-disk-config-policy, page 466
• delete local-user, page 467
• delete lun, page 468
• delete mac-pool, page 469
• delete mac-security, page 470
• delete maint-policy, page 471
• delete member-port, page 472
• delete member-port fc, page 474
• delete member-port fcoe, page 476
• delete member-port-channel, page 478
• delete memory, page 480
• delete mon-src, page 481
• delete network, page 483
• delete network (/profile-set/port-profile), page 484
• delete ntp-server, page 485
• delete nw-ctrl-policy, page 486
• delete occurrence one-time, page 487
• delete occurrence recurring, page 488
• delete org, page 489
• delete org-ref, page 490

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 59
Commands

• delete pack-image, page 491


• delete path, page 493
• delete path (iscsi), page 494
• delete pending-deletion, page 495
• delete physical-qual, page 496
• delete pin-group, page 497
• delete policy, page 498
• delete pooled-ip-params, page 500
• delete pooling-policy, page 501
• delete port-channel, page 502
• delete port-profile (profile-set), page 503
• delete power-control-policy, page 504
• delete power-group, page 505
• delete processor, page 506
• delete profile, page 507
• delete qos-policy, page 508
• delete rack, page 509
• delete remote-user, page 510
• delete role, page 511
• delete san-image, page 512
• delete scheduler, page 513
• delete scrub-policy, page 514
• delete server, page 515
• delete server (/security), page 517
• delete server-autoconfig-policy, page 518
• delete server-disc-policy, page 519
• delete server-inherit-policy, page 520
• delete server-pool, page 521
• delete server-qual, page 522
• delete server-ref, page 523
• delete service-profile, page 524
• delete slot, page 525
• delete snmp-trap, page 526

Cisco UCS Manager CLI Command Reference, Release 2.0


60 OL-25718-02
Commands

• delete snmp-user, page 527


• delete sol-config, page 528
• delete sol-policy, page 529
• delete static-ip-params, page 530
• delete static-target-if, page 531
• delete stats-threshold-policy, page 532
• delete storage, page 533
• delete target, page 534
• delete threshold-value, page 535
• delete trustpoint, page 537
• delete user-sessions, page 538
• delete user-sessions local, page 539
• delete user-sessions remote, page 540
• delete uuid-suffix-pool, page 541
• delete vcenter, page 542
• delete vcon, page 543
• delete vcon-policy, page 544
• delete vhba, page 545
• delete vhba-templ, page 546
• delete virtual-media, page 547
• delete vlan, page 548
• delete vlan-group-permit, page 549
• delete vlan-permit, page 550
• delete vnic, page 551
• delete vnic-iscsi, page 552
• delete vnic-templ, page 553
• delete vsan, page 554
• delete wwn-pool, page 555
• diagnostic-interrupt, page 556
• dir, page 557
• disable (distributed-virtual-switch), page 559
• disable cdp, page 560
• disable cimxml, page 561

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 61
Commands

• disable core-export-target, page 562


• disable http, page 563
• disable http-redirect, page 564
• disable https, page 565
• disable locator-led, page 566
• disable (port-channel), page 567
• disable snmp, page 568
• disable syslog, page 569
• disable telnet-server, page 570
• disassociate, page 571
• discard-buffer, page 572
• download image, page 573
• download license, page 574
• enable (distributed-virtual-switch), page 575
• enable cdp, page 576
• enable cimxml, page 577
• enable cluster, page 578
• enable core-export-target, page 579
• enable http, page 580
• enable http-redirect, page 581
• enable https, page 582
• enable locator-led, page 583
• enable (port-channel), page 584
• enable snmp, page 585
• enable syslog, page 586
• enable telnet-server, page 588
• end, page 589
• enter adapter, page 590
• enter auth-domain, page 591
• enter auth-profile, page 592
• enter auth-server-group, page 593
• enter auto-target-if, page 594
• enter backup, page 595

Cisco UCS Manager CLI Command Reference, Release 2.0


62 OL-25718-02
Commands

• enter bladeserver-disc-policy, page 597


• enter block, page 598
• enter boot-definition, page 600
• enter boot-policy, page 601
• enter boot-target, page 602
• enter cap-qual, page 603
• enter chassis, page 605
• enter class chassis-stats, page 606
• enter class cpu-env-stats, page 607
• enter class dimm-env-stats, page 608
• enter class env-stats, page 609
• enter class ether-error-stats, page 610
• enter class ether-loss-stats, page 611
• enter class ethernet-port-err-stats, page 612
• enter class ethernet-port-multicast-stats, page 613
• enter class ethernet-port-over-under-sized-stats, page 614
• enter class ethernet-port-stats, page 615
• enter class ethernet-port-stats-by-size-large-packets, page 616
• enter class ethernet-port-stats-by-size-small-packets, page 617
• enter class ether-pause-stats, page 618
• enter class ether-rx-stats, page 619
• enter class ether-tx-stats, page 620
• enter class fan-module-stats, page 621
• enter class fan-stats, page 622
• enter class fc-error-stats, page 623
• enter class fc-port-stats, page 624
• enter class fc-stats, page 625
• enter class fex-env-stats, page 626
• enter class fex-power-summary, page 627
• enter class fex-psu-input-stats, page 628
• enter class io-card-stats, page 629
• enter class mb-power-stats, page 630
• enter class mb-temp-stats, page 631

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 63
Commands

• enter class memory-array-env-stats, page 632


• enter class motherboard-temp-stats, page 633
• enter class pcie-fatal-completion-error-stats, page 634
• enter class pcie-fatal-error-stats, page 635
• enter class pcie-fatal-protocol-error-stats, page 636
• enter class pcie-fatal-receiving-error-stats, page 637
• enter class psu-input-stats, page 638
• enter class rack-unit-fan-stats, page 639
• enter class rack-unit-psu-stats, page 640
• enter class system-stats, page 641
• enter class vnic-stats, page 642
• enter client, page 643
• enter cluster, page 644
• enter cpu, page 645
• enter data-center, page 646
• enter default-auth, page 647
• enter default-behavior, page 648
• enter destination, page 649
• enter dest-interface, page 650
• enter dhcp-ip-params, page 651
• enter distributed-virtual-switch, page 652
• enter dynamic-vnic-conn, page 653
• enter dynamic-vnic-conn-policy, page 654
• enter egress-policy, page 655
• enter eth-if, page 656
• enter eth-if (vnic-iscsi), page 657
• enter eth-mon-session, page 658
• enter eth-policy, page 659
• enter eth-target, page 660
• enter ext-static-ip, page 661
• enter fc-mon-session, page 662
• enter fc-policy, page 663
• enter folder, page 664

Cisco UCS Manager CLI Command Reference, Release 2.0


64 OL-25718-02
Commands

• enter fw-host-pack, page 665


• enter fw-mgmt-pack, page 666
• enter import-config, page 667
• enter initiator, page 669
• enter interface, page 670
• enter interface fc, page 671
• enter interface fcoe, page 672
• enter ip-if, page 673
• enter ipmi-access-profile, page 674
• enter ipmi-user, page 675
• enter iqn-pool, page 677
• enter iscsi-policy, page 678
• enter iscsi, page 679
• enter keyring, page 680
• enter lan, page 681
• enter ldap-group, page 682
• enter ldap-group-rule, page 683
• enter local, page 684
• enter local-disk-config, page 685
• enter local-disk-config-policy, page 686
• enter locale, page 687
• enter local-user, page 688
• enter lun, page 689
• enter mac-pool, page 690
• enter mac-security, page 691
• enter maint-policy, page 692
• enter member-port, page 693
• enter member-port fc, page 695
• enter member-port fcoe, page 696
• enter member-port (/fc-storage/vsan), page 698
• enter member-port (/port-channel), page 700
• enter member-port-channel, page 701
• enter memory, page 703

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 65
Commands

• enter mon-src, page 704


• enter network, page 706
• enter nw-ctrl-policy, page 707
• enter occurrence one-time, page 708
• enter occurrence recurring, page 709
• enter org, page 710
• enter pack-image, page 711
• enter path, page 713
• enter path (iscsi), page 714
• enter pin-group, page 715
• enter policy, page 716
• enter pooled-ip-params, page 718
• enter pooling-policy, page 719
• enter port-channel, page 720
• enter port-profile (profile-set), page 721
• enter power-control-policy, page 722
• enter power-group, page 723
• enter processor, page 724
• enter qos-policy, page 725
• enter rack, page 726
• enter scheduler, page 727
• enter server, page 728
• enter server-ref, page 729
• enter static-ip-params, page 730
• enter static-target-if, page 732
• enter storage, page 733
• enter threshold-value, page 734
• enter vcenter, page 736
• enter vcon, page 737
• enter vcon-policy, page 738
• enter vlan, page 739
• enter vlan (port-profile), page 741
• enter vnic-iscsi, page 742

Cisco UCS Manager CLI Command Reference, Release 2.0


66 OL-25718-02
Commands

• enter vsan, page 743


• erase configuration, page 745
• erase-log-config, page 746
• install file, page 747
• ls, page 748
• mkdir, page 750
• move, page 752
• ping, page 754
• power, page 756
• power down soft-followed-by-hard, page 757
• power down soft-shut-down, page 758
• pwd, page 759
• reboot, page 760
• recommission chassis, page 761
• recommission fex, page 762
• recommission server, page 763
• recover-bios, page 764
• remove alertgroups, page 765
• remove backup action, page 767
• remove fex, page 769
• remove privilege, page 770
• remove server, page 773
• reset, page 774
• reset-cmos, page 776
• reset-errors, page 777
• reset-kvm, page 778
• reset pers-bind, page 779
• restart, page 780
• rmdir, page 781
• run-script, page 783
• save, page 784
• scope adapter, page 785
• scope auth-domain, page 786

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 67
Commands

• scope auth-profile, page 787


• scope auth-server-group, page 788
• scope auto-target-if, page 789
• scope backup, page 790
• scope banner, page 791
• scope beacon-led, page 792
• scope bios-settings, page 793
• scope bios, page 795
• scope bladeserver-disc-policy, page 796
• scope block, page 797
• scope boardcontroller, page 798
• scope boot-definition, page 799
• scope boot-policy, page 800
• scope boot-target, page 801
• scope callhome, page 802
• scope capability, page 803
• scope cap-qual, page 804
• scope card, page 806
• scope cat-updater, page 807
• scope cert-store, page 808
• scope chassis, page 809
• scope chassis (/capability), page 810
• scope chassis-conn-policy, page 811
• scope chassis-disc-policy, page 812
• scope cimc, page 813
• scope class chassis-stats, page 814
• scope class cpu-env-stats, page 815
• scope class dimm-env-stats, page 816
• scope class ether-error-stats, page 817
• scope class ether-loss-stats, page 818
• scope class ethernet-port-err-stats, page 819
• scope class ethernet-port-multicast-stats, page 820
• scope class ethernet-port-over-under-sized-stats, page 821

Cisco UCS Manager CLI Command Reference, Release 2.0


68 OL-25718-02
Commands

• scope class ethernet-port-stats, page 822


• scope class ethernet-port-stats-by-size-large-packets, page 823
• scope class ethernet-port-stats-by-size-small-packets, page 824
• scope class ether-pause-stats, page 825
• scope class ether-rx-stats, page 826
• scope class ether-tx-stats, page 827
• scope class fan-module-stats, page 828
• scope class fan-stats, page 829
• scope class fc-error-stats, page 830
• scope class fc-stats, page 831
• scope class fex-env-stats, page 832
• scope class fex-power-summary, page 833
• scope class fex-psu-input-stats, page 834
• scope class io-card-stats, page 835
• scope class memory-array-env-stats, page 836
• scope class memory-error-correctable-codes-stats, page 837
• scope class memory-mirroring-error-stats, page 838
• scope class memory-sparing-error-stats, page 839
• scope class motherboard-temp-stats, page 840
• scope class pc-ie-correctable-stats, page 841
• scope class pcie-fatal-completion-error-stats, page 842
• scope class pcie-fatal-error-stats, page 843
• scope class pcie-fatal-protocol-error-stats, page 844
• scope class pcie-fatal-receiving-error-stats, page 845
• scope class rack-unit-fan-stats, page 846
• scope class rack-unit-psu-stats, page 847
• scope client, page 848
• scope cluster-set, page 849
• scope cluster, page 850
• scope console-auth, page 851
• scope cpu, page 852
• scope cpu (/system/capability), page 853
• scope data-center, page 854

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 69
Commands

• scope default-auth, page 855


• scope default-behavior, page 856
• scope dest-interface, page 857
• scope dhcp-ip-params, page 858
• scope diag, page 859
• scope dimm, page 860
• scope distributed-virtual-switch, page 861
• scope download-task, page 862
• scope dynamic-vnic-conn, page 863
• scope dynamic-vnic-conn-policy, page 864
• scope egress-policy, page 865
• scope eth-best-effort, page 866
• scope eth-classified, page 867
• scope eth-if, page 868
• scope eth-if (vnic-iscsi), page 869
• scope eth-mon-session, page 870
• scope eth-policy, page 871
• scope eth-server, page 872
• scope eth-storage, page 873
• scope eth-target, page 874
• scope eth-traffic-mon, page 875
• scope eth-uplink, page 876
• scope ext-eth-if, page 877
• scope extension-key, page 878
• scope ext-pooled-ip, page 879
• scope ext-static-ip, page 880
• scope fabric, page 881
• scope fabric-if, page 883
• scope fabric-interconnect, page 884
• scope fabric-port-channel, page 885
• scope fan, page 886
• scope fan-module, page 887
• scope fc, page 888

Cisco UCS Manager CLI Command Reference, Release 2.0


70 OL-25718-02
Commands

• scope fc-mon-session, page 889


• scope fc-policy, page 890
• scope fc-storage, page 891
• scope fc-traffic-mon, page 892
• scope fc-uplink, page 893
• scope fex, page 894
• scope firmware, page 895
• scope flow-control, page 896
• scope folder, page 897
• scope fw-host-pack, page 898
• scope fw-mgmt-pack, page 899
• scope host-eth-if, page 900
• scope host-eth-if dynamic-mac, page 901
• scope host-fc-if, page 902
• scope host-fc-if wwn, page 903
• scope host-iscsi-if, page 904
• scope host-port-channel, page 905
• scope import-config, page 906
• scope instance, page 907
• scope interface, page 908
• scope interface fc, page 909
• scope interface fcoe, page 910
• scope inventory, page 911
• scope iom (/chassis), page 912
• scope iom (/capability), page 913
• scope iom (/fex), page 914
• scope ip-if, page 915
• scope ipmi-access-profile, page 916
• scope ipmi-user, page 917
• scope iqn-pool, page 918
• scope iscsi-policy, page 919
• scope iscsi, page 920
• scope lan, page 921

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 71
Commands

• scope ldap, page 922


• scope ldap-group, page 923
• scope ldap-group-rule, page 924
• scope license, page 925
• scope locale, page 926
• scope local-disk-config, page 927
• scope lun, page 928
• scope lun (static-target-if), page 929
• scope mac-security, page 930
• scope maint-policy, page 931
• scope management-extension, page 932
• scope member-port-channel, page 933
• scope member-port, page 935
• scope member-port fc, page 937
• scope member-port fcoe, page 938
• scope memory-array, page 940
• scope mon-flt, page 941
• scope monitoring, page 942
• scope mon-src, page 943
• scope network, page 945
• scope nw-ctrl-policy, page 946
• scope occurrence one-time, page 947
• scope occurrence recurring, page 948
• scope org, page 949
• scope password-profile, page 950
• scope path (iscsi), page 951
• scope policy, page 952
• scope pooled-ip-params, page 954
• scope port-channel, page 955
• scope port-profile, page 956
• scope post-code-reporter, page 957
• scope post-code-template, page 958
• scope power-cap-mgmt, page 959

Cisco UCS Manager CLI Command Reference, Release 2.0


72 OL-25718-02
Commands

• scope power-control-policy, page 960


• scope power-group, page 961
• scope pre-login-banner, page 962
• scope priority-weight, page 963
• scope profile, page 964
• scope profile-set, page 965
• scope psu, page 966
• scope psu-policy, page 967
• scope qos, page 968
• scope qos-policy, page 969
• scope rack, page 970
• scope rack-mount, page 971
• scope rackserver-disc-policy, page 972
• scope radius, page 973
• scope raid-controller, page 974
• scope role, page 975
• scope scheduler, page 976
• scope security, page 977
• scope server, page 978
• scope server (/ldap), page 979
• scope server (vm-mgmt), page 980
• scope server-if, page 981
• scope server-qual, page 982
• scope server-ref, page 983
• scope services, page 984
• scope service-profile, page 985
• scope service-profile (/org), page 987
• scope snmp-user, page 988
• scope static-ip-params, page 989
• scope static-target-if, page 991
• scope stats-threshold-policy, page 992
• scope storage-controller, page 993
• scope sys-defaults, page 994

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 73
Commands

• scope system, page 995


• scope tacacs, page 996
• scope threshold-value, page 997
• scope update, page 999
• scope vcenter, page 1000
• scope vcon-policy, page 1001
• scope vhba, page 1002
• scope vhba-templ, page 1003
• scope virtual-machine, page 1004
• scope virtual-machine (vm-mgmt), page 1005
• scope vlan, page 1006
• scope vlan (port-profile), page 1007
• scope vm-life-cycle-policy, page 1008
• scope vm-mgmt, page 1009
• scope vmware, page 1010
• scope vnic, page 1011
• scope vnic-iscsi, page 1012
• scope vnic-templ, page 1013
• scope vsan, page 1014
• scope web-session-limits, page 1015
• scope wwn-pool, page 1016
• send, page 1017
• send-syslog, page 1018
• send-test-alert, page 1020
• set account-status, page 1022
• set action, page 1024
• set adaptor-policy, page 1026
• set adaptor-policy, page 1027
• set addr, page 1028
• set adminspeed, page 1029
• set adminstate, page 1030
• set admin-state, page 1032
• set admin-state (beacon-led), page 1033

Cisco UCS Manager CLI Command Reference, Release 2.0


74 OL-25718-02
Commands

• set admin-vcon, page 1034


• set aes-128, page 1035
• set agent-policy, page 1036
• set alertgroups, page 1037
• set all, page 1039
• set arch, page 1041
• set attribute, page 1043
• set auth, page 1044
• set authentication console, page 1045
• set authentication default, page 1046
• set authport, page 1047
• set authorization, page 1048
• set auth-server-group, page 1049
• set backup action, page 1050
• set backup clear-on-backup, page 1052
• set backup destination, page 1053
• set backup format, page 1055
• set backup hostname, page 1056
• set backup interval, page 1057
• set backup password, page 1058
• set backup protocol, page 1059
• set backup remote-path, page 1060
• set backup user, page 1061
• set basedn, page 1062
• set binddn, page 1063
• set bios-settings-scrub, page 1064
• set blocksize, page 1066
• set boot-option-retry-config retry, page 1067
• set boot-policy, page 1068
• set cap-policy, page 1069
• set cert, page 1070
• set certchain, page 1071
• set certificate, page 1072

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 75
Commands

• set change-count, page 1073


• set change-during-interval, page 1074
• set change-interval, page 1075
• set cimxml port, page 1076
• set clear-action, page 1077
• set clear password-history, page 1078
• set cli suppress-field-spillover, page 1079
• set cli suppress-headers, page 1081
• set cli table-field-delimiter, page 1082
• set clock (memory), page 1084
• set clock (system), page 1085
• set cluster, page 1086
• set collection-interval, page 1087
• set communication-policy-ctrl , page 1088
• set community, page 1090
• set comp-queue count, page 1091
• set concur-tasks, page 1092
• set console-redir-config baud-rate, page 1093
• set console-redir-config console-redir, page 1094
• set console-redir-config flow-control, page 1096
• set console-redir-config legacy-os-redir, page 1097
• set console-redir-config terminal-type, page 1098
• set contact, page 1100
• set contract-id, page 1101
• set core-export-target path, page 1102
• set core-export-target port, page 1103
• set core-export-target server-description, page 1104
• set core-export-target server-name, page 1105
• set correctible-memory-error-log-threshold-config, page 1106
• set cos, page 1107
• set country, page 1108
• set cpu-performance-config cpu-performance, page 1110
• set customer-id, page 1112

Cisco UCS Manager CLI Command Reference, Release 2.0


76 OL-25718-02
Commands

• set data-center, page 1113


• set data-center-folder, page 1114
• set data-center (/client), page 1115
• set date, page 1116
• set day, page 1118
• set deescalating, page 1120
• set default-gw, page 1121
• set default-net, page 1122
• set defaultzoning, page 1123
• set descr, page 1124
• set description, page 1126
• set descr (vcon-policy), page 1127
• set destination org, page 1128
• set dhcp-vendor-id, page 1129
• set direct-cache-access-config access, page 1130
• set direction, page 1131
• set diskless, page 1133
• set disk-scrub, page 1134
• set dns-policy-ctrl, page 1135
• set dns, page 1137
• set domain-name, page 1139
• set drop, page 1140
• set dvs, page 1141
• set dynamic-eth, page 1142
• set email, page 1143
• set e-mail (/keyring), page 1144
• set enforce-vnic-name, page 1146
• set enhanced-intel-speedstep-config, page 1147
• set error-recovery fcp-error-recovery, page 1148
• set error-recovery link-down-timeout, page 1149
• set error-recovery port-down-io-retry-count, page 1150
• set error-recovery port-down-timeout, page 1151
• set escalating, page 1152

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 77
Commands

• set execute-disable bit, page 1153


• set expiration, page 1154
• set expire-warn-interval, page 1156
• set ext-mgmt-ip-state, page 1157
• set fabric, page 1158
• set failover timeout, page 1159
• set fc-if name, page 1160
• set fcoe-vlan, page 1161
• set fcoe-storage-native-vlan, page 1162
• set file size, page 1163
• set filter, page 1164
• set firstname, page 1165
• set flap-interval, page 1166
• set flow-control-policy, page 1167
• set folder, page 1168
• set folder (/client), page 1169
• set forged-transmit, page 1170
• set format, page 1171
• set from-email, page 1173
• set front-panel-lockout-config, page 1174
• set history-count, page 1175
• set host, page 1176
• set host-cos-control, page 1177
• set host-fw-policy, page 1178
• set host-nwio-perf, page 1179
• set hostname, page 1180
• set hostname, page 1181
• set hour, page 1182
• set http port, page 1183
• set https cipher-suite-mode, page 1184
• set https cipher-suite, page 1185
• set https keyring, page 1186
• set https port, page 1187

Cisco UCS Manager CLI Command Reference, Release 2.0


78 OL-25718-02
Commands

• set hyper-threading-config, page 1188


• set id, page 1189
• set identity dynamic-mac, page 1190
• set identity dynamic-uuid, page 1191
• set identity dynamic-wwnn, page 1192
• set identity dynamic-wwpn, page 1193
• set identity mac-pool, page 1194
• set identity uuid-suffix-pool, page 1195
• set identity wwnn-pool, page 1196
• set identity wwpn-pool, page 1197
• set intel-turbo-boost-config, page 1198
• set intel-vt-config, page 1199
• set intel-vt-directed-io-config, page 1200
• set interrupt coalescing-time, page 1202
• set interrupt coalescing-type, page 1203
• set interrupt count, page 1204
• set interrupt mode, page 1205
• set interval-days, page 1206
• set ip, page 1207
• set ipmi-access-profile, page 1209
• set iqn-prefix, page 1210
• set iscsi-adaptor-policy, page 1211
• set iscsi-identity initiator-name, page 1212
• set iscsi-protocol-item boottotarget, page 1213
• set iscsi-protocol-item connection-timeout, page 1214
• set iscsi-protocol-item dhcp-timeout, page 1215
• set iscsi-protocol-item hbamode, page 1216
• set iscsi-protocol-item lun-busy-retrycount, page 1217
• set iscsi-protocol-item tcp-time-stamp, page 1218
• set iscsi-targetname, page 1219
• set iscsivnicname, page 1220
• set isnative, page 1221
• set key (server), page 1222

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 79
Commands

• set key (extension-key), page 1223


• set lastname, page 1224
• set level, page 1225
• set link-aggregation-pref, page 1227
• set link-aggregation-pref (/chassis-disc-policy), page 1228
• set local-disk-policy, page 1229
• set locality, page 1230
• set lun, page 1232
• set lv-dimm-support-config, page 1233
• set macaddress, page 1234
• set mac-aging, page 1235
• set mac-pool, page 1236
• set maint-policy, page 1237
• set maxcap, page 1238
• set maxcores, page 1239
• set max-duration, page 1240
• set max-field-size, page 1242
• set max-http-user-sessions, page 1243
• set maximum, page 1244
• set max-ports, page 1245
• set processor-c1e-config c1e, page 1246
• set max-memory-below-4gb-config max-memory, page 1248
• set max-variable-mtrr-setting-config processor-mtrr, page 1249
• set maxprocs, page 1251
• set maxsize, page 1252
• set maxthreads, page 1253
• set member-of-attribute, page 1254
• set memory-mirroring-mode, page 1255
• set memory-ras-config, page 1256
• set memory-sparing-mode sparing-mode, page 1258
• set message, page 1259
• set mgmt-fw-policy, page 1260
• set mgmt-if-mon-policy arp-deadline, page 1261

Cisco UCS Manager CLI Command Reference, Release 2.0


80 OL-25718-02
Commands

• set mgmt-if-mon-policy monitor-mechanism, page 1263


• set mgmt-if-mon-policy ping-requests, page 1265
• set mgmt-if-mon-policy poll-interval, page 1266
• set mincap, page 1267
• set mincores, page 1268
• set min-interval, page 1269
• set minprocs, page 1271
• set minthreads, page 1272
• set minute, page 1273
• set mode (eth-uplink), page 1274
• set mode (fc-uplink), page 1275
• set mode (fw-pack), page 1276
• set mode (local-disk), page 1277
• set model-regex, page 1279
• set module, page 1280
• set modulus, page 1282
• set mtu, page 1283
• set mtu (eth-best-effort), page 1284
• set mtu (vnic), page 1285
• set multicast-optimize, page 1286
• set multicastoptimize (eth-best-effort), page 1287
• set name, page 1288
• set native, page 1289
• set no-change-interval, page 1290
• set normal-value, page 1291
• set notificationtype, page 1292
• set numa-config, page 1293
• set numberofblocks, page 1294
• set nw-control-policy, page 1295
• set offload large-receive, page 1296
• set offload tcp-rx-checksum, page 1297
• set offload tcp-segment, page 1298
• set offload tcp-tx-checksum, page 1299

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 81
Commands

• set onboard-scu-storage-support, page 1300


• set order (device boot order), page 1301
• set order (vhba pci scan order), page 1302
• set order (vnic relative order), page 1303
• set org-unit-name, page 1304
• set org-name, page 1306
• set out-of-band, page 1308
• set overlay-vnic-name, page 1309
• set password, page 1310
• set password (auth-profile), page 1312
• set password (snmp-user), page 1313
• set path, page 1314
• set peak, page 1315
• set per-user, page 1316
• set perdiskcap, page 1317
• set pers-bind, page 1318
• set phone, page 1319
• set phone-contact, page 1320
• set pid-regex, page 1321
• set pin-group, page 1323
• set pingroupname, page 1324
• set pool, page 1325
• set port, page 1326
• set port io-throttle-count, page 1328
• set port max-luns, page 1329
• set port-f-logi retries, page 1330
• set port-f-logi timeout, page 1331
• set portmode, page 1332
• set port-p-logi retries, page 1333
• set port-p-logi timeout, page 1334
• set post-error-pause-config port-error-pause, page 1335
• set power-budget committed, page 1336
• set power-control-policy, page 1337

Cisco UCS Manager CLI Command Reference, Release 2.0


82 OL-25718-02
Commands

• set preserve-pooled-values, page 1338


• set prio, page 1339
• set priority, page 1341
• set privilege, page 1342
• set priv-password, page 1343
• set proc-cap, page 1344
• set processor-c-state-config c-state, page 1346
• set processor-c3-report-config, page 1348
• set processor-c6-report-config, page 1350
• set protect, page 1351
• set protocol, page 1352
• set pubnwname, page 1353
• set qos-policy, page 1354
• set qualifier, page 1355
• set quiet-boot-config, page 1356
• set rate, page 1357
• set realloc, page 1359
• set realm, page 1360
• set realm, page 1361
• set reboot-on-update, page 1362
• set reboot-policy, page 1363
• set receive, page 1365
• set recv-queue count, page 1366
• set recv-queue ring-size, page 1367
• set redundancy, page 1368
• set refresh-period, page 1370
• set regenerate, page 1371
• set remote-file, page 1372
• set reply-to-email, page 1373
• set reporting-interval, page 1374
• set resume-ac-on-power-loss-config, page 1375
• set retention-interval, page 1377
• set retries, page 1379

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 83
Commands

• set rootdn, page 1380


• set rss receivesidescaling, page 1381
• set scheduler, page 1382
• set scrub-policy, page 1383
• set scsi-io count, page 1384
• set scsi-io ring-size, page 1385
• set send, page 1386
• set send-periodically, page 1387
• set server, page 1388
• set session-timeout, page 1389
• set sharing, page 1390
• set site-id, page 1391
• set size, page 1392
• set snmp community, page 1393
• set sol-policy, page 1394
• set speed, page 1395
• set speed (/eth-mon-session), page 1397
• set speed (/fc-mon-session), page 1398
• set speed (Uplink Ethernet Port), page 1399
• set src-templ-name, page 1400
• set sshkey, page 1401
• set ssl, page 1402
• set uefi-os-legacy-video-config legacy-video, page 1403
• set state, page 1404
• set stats-policy, page 1406
• set stepping, page 1407
• set street-address, page 1408
• set subject-name, page 1409
• set subnet, page 1411
• set switch-priority, page 1412
• set syslog console, page 1414
• set syslog file, page 1416
• set syslog monitor, page 1418

Cisco UCS Manager CLI Command Reference, Release 2.0


84 OL-25718-02
Commands

• set syslog remote-destination, page 1420


• set target, page 1422
• set template, page 1424
• set template-name, page 1425
• set throttling, page 1426
• set timeofday-hour, page 1427
• set timeofday-minute, page 1428
• set timeout, page 1429
• set timezone, page 1430
• set total, page 1432
• set trans-queue count, page 1433
• set trans-queue ring-size, page 1434
• set trustpoint, page 1435
• set type (backup), page 1436
• set type (partition), page 1437
• set type (template), page 1438
• set units, page 1439
• set uplink-fail-action, page 1440
• set uplink-trunking, page 1441
• set usb-boot-config make-device-non-bootable, page 1442
• set usb-front-panel-access-lock-config usb-front-panel-lock, page 1443
• set usb-system-idle-power-optimizing-setting-config usb-idle-power-optimizing, page 1444
• set user, page 1445
• set user-id, page 1446
• set userid, page 1447
• set user-label, page 1448
• set uuid-prefix, page 1449
• set v3privilege, page 1450
• set vcon, page 1451
• set vcon-profile, page 1453
• set version, page 1454
• set version (snmp-trap), page 1455
• set vhba, page 1456

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 85
Commands

• set virtual-ip, page 1457


• set vlan-id, page 1458
• set vmretention, page 1459
• set vnic, page 1460
• set vnicretention, page 1461
• set weight, page 1462
• set width, page 1463
• set wwn, page 1464
• set wwpn-pool, page 1465
• show activate status, page 1466
• show adapter, page 1467
• show assoc, page 1469
• show audit-logs, page 1470
• show auth-domain, page 1472
• show authentication, page 1473
• show auth-server-group, page 1474
• show backup, page 1475
• show backup (ep-log-policy), page 1477
• show beacon-led, page 1478
• show beacon-led fsm status, page 1479
• show bios, page 1480
• show bladeserver-disc-policy, page 1481
• show boot-definition, page 1483
• show boot-order, page 1484
• show boot-option-retry-config, page 1485
• show boot-policy, page 1486
• show boot-target, page 1488
• show callhome, page 1490
• show cap-qual, page 1492
• show card Command, page 1494
• show cat-updater, page 1495
• show certreq, page 1496
• show chassis-conn-policy, page 1498

Cisco UCS Manager CLI Command Reference, Release 2.0


86 OL-25718-02
Commands

• show chassis, page 1500


• show cimc, page 1502
• show cimxml, page 1504
• show class cpu-stats, page 1505
• show class dimm-env-stats, page 1507
• show class env-stats, page 1508
• show class ethernet-port-err-stats, page 1509
• show class ethernet-port-multicast-stats, page 1510
• show class ethernet-port-over-under-sized-stats, page 1511
• show class ethernet-port-stats, page 1512
• show class ethernet-port-stats-by-size-large-packets, page 1513
• show class ethernet-port-stats-by-size-small-packets, page 1514
• show class ether-pause-stats, page 1515
• show class io-card-stats, page 1516
• show class memory-array-env-stats, page 1517
• show class motherboard-temp-stats, page 1518
• show class pcie-fatal-completion-error-stats, page 1520
• show class pcie-fatal-error-stats, page 1521
• show class pcie-fatal-protocol-error-stats, page 1522
• show class pcie-fatal-receiving-error-stats, page 1523
• show cli, page 1524
• show cli history, page 1525
• show clock (system), page 1526
• show cluster, page 1527
• show connectivity, page 1528
• show console-auth, page 1529
• show core-export-target, page 1530
• show cores, page 1531
• show cpu, page 1533
• show default-auth, page 1534
• show destination, page 1535
• show disk, page 1537
• show distributed-virtual-switch, page 1539

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 87
Commands

• show dns, page 1540


• show download-task, page 1541
• show dynamic-conn-policy, page 1543
• show egress-policy, page 1544
• show environment, page 1545
• show error-recovery, page 1547
• show eth-classified, page 1548
• show eth-if, page 1550
• show eth-if (vnic-iscsi), page 1552
• show eth-mon-session, page 1554
• show eth-profile, page 1555
• show eth-target, page 1557
• show eth-uplink, page 1558
• show event, page 1560
• show execute-disable, page 1562
• show extension-key, page 1563
• show ext-eth-if, page 1564
• show ext-ipv6-rss-hash, page 1566
• show fabric, page 1567
• show fabric-interconnect, page 1569
• show fabric-interconnect inventory, page 1570
• show fabric-interconnect mode, page 1571
• show fabric-port-channel, page 1572
• show failover, page 1574
• show fan, page 1575
• show fan-module, page 1577
• show fault policy, page 1579
• show fc, page 1580
• show fc-if, page 1581
• show fc-profile, page 1582
• show fc-storage, page 1584
• show feature, page 1586
• show file, page 1587

Cisco UCS Manager CLI Command Reference, Release 2.0


88 OL-25718-02
Commands

• show host-port-channel, page 1589


• show identity iqn, page 1590
• show identity (server), page 1591
• show identity (service-profile), page 1592
• show identity mac-addr, page 1593
• show identity uuid, page 1595
• show identity wwn, page 1597
• show interface, page 1599
• show inventory, page 1601
• show inventory (fabric-interconnect), page 1602
• show ipmi-user, page 1604
• show iqn-pool, page 1606
• show iscsi-policy, page 1608
• show iscsi-protocol-profile, page 1609
• show iscsi, page 1610
• show ldap-group, page 1611
• show ldap-group-rule, page 1613
• show local-disk-config-policy, page 1614
• show maint-policy, page 1615
• show member-port-channel, page 1617
• show member-port, page 1619
• show member-port fc, page 1621
• show member-port fcoe, page 1623
• show mgmt-if-mon-policy, page 1625
• show mon-src, page 1627
• show nw-ctrl-policy, page 1629
• show occurrence one-time, page 1631
• show occurrence recurring, page 1633
• show password-profile, page 1635
• show pending-changes, page 1637
• show pooled, page 1638
• show port-channel, page 1640
• show power-budget, page 1642

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 89
Commands

• show power-control-policy, page 1643


• show power-group, page 1645
• show pre-login-banner, page 1647
• show psu-policy, page 1648
• show rackserver-disc-policy, page 1649
• show raid-battery, page 1650
• show scheduler, page 1651
• show security fsm status, page 1653
• show sel, page 1654
• show server actual-boot-order, page 1656
• show server adapter, page 1658
• show server adapter identity, page 1660
• show server adapter inventory, page 1662
• show server adapter layer2, page 1664
• show server adapter status, page 1665
• show server boot-order, page 1667
• show server cpu, page 1669
• show server identity, page 1671
• show server-host-id, page 1672
• show server status, page 1673
• show service-profile assoc, page 1674
• show service-profile circuit, page 1676
• show service-profile detail, page 1678
• show service-profile expand, page 1680
• show service-profile fsm, page 1682
• show service-profile identity, page 1684
• show service-profile inventory, page 1686
• show service-profile status, page 1689
• show snmp-user, page 1691
• show sol-policy, page 1692
• show sshkey, page 1694
• show static-target-if, page 1696
• show stats, page 1697

Cisco UCS Manager CLI Command Reference, Release 2.0


90 OL-25718-02
Commands

• show storage-controller, page 1698


• show tech-support, page 1700
• show usage, page 1702
• show vcenter, page 1704
• show vcon, page 1705
• show vcon-policy, page 1706
• show vif-ns, page 1707
• show virtual-machine, page 1708
• show vlan-port-count, page 1709
• show vm-life-cycle-policy, page 1711
• show web-session-limits, page 1712
• ssh, page 1713
• tail-mgmt-log, page 1714
• telnet, page 1716
• terminal length, page 1718
• terminal monitor, page 1719
• terminal session-timeout, page 1720
• terminal width, page 1721
• top, page 1722
• traceroute, page 1723
• up, page 1725
• update catalog, page 1726
• update firmware, page 1728
• where, page 1729

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 91
Commands
acknowledge chassis

acknowledge chassis
To acknowledge a chassis, use the acknowledge chassis command.

acknowledge chassis id

Syntax Description id Chassis identification number. The range of valid values is 1 to 255.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to verify the existence of devices in your network. For example, you can acknowledge a
chassis that was recently commissioned, to ensure that it exists.

Examples This example shows how to acknowledge a chassis:

switch-A# acknowledge chassis 10

switch-A* # commit-buffer

switch-A #

Related Commands Command Description


show chassis
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


92 OL-25718-02
Commands
acknowledge fex

acknowledge fex
To acknowledge the fabric extender module (fex), use the acknowledge fex command.

acknowledge fex id

Syntax Description id The ID of the fabric extender module.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines Active links between the chassis and the Fabric interconnect must exist to use this command.

Examples This example shows how to acknowledge the fabric extender module.
Switch-A # acknowledge fex 2
Switch-A * # commit-buffer
Switch-A #

Related Commands Command Description


acknowledge fault
acknowledge server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 93
Commands
acknowledge fault

acknowledge fault
To acknowledge a fault, use the acknowledge fault command.

acknowledge fault id

Syntax Description id Fault identification number. The range of valid values is 0 to 9223372036854775807.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples The following example shows how to acknowledge a fault:

switch-A# acknowledge fault 1

switch-A* # commit-buffer

switch-A #

Related Commands Command Description


show cli
show fault

Cisco UCS Manager CLI Command Reference, Release 2.0


94 OL-25718-02
Commands
acknowledge server

acknowledge server
To acknowledge a server, use the acknowledge server command.

acknowledge server {chassis-id / blade-id | slot-id}

Syntax Description chassis-id / blade-id Chassis and blade identification numbers.

slot-id Slot identification number. The range of valid values


is 1 to 8.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to verify the existence of devices in your network. For example, you can acknowledge a
server that was recently commissioned, to ensure that it exists. slot -id is used only in /chassis mode.

Examples The following example shows how to acknowledge a server in /chassis mode:

switch-A# scope chassis 1

switch-A /chassis # acknowledge server 2

switch-A /chassis* # commit-buffer

switch-A /chassis #

Related Commands Command Description


show chassis
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 95
Commands
acknowledge slot

acknowledge slot
To acknowledge a slot, use the acknowledge slot command.

acknowledge slot {chassis-id / blade-id | slot-id}

Syntax Description chassis-id / blade-id Sever identification number.

slot-id Slot identification number. The range of valid values is 1 to 8.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to verify the existence of devices in your network. For example, you can acknowledge a
chassis that was recently commissioned using slot -id , to ensure that it exists. slot -id is used only in /chassis
mode.

Examples The following example shows how to acknowledge a slot in /chassis mode:

switch-A# scope chassis 1

switch-A /chassis # acknowledge slot 1

switch-A /chassis* # commit-buffer

switch-A /chassis #

Related Commands Command Description


show server
show slot

Cisco UCS Manager CLI Command Reference, Release 2.0


96 OL-25718-02
Commands
activate firmware

activate firmware
To activate firmware for a device, use the activate firmware command.

activate firmwareversion [ignorecompcheck] [set-startup-only]+

Syntax Description version Firmware version.

ignorecompcheck (Optional) Ignores the results of the compatibility check.

set-startup-only (Optional) Activates the firmware only on next startup.

Command Default None

Command Modes Board controller (/chassis/server/boardcontroller)


BIOS (/chassis/server/bios)
Input output module (/chassis/iom)
System (/system)

Command History Release Modification


1.0(1) This command was introduced.

2.0(2) This command was introduced in the BIOS command mode.

Usage Guidelines Use the ignorecompcheck keyword to ignore the results of the automatic compatibility check when you
activate the firmware.
Use the set-startup-only keyword to activate the specified Input output module (IOM) firmware version
only on the next startup of the IOM. The system will not restart at this time. This keyword is available only
in the IOM command mode.

Examples The following example shows how to activate a specific version of system software, ignoring the compatibility
check:
UCS-A # scope system
UCS-A /system # activate firmware 3.0 ignorecompcheck
UCS-A /system* # commit-buffer
UCS-A /system #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 97
Commands
activate firmware

Related Commands Command Description


show firmware
show version

Cisco UCS Manager CLI Command Reference, Release 2.0


98 OL-25718-02
Commands
activate firmware (fabric)

activate firmware (fabric)


To activate kernal or system firmware on a fabric interconnect, use the activate firmware command.

activate firmware {kernel-version kernel-version| system-version system-version} [ignorecompcheck]


[force]+

Syntax Description kernel-version Specifies switch kernel firmware.

kernel-version Kernel firmware version.

system-version Specifies switch system firmware.

system-version System firmware version.

ignorecompcheck (Optional) Ignores the results of the compatability check.

force (Optional) Forces the upgrade.

Command Default None

Command Modes Fabric interconnect (/fabric-interconnect)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use the ignorecompcheck keyword to ignore the results of the automatic compatability check when you
activate the firmware.

Examples The following example shows how to activate a specific version of kernal software on fabric interconnect A,
ignoring the compatibility check:
switch-A# scope fabric-interconnect a
switch-A /fabric-interconnect # activate firmware kernel-version 3.0 ignorecompcheck
switch-A /fabric-interconnect* # commit-buffer
switch-A /fabric-interconnect #

Related Commands Command Description


show firmware

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 99
Commands
activate firmware (fabric)

Command Description
show version

Cisco UCS Manager CLI Command Reference, Release 2.0


100 OL-25718-02
Commands
activate internal firmware

activate internal firmware


To activate a new internal firmware version, use the activate internal firmware command.

activate internal firmware version [ignorecompcheck]

Syntax Description version The version number of the internal firmware version that you want to upgrade
the system to. The maximum length of the version string is 512 characters.

ignorecompcheck (Optional) Use this option to ignore the compatibility check between the
versions.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to activate the internal firmware version.
Switch-A # scope system
Switch-A /system # activate internal firmware 1.4(1) ignorecompcheck
Switch-A /system #

Related Commands Command Description


activate firmware

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 101
Commands
add alertgroups

add alertgroups
To add more alert groups to a Call Home profile, use the add alertgroups command.

add alertgroups [ciscotac] [diagnostic] [environmental] [inventory] [license] [lifecycle] [linecard]


[supervisor] [syslogport] [system] [test]+

Syntax Description ciscotac Specifies the Cisco Technical Assistance Center (TAC) alert group.

diagnostic Specifies the diagnostic alert group.

environmental Specifies the environmental alert group.

inventory Specifies the inventory alert group.

license Specifies the license alert group.

lifecycle Specifies the lifecycle alert group.

linecard Specifies the line card alert group.

supervisor Specifies the supervisor alert group.

syslogport Specifies the syslog port alert group.

system Specifies the system alert group.

test Specifies the test alert group.

Command Default None

Command Modes Profile (/monitoring/callhome/profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to add more predefined Call Home alert groups to an existing alert group list within a Call
Home profile.

Cisco UCS Manager CLI Command Reference, Release 2.0


102 OL-25718-02
Commands
add alertgroups

Examples This example shows how to add diagnostic and license alert groups to an existing Call Home profile:

switch-A# scope monitoring

switch-A /monitoring # scope callhome

switch-A /monitoring/callhome # scope profile profileOne

switch-A /monitoring/callhome/profile # add alertgroups diagnostic license

switch-A /monitoring/callhome/profile* # commit-buffer

switch-A /monitoring/callhome/profile #

Related Commands Command Description


remove alertgroups
set alertgroups

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 103
Commands
add backup action

add backup action


To add an additional action or actions that will trigger a backup of the system event log, use the add backup
action command.

add backup action [log-full] [none] [on-change-of-association] [on-clear] [timer]

Syntax Description log-full Specifies that the log is backed up when it is full.

none Specifies no action.

on-change-of-association Specifies that the log is backed up when the server changes associations.

on-clear Specifies that the log is backed up when it is cleared.

timer Specifies that the log is backed up at an interval.

Command Default None

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to add an additional action or actions that will trigger a backup of the system event log.
Previously configured actions are retained.

Examples This example shows how to add an action to trigger a backup of the system event log when the log is full:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # add backup action log-full
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Related Commands Command Description


remove backup action
set backup action
show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


104 OL-25718-02
Commands
add privilege

add privilege
To add privileges, use the add privilege command.

add privilege {aaa| admin| ext-lan-config| ext-lan-policy| ext-lan-qos| ext-lan-security| ext-san-config|


ext-san-policy| ext-san-qos| ext-san-security| fault| service-profile-config| service-profile-config-policy|
service-profile-network| service-profile-network-policy| service-profile-qos| service-profile-qos-policy|
service-profile-security| service-profile-security-policy| service-profile-server| service-profile-server-policy|
service-profile-storage| service-profile-storage-policy| operations| server-equipment| server-maintenance|
server-policy| server-security| pod-config| pod-policy| pod-qos| pod-security| read-only}+

Syntax Description aaa Specifies AAA privileges.

admin Specifies admin privileges.

ext-lan-config Specifies external LAN configuration priveleges.

ext-lan-policy Specifies external LAN policy privileges.

ext-lan-qos Specifies external LAN QoS privileges.

ext-lan-security Specifies external LAN security privileges.

ext-san-config Specifies external SAN configuration privileges.

ext-san-policy Specifies external SAN policy privileges.

ext-san-qos Specifies external SAN QoS privileges.

ext-san-security Specifies external SAN security privileges.

fault Specifies fault privileges.

service-profile-config Specifies service profile configuration privileges.

service-profile-config-policy Specifies service profile configuration policy privileges.

service-profile-network Specifies service profile network privileges.

service-profile-network-policy Specifies service profile network policy privileges.

service-profile-qos Specifies service profile QoS privileges.

service-profile-qos-policy Specifies service profile QoS policy privileges.

service-profile-security Specifies service profile security privileges.

service-profile-security-policy Specifies service profile security policy privileges.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 105
Commands
add privilege

service-profile-server Specifies service profile server privileges.

service-profile-server-policy Specifies service profile server policy privileges.

service-profile-storage Specifies service profile storage privileges.

service-profile-storage-policy Specifies service profile storage policy privileges.

operations Specifies operations privileges.

server-equipment Specifies server equipment privileges.

server-maintenance Specifies server maintenance privileges.

server-policy Specifies server policy privileges.

server-security Specifies server security privileges.

pod-config Specifies pod configuration privileges.

pod-policy Specifies pod policy privileges.

pod-qos Specifies pod QoS privileges.

pod-security Specifies pod security privileges.

read-only Specifies read-only privileges.

Command Default None

Command Modes Role (/security/role)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to add privileges:

switch-A # scope security

switch-A /security # scope role role1

switch-A /security/role # add privilege ext-san-config ext-san-policy ext-san-qos


ext-san-security

switch-A /security/role* # commit-buffer

Cisco UCS Manager CLI Command Reference, Release 2.0


106 OL-25718-02
Commands
add privilege

switch-A /security/role #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 107
Commands
apply pending-changes immediate

apply pending-changes immediate


To immediately apply pending changes to a service profile, use the apply pending-changes immediate
command.

apply pending-changes immediate

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A service profile must be created to use this command.

Examples This example shows how to immediately apply pending changes to a service profile.
Switch-A # scope org
Switch-A /org # scope service-profile example
Switch-A /org/service-profile # apply pending-changes immediate
Switch-A /org/service-profile* # commit-buffer
Switch-A /org/server-profile #

Related Commands Command Description


create service-profile
create org

Cisco UCS Manager CLI Command Reference, Release 2.0


108 OL-25718-02
Commands
associate server

associate server
To associate a server, use the associate server command.

associate server {ID | chassis-id/blade-id| restrict-migration}

Syntax Description ID Slot identification number. The


range of valid values is 1 to 255.

chassis-id/blade-id Chassis and blade identification


numbers. The range of valid values
is 1 to 4294967295.

restrict-migration (Optional). Use this option to


ensure that the operating system
boots appropriately when the
service profile is moved to a new
server.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced with chassis-id/blade-id option.

1.4(1) The option ID has been introduced to associate a server to the service profile
using the slot ID.
The option restrict-migration has been introduced.

Examples This example shows how to associate a server:

switch-A# scope org 1

switch-A /org # scope service-profile 1

switch-A /org/service-profile # associate server 1 restrict-migration

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 109
Commands
associate server

Related Commands Command Description


associate server-pool

show assoc
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


110 OL-25718-02
Commands
associate server-pool

associate server-pool
To associate a server pool with a service profile, use the associate server-pool command.

associate server-pool server-pool [ name ] restrict-migration

Syntax Description server-pool Server pool name. The range of valid values is 1 to 16.

name (Optional) Qualifier. The range of valid values is 1 to 16.

restrict-migration (Optional) Qualifier. Use this option to ensure that the operating system boots
appropriately when the service profile is moved to a new server.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) The option restrict-migration was introduced.

Examples This example shows how to associate a server pool:

switch-A# scope org 1

switch-A /org # scope service-profile 1

switch-A /org/service-profile # associate server-pool 1 restrict-migration

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show assoc
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 111
Commands
backup sel

backup sel
To back up the system event log (SEL), use the backup sel command.

backup sel ID chassis-d / blade-id

Syntax Description ID Specifies the server ID. It must be a value between 1 and
255.

chassis-id / blade-id Specifies the chassis number and server number in the format
A/B.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was modified to include the ID chassis-id / blade-id options.

Usage Guidelines Use this command to back up the system event log (SEL) for a server.
In the command mode of a specific server (/chassis/server), you can run this command without any options.

Examples This example shows how to back up the SEL for server 4 in chassis 2:
switch-A# backup sel 2/4
switch-A* # commit-buffer
switch-A#

Related Commands Command Description

Cisco UCS Manager CLI Command Reference, Release 2.0


112 OL-25718-02
Commands
cd

cd
To change directories, use the cd command in local management command mode.

cd {workspace:| [ path ]| volatile:| [ path ]| | [ path ]}

Syntax Description workspace: Specifies the workspace (flash) directory.

volatile: Specifies the volatile directory.

path Absolute or relative path.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

1.1(1) This command was modified. The bootflash: keyword is replaced by the
workspace: keyword.

Usage Guidelines This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.
This command operates on either the workspace (FLASH) or volatile (RAM) file system. To specify the file
system, include the workspace: or volatile: keyword in the path. If the file system is not specified, the
current working file system is assumed.

Examples This example shows how to change directories:


switch-A# connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 113
Commands
cd

switch-A(local-mgmt)# cd volatile:/temp
Pubs-A(local-mgmt)# pwd
volatile:temp
switch-A(local-mgmt)#

Cisco UCS Manager CLI Command Reference, Release 2.0


114 OL-25718-02
Commands
clear alertgroups

clear alertgroups
To clear all selected alert groups in a Call Home profile, use the clear alertgroups command.

clear alertgroups

This command has no arguments or keywords.

Command Default None

Command Modes Profile (/monitoring/callhome/profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to clear any previously configured alert group list within the Call Home profile.

Examples This example shows how to clear alert groups in a Call Home profile:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # scope profile profileOne
switch-A /monitoring/callhome/profile # clear alertgroups
switch-A /monitoring/callhome/profile* # commit-buffer
switch-A /monitoring/callhome/profile #

Related Commands Command Description


set alertgroups
show policy
show profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 115
Commands
clear auth-server-group

clear auth-server-group
To clear an authentication server group, use the clear auth-server-group command.

clear auth-server-group

This command has no arguments or keywords.

Command Default None

Command Modes Console Authentication (/security/console-auth)


Default Authentication (/security/default-auth)
Default Authentication within the Authentication Domain (/security/auth-domain)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to clear the authentication server group from an authentication domain.
UCS-A # scope security
UCS-A /security # scope auth-domain testing
UCS-A /security/auth-domain # clear auth-server-group
UCS-A /security/auth-domain* # commit-buffer
UCS-A /security/auth-domain #

Related Commands Command Description


create auth-server-group
delete auth-server-group
enter auth-server-group

scope auth-server-group

show auth-server-group

set auth-server-group

Cisco UCS Manager CLI Command Reference, Release 2.0


116 OL-25718-02
Commands
clear backup action

clear backup action


To clear all selected actions that will trigger a backup of the system event log, use the clear backup action
command.

clear backup action

This command has no arguments or keywords.

Command Default None

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to delete any previously configured list of actions that will trigger a backup of the system
event log.

Examples This example shows how to clear all selected actions that will trigger a backup of the system event log:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # clear backup action
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Related Commands Command Description


set backup action
show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 117
Commands
clear cores

clear cores
To clear core files, use the clear cores command.

clear cores

This command has no arguments or keywords.

Command Default None

Command Modes Sysdebug (/monitoring/sysdebug)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Core files are records of core dumps. Use the clear cores command to clear information out of core dump
records.

Examples This example shows how to clear core files:


switch-A# scope monitoring
switch-A /monitoring # scope sysdebug
switch-A /monitoring/sysdebug # clear cores
switch-A /monitoring/sysdebug # commit-buffer
switch-A /monitoring/sysdebug #

Related Commands Command Description


show alert-groups
show cores

Cisco UCS Manager CLI Command Reference, Release 2.0


118 OL-25718-02
Commands
clear file

clear file
To clear a license file, use the clear file command.

clear file name

Syntax Description name The name of the license file.

Command Default None

Command Modes License (/license)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A license file must exist to use this command.

Examples This example shows how to clear a license file.


Switch-A # scope license
Switch-A /license # clear file Sample
Switch-A /license* # commit-buffer
Switch-A /license #

Related Commands Command Description


install file

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 119
Commands
clear message

clear message
To clear the pre-login banner message, use the clear message command.

clear message

This command has no arguments or keywords.

Command Default None

Command Modes Pre-login banner mode (/security/banner/pre-login-banner)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines A pre-login banner message must be set earlier on to use this command.

Examples This example shows how to clear the pre-login banner message.
UCS-A # scope security
UCS-A /security # scope banner
UCS-A /security/banner # scope pre-login-banner
UCS-A /security/banner/pre-login-banner # clear message
UCS-A /security/banner/pre-login-banner #

Related Commands Command Description


set message

scope banner

scope pre-login-banner

Cisco UCS Manager CLI Command Reference, Release 2.0


120 OL-25718-02
Commands
clear password-history

clear password-history
To clear the password history for a local user, use the clear password-history command.

clear password-history

This command has no arguments or keywords.

Command Default None

Command Modes Local User (/security/local-user)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must be an administrator user or have aaa privileges to use this command.
You must create a local user and set the set clear password-history command to yes before you use this
command.

Examples This example shows how to clear the password history for a user:
UCS-A # scope security
UCS-A /security # scope local-user test
UCS-A /security/local-user # clear password-history
UCS-A /security/local-user* # commit-buffer
UCS-A /security/local-user #

Related Commands Command Description


set clear password-history
set password

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 121
Commands
clear sel (/chassis/server)

clear sel (/chassis/server)


To clear the contents of the system event log (SEL), use the clear sel command.

clear sel

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to clear the contents of the system event log (SEL).

Examples This example shows how to clear the contents of the SEL:
switch-A# scope server 2/4
switch-A /chassis/server # clear sel
switch-A /chassis/server* # commit-buffer
switch-A /chassis/server #

Related Commands Command Description


show sel

Cisco UCS Manager CLI Command Reference, Release 2.0


122 OL-25718-02
Commands
clear sel (/chassis/server)

clear sel (/chassis/server)


To clear the contents of the system event log (SEL), use the clear sel command.

clear sel

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to clear the contents of the system event log (SEL).

Examples This example shows how to clear the contents of the SEL:
switch-A# scope server 2/4
switch-A /chassis/server # clear sel
switch-A /chassis/server* # commit-buffer
switch-A /chassis/server #

Related Commands Command Description


show sel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 123
Commands
clear sshkey

clear sshkey
To clear from cache the SSH public key of a remote host, use the clear sshkey command in local management
mode.

clear sshkey host-name

Syntax Description host-name Host name or IP address. Specify the IP address in the format A.B.C.D.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to clear from cache the SSH public key of a remote host that supports SSH.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.

Examples This example shows how to clear the SSH public key of a remote host:
switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# clear sshkey 192.0.2.111


switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


124 OL-25718-02
Commands
cluster force primary

cluster force primary


To force a cluster to be the primary cluster, use the cluster force primary command.

cluster force primary

Command Default This command has no arguments or keywords.


None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines The cluster commands are switch-specific local management commands. You have to execute a connect
local-mgmt command to connect to the management port.

Examples This example shows how to force a cluster to be the primary cluster:

switch-A# connect local-mgmt

Nexus 5000 Switch


Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html
switch-A# cluster force primary

switch-A#

Related Commands Command Description


show cluster
show file

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 125
Commands
cluster lead

cluster lead
To designate a cluster leader, use the cluster lead command.

cluster lead [a| b]

Syntax Description a Specifies switch A.

b Specifies switch B.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines The cluster commands are switch-specific local management commands. You must first execute a connect
local-mgmt command to connect to the management port.

Examples This example shows how to designate a cluster leader:

switch-A# connect local-mgmt

Nexus 5000 Switch


Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html
switch-A# cluster lead b

switch-A#

Cisco UCS Manager CLI Command Reference, Release 2.0


126 OL-25718-02
Commands
cluster lead

Related Commands Command Description


show cluster
show files

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 127
Commands
commit-buffer

commit-buffer
To save or verify configuration changes, use the commit-buffer command.

commit-buffer [verify-only]

Syntax Description verify-only (Optional) Specifies verification only.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to execute all pending configuration changes. While any configuration commands are
pending, an asterisk (*) appears before the command prompt. When you enter the commit-buffer command,
the pending commands are committed and the asterisk disappears.

Examples This example shows how to save configuration changes:

switch-A# create org 3

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


discard-buffer
show configuration pending

Cisco UCS Manager CLI Command Reference, Release 2.0


128 OL-25718-02
Commands
connect adapter

connect adapter
To connect to an adapter, use the connect adapter command.

connect adapter chassis-id/server-id/adapter-id

Syntax Description chassis-id/server-id/adapter-id Adapter identification number.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to connect to an adapter:

switch-A# connect adapter 1/1/1

adapter 1/1 #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 129
Commands
connect bmc

connect bmc
To connect to the BMC (Baseboard Management Controller), use the connect bmc command.

connect bmc chassis-id/blade-id

Syntax Description chassis-id/blade-id Chassis and blade identification numbers.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples The following example shows how to connect to the Baseboard Management Controller:

switch-A# connect bmc 1/1

Trying 127.5.1.1...
Connected to 127.5.1.1.
Escape character is '^]'.

NUOVA-IBMC login:

Cisco UCS Manager CLI Command Reference, Release 2.0


130 OL-25718-02
Commands
connect clp

connect clp
To connect to DMTF CLP, use the connect clp command.

connect clp

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to connect to DMTF CLP:

switch-A# connect clp

/admin1 CLP ->

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 131
Commands
connect iom

connect iom
To connect to an IO module, use the connect iom command.

connect iom id

Syntax Description id Chassis identification number. The valid range of values is 1 to 255.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to connect to a IO module:

switch-A# connect iom 1

Attaching to FEX 1 ...


To exit type 'exit', to abort type '$.'
fex-1#

Cisco UCS Manager CLI Command Reference, Release 2.0


132 OL-25718-02
Commands
connect local-mgmt

connect local-mgmt
To connect to the local management port, use the connect local-mgmt command.

connect local-mgmt [a| b]

Syntax Description a Specifies switch A.

b Specifies switch B.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines If no switch is specified, a connection will be made to the local management port of the current active switch.

Examples This example shows how to connect to the local management port of switch B:
switch-A# connect local-mgmt b
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html
switch-B(local-mgmt)#

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 133
Commands
connect nxos

connect nxos
To connect to the NX-OS, use the connect nxos command.

connect nxos [a | b]

Syntax Description a (Optional) Specifies switch A.

b (Optional) Specifies switch B.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to NXOS:

switch-A-A# connect nxos b

Nexus 5000 Switch


Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html
switch-B#

Cisco UCS Manager CLI Command Reference, Release 2.0


134 OL-25718-02
Commands
copy

copy
To copy a file from one directory to another, use the copy command in local management command mode.

copy [ from-filesystem: ][ from-path ]filename [ to-filesystem: ]to-path[ dest-filename ]

Syntax Description from-filesystem: File system containing the file to be copied. See the Usage
Guidelines for valid values.

from-path Absolute or relative path to the file to be copied.

filename The name of the source file to be copied.

to-filesystem: File system to contain the copied file. See the Usage Guidelines
for valid values.

to-path Absolute or relative path to the copied file.

dest-filename (Optional) The new name for the copied file.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to copy a file in local management command mode.
If a dest-filename is specified, the copied file is renamed at the destination location.
If no file system is specified, the current working file system is assumed. If no path is specified, the current
working directory is assumed.
To specify the file system location, use the appropriate syntax from the following table:

ftp:[//[username@]server]
scp:[//[username@]server]
sftp:[//[username@]server]
tftp:[//server[:port]]

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 135
Commands
copy

volatile:
workspace:

Either the source or destination file system must be local; you cannot copy a file from one remote file system
to another.
If a remote protocol is specified with no server name, you are prompted to enter the server name.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.
This command operates on either the workspace (FLASH) or volatile (RAM) file system. To specify the file
system, include the workspace: or volatile: keyword in the path. If the file system is not specified, the
current working file system is assumed.
You can use the cp command as an alias for this command.

Examples This example shows how to copy a file from the current working directory to a directory in the volatile file
system:
switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# copy abcdef.bin volatile:/temp


switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


136 OL-25718-02
Commands
create adapter

create adapter
To create an adapter, use the create adapter command.

create adapter

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create an adapter:

switch-A# scope org org3

switch-A /org # scope server-qual sq2

switch-A /org/server-qual # create adapter

switch-A /org/server-qual/adapter* # commit-buffer

switch-A /org/server-qual/adapter #

Related Commands Command Description


show adapter
show chassis

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 137
Commands
create auth-domain

create auth-domain
To create an authentication domain, use the create auth-domain command.

create auth-domain name

Syntax Description name The name of the authentication domain. This name can include a maximum of 16
characters.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the authentication domain can include alphanumeric characters, but cannot include special
characters.

Examples This example shows how to create an authentication domain for the system:
Switch-A # scope security
Switch-A /security # create auth-domain Default
Switch-A /security/auth-domain* # commit-buffer
Switch-A /security/auth-domain #

Related Commands Command Description


delete auth-domain
scope auth-domain

Cisco UCS Manager CLI Command Reference, Release 2.0


138 OL-25718-02
Commands
create auth-profile

create auth-profile
To create an iSCSI authorization profile in the organization mode, use the create auth-profile command.

create auth-profile iscsi-auth-profile-name

Syntax Description iscsi-auth-profile-name The name of the iSCSI authorization profile. The name can include a maximum
of 16 characters. The name can be alphanumeric and can include special
characters as well.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines The name of the iSCSI authorization profile can include a maximum of 16 characters only. The name can be
alphanumeric and can include special characters as well.

Examples This example shows how to create an iSCSI authorization profile in the organization command mode.
UCS-A # scope org test
UCS-A /org # create auth-profile sample
UCS-A /org/auth-profile* # set user-id exampleuser
UCS-A /org/auth-profile* # set password
Enter password:
Confirm password:
UCS-A /org/auth-profile* # commit-buffer
UCS-A /org/auth-profile #

Related Commands Command Description


scope auth-profile

enter auth-profile

show auth-profile

delete auth-profile

set user-id

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 139
Commands
create auth-profile

Command Description
set password (auth-profile)

Cisco UCS Manager CLI Command Reference, Release 2.0


140 OL-25718-02
Commands
create auth-server-group

create auth-server-group
To create an authentication server group, use the create auth-server-group command.

create auth-server-group Authentication server group

Syntax Description Authentication server group The name of the authentication server group. This name can include
a maximum of 127 characters.

Command Default None

Command Modes LDAP (/security/ldap)


RADIUS (/security/radius)
TACACS (/security/tacacs)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the authentication server group can be alphanumeric, but special characters cannot be used.

Examples This example shows to create an authentication server group:


Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # create auth-server-group Default
Switch-A /security/ldap/auth-server-group* # commit-buffer
Switch-A /security/ldap/auth-server-group #

Related Commands Command Description


scope auth-server-group
delete auth-server-group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 141
Commands
create auto-target-if

create auto-target-if
To configure an automatic target for the Ethernet interface of an iSCSI VNIC, use the create auto-target-if
command.

create auto-target-if

This command has no arguments or keywords.

Command Default None

Command Modes Ethernet interface within the iSCSI VNIC mode (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI VNIC, and an Ethernet interface for the iSCSI VNIC before you can use this
command.

Examples This example shows how to create an automatic target interface for the Ethernet interface of the iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # create auto-target-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/auto-target-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/auto-target-if #

Related Commands Command Description


set dhcp-vendor-id

enter auto-target-if

scope auto-target-if

delete auto-target-if

show auto-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


142 OL-25718-02
Commands
create backup

create backup
To create a backup, use the create backup command.

create backup file {all-configuration| logical-configuration| system-configuration| full-state} {disabled|


enabled}

Syntax Description file Managment file name. Use one of the following keywords for file
type: ftp, scp, sftp, or tftp.

all-configuration Specifies a server, fabric, and system-related configuration backup.

logical-configuration Specifies a server and fabric backup.

system-configuration Specifies a system-related configuration backup.

full-state Specifies a full state backup for disaster recovery.

disabled Specifies disabled.

enabled Specifies enabled.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines No more than one backup can be created and committed.
When you specify disabled, backup functionality is disabled. When you specify enabled, backup functionality
is enabled.

Examples This example shows how to create a backup:

switch-A# scope system

switch-A /system # create backup ftp: full-state enabled

Password:
switch-A /system/backup* # commit-buffer

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 143
Commands
create backup

switch-A /system/backup #

Related Commands Command Description


show backup
show image

Cisco UCS Manager CLI Command Reference, Release 2.0


144 OL-25718-02
Commands
create bios-policy

create bios-policy
To create a BIOS policy, use the create bios-policy command.

create bios-policy policy-name

Syntax Description policy-name Policy name. The name can contain up to 16 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to create a BIOS policy and enter org BIOS policy mode.

Examples The following example shows how to create a BIOS policy and enter org BIOS policy mode:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 145
Commands
create bladeserver-disc-policy

create bladeserver-disc-policy
To create a compute blade discovery policy, use the create bladeserver-disc-policy command.

create bladeserver-disc-policy name

Syntax Description name Name of the compute blade discovery policy. This name can include a maximum of
16 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the policy can include alphanumeric characters, but cannot include special characters.

Examples This example shows how to create a computer blade discovery policy.
Switch-A # scope org
Switch-A /org # create bladeserver-disc-policy Sample
Switch-A /org/bladeserver-disc-policy* # commit buffer
Switch-A /org/bladeserver-disc-policy #

Related Commands Command Description


scope bladeserver-disc-policy
enter bladeserver-disc-policy
show bladeserver-disc-policy
delete bladeserver-disc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


146 OL-25718-02
Commands
create block

create block
To create a block, use the create block command.

IP pool configuration
create block from to default-gw subnet-mask

WWN pool, UUID pool, and MAC pool configuration


create block from to

IQN pool configuration


create block suffix from to

Syntax Description Suffix Specify a name that acts as a suffix


for the block for the IQN pool. The
name can include a maximum of
64 characters, and can be
alphanumeric.

from From address, identifier, or


world-wide name. Specify a MAC
address in the format
NN:NN:NN:NN:NN:NN. Specify
a UUID in the format
NNNN-NNNNNNNNNNNN.
Specify a WWN in the format
HH:HH:HH:HH:HH:HH:HH:HH.
Specify an IP address in the format
A.B.C.D.
For an IQN pool, you must specify
a number between 0 and 65535.

to To address, identifier, or
world-wide name. Specify a MAC
address in the format
NN:NN:NN:NN:NN:NN. Specify
a UUID in the format
NNNN-NNNNNNNNNNNN.
Specify a WWN in the format
HH:HH:HH:HH:HH:HH:HH:HH.
Specify an IP address in the format
A.B.C.D.
For an IQN pool, you must specify
a number between 0 and 65535.

default-gw Default gateway.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 147
Commands
create block

subnet-mask Subnet mask.

Command Default None

Command Modes IP pool (/org/ip-pool)


IQN pool (/org/iqn-pool)
WWN pool (/org/wwn-pool)
UUID suffix pool (/org/uuid-suffix-pool)
MAC pool (/org/mac-pool)

Command History Release Modification


1.0(1) This command was introduced.

2.0(2) This command was introduced in the IQN pool mode.

Usage Guidelines Use this command to create addresses, identifiers, and world-wide names.
Use IP pool configuration mode to create IP address blocks. Use WWN pool, UUID pool, and MAC pool
configuration mode to create addresses, UUIDs, and WWNs.

Examples This example shows how to create a block:


UCS-A # scope org org3
UCS-A /org # scope mac-pool mp1
UCS-A /org/mac-pool # create block 1a:2b:3c:4d:21:31 1b:2a:3c:4d:21:31
UCS-A /org/mac-pool* # commit-buffer
UCS-A /org/mac-pool #
------------------------------

UCS-A # scope org


UCS-A /org # scope iqn-pool sample1
UCS-A /org/iqn-pool # create block test1 1 60
UCS-A /org/iqn-pool* # commit-buffer
UCS-A /org/iqn-pool #

Related Commands Command Description


show mac-pool

show pooled

show iqn-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


148 OL-25718-02
Commands
create boot-definition

create boot-definition
To create a boot definition, use the create boot-definition command.

create boot-definition

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create a boot definition:

switch-A# scope org org3

switch-A /org # scope service-profile sp1

switch-A /org/service-profile # create boot-definition

switch-A /org/service-profile/boot-definition* # commit-buffer

switch-A /org/service-profile/boot-definition #

Related Commands Command Description


show boot-definition
show lan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 149
Commands
create boot-policy

create boot-policy
To create a boot policy, use the create boot-policy command.

create boot-policy name purpose {operational| utility}*

Syntax Description name Policy name. The range of valid values is 1 to 16.

purpose Specifies the purpose of the policy.

operational Specifies an operational policy.

utility Specifies a utility policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create a boot policy:

switch-A# scope org org3

switch-A /org # create boot-policy boot1

switch-A /org/boot-policy* #commit-buffer

switch-A /org/boot-policy #

Related Commands Command Description


show lan
show virtual-media

Cisco UCS Manager CLI Command Reference, Release 2.0


150 OL-25718-02
Commands
create boot-target

create boot-target
To create a boot-target object, use the create boot-target command.

create boot-target {primary| secondary}

Syntax Description primary Specifies the primary boot target.

secondary Specifies the secondary boot target.

Command Default None.

Command Modes WWN initiator(/org/wwn-pool/initiator)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to specify a boot target for a WWN initiator.

Examples The following example shows how to create a secondary boot target:
server# scope org
server /org # scope wwn-pool default
server /org/wwn-pool # scope initiator 20:00:00:25:B5:00:00:00
server /org/wwn-pool/initiator # create boot-target secondary
server /org/wwn-pool/initiator/boot-target* # commit-buffer
server /org/wwn-pool/initiator/boot-target #

Related Commands Command Description


delete boot-target
enter boot-target
scope boot-target
set lun
set wwn
show boot-target
show initiator

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 151
Commands
create cap-qual

create cap-qual
To create a capacity qualification, use the create cap-qual command.

create cap-qual {fcoe| non-virtualized-eth-if| non-virtualized-fc-if| path-encap-consolidated|


path-encap-virtual| protected-eth-if| protected-fc-if| protected-fcoe| virtualized-eth-if| virtualized-fc-if|
virtualized-scsi-if}

Syntax Description fcoe Specifies Fibre Channel over Ethernet.

non-virtualized-eth-if Specifies non-virtualized Ethernet interface.

non-virtualized-fc-if Specifies non-virtualized Fibre Channel interface.

path-encap-consolidated Specifies path encapsulation consolidated.

path-encap-virtual Specifies path encapsulation virtual.

protected-eth-if Specifies protected Ethernet interface.

protected-fc-if Specifies protected Fibre Channel interface.

protected-fcoe Specifies protected Fibre Channel over Ethernet.

virtualized-eth-if Specifies virtualized Ethernet interface.

virtualized-fc-if Specifies virtualized Fibre Channel interface.

virtualized-scsi-if Specifies virtualized SCSI interface.

Command Default None

Command Modes Adapter (/org/server-qual/adapter)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Creates an adapter capacity qualification for the specified adapter type and enters organization server
qualification adapter mode.

Cisco UCS Manager CLI Command Reference, Release 2.0


152 OL-25718-02
Commands
create cap-qual

Examples This example shows how to create a capacity qualification:


switch-A# scope org org3
switch-A /org # scope server-qual sq2
switch-A /org/server-qual # scope adapter 1/1/1
switch-A /org/server-qual/adapter # create cap-qual cq10
switch-A /org/server-qual/adapter* # commit-buffer
switch-A /org/server-qual/adapter #

Related Commands Command Description


show adapter
show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 153
Commands
create certreq

create certreq
To create a keyring certificate request, use the create certreq command.

create certreq ip | subject-name | password

Syntax Description ip Specifies IP address. The format is


A.B.C.D.

subject-name Subject name. The range of valid


values is 1 to 16.

password (Optional) Specifies password. The


range of valid values is 1 to 16.

Command Default None

Command Modes Keyring (/security/keyring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Before you create a certreq, you must set modulus.

Examples This example shows how to create a keyring certificate request:


UCS-A # scope security
UCS-A /security # scope keyring k1
UCS-A /security/keyring # create certreq subject-name cr3
UCS-A /security/keyring/certreq* # commit-buffer
UCS-A /security/keyring/certreq #

Related Commands Command Description


set country

set dns

set e-mail

set ip

Cisco UCS Manager CLI Command Reference, Release 2.0


154 OL-25718-02
Commands
create certreq

Command Description
set locality

set org-name

set org-unit-name

set password

set state

set subject-name

show certreq

show keyring

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 155
Commands
create chassis

create chassis
To create a chassis, use the create chassis command.

create chassis min-id max-id

Syntax Description min-id Minimum chassis identification number. The range of valid values is 1 to 255.

max-id Maximum chassis identification number. The range of valid values is 1 to 255.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Creates a chassis with the specified name, and enters organization chassis mode.

Examples This example shows how to create a chassis:

switch-A# scope org org3

switch-A /org # scope server-qual sq2

switch-A /org/server-qual # create chassis 2 2

switch-A /org/server-qual/chassis* # commit-buffer

switch-A /org/server-qual/chassis #

Related Commands Command Description


show chassis
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


156 OL-25718-02
Commands
create class chassis-stats

create class chassis-stats


To create a chassis statistics class, use the create class chassis-stats command.

create class chassis-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place thresholds on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for chassis statistics.

Examples This example shows how to create a chassis statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy tp10

switch-A /eth-server/stats-threshold-policy # create class chassis-stats

switch-A /eth-server/stats-threshold-policy* # commit-buffer

switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


show chassis
show class

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 157
Commands
create class cmc-stats

create class cmc-stats


To create a CMC statistics class, use the create class cmc-stats command.

create class cmc-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place thresholds on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for CMC statistics.

Examples This example shows how to create a chassis statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy tp10

switch-A /eth-server/stats-threshold-policy # create class cmc-stats

switch-A /eth-server/stats-threshold-policy* # commit-buffer

switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


158 OL-25718-02
Commands
create class cpu-env-stats

create class cpu-env-stats


To create the CPU environment statistics class, use the create class cpu-env-stats command.

create class cpu-env-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines When you create the class, you enter organization statistics threshold policy CPU environment class mode.
You can then create properties for this class with the create property command in the mode.

Examples This example shows how to create a CPU environment statistics class:
switch-A# scope org org100
switch-A /org # scope stats-threshold-policy stp100
switch-A /org/stats-threshold-policy # create class cpu-env-stats
switch-A /org/stats-threshold-policy/class* # commit-buffer
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 159
Commands
create class dimm-env-stats

create class dimm-env-stats


To create a dual in-line memory module (DIMM) environment statistics class, use the create class
dimm-env-stats command.

create class dimm-env-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to create a DIMM environment statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # create class dimm-env-stats
server /org/stats-threshold-policy/class* # commit-buffer
server /org/stats-threshold-policy/class #

Related Commands Command Description


delete class dimm-env-stats

enter class dimm-env-stats

scope class dimm-env-stats

show class dimm-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


160 OL-25718-02
Commands
create class dimm-stats

create class dimm-stats


To create a DIMM statistics class, use the create class dimm-stats command.

create class dimm-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for DIMMs.

Examples This example shows how to create a DIMM statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p1

switch-A /org/stats-threshold-policy # create class dimm-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 161
Commands
create class env-stats

create class env-stats


To create an environment statistics class, use the create class env-stats command.

create class env-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet server statistcics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to create an environment statistics class:


server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # create class env-stats
server /eth-server/stats-threshold-policy/class* # commit-buffer
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


delete class env-stats

enter class env-stats

scope class env-stats

show class env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


162 OL-25718-02
Commands
create class ether-error-stats

create class ether-error-stats


To create an Ethernet error statistics class, use the create class ether-error-stats command.

create class ether-error-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)


Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0 This command was introduced.

Usage Guidelines Use classes to place thresholds on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for Ethernet error statistics.

Examples This example shows how to create an Ethernet error statistics class:

switch-A# scope eth-uplink

switch-A /eth-uplink # scope stats-threshold-policy p10

switch-A /eth-uplink/stats-threshold-policy # create class ether-error-stats

switch-A /eth-uplink/stats-threshold-policy* # commit-buffer

switch-A /eth-uplink/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 163
Commands
create class ether-if-stats

create class ether-if-stats


To create an Ethernet interface statistics class, use the create class ether-if-stats command.

create class ether-if-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place a threshold on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for Ethernet interface statistics.

Examples This example shows how to create an Ethernet interface statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p1

switch-A /org/stats-threshold-policy # create class ether-if-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


164 OL-25718-02
Commands
create class ether-loss-stats

create class ether-loss-stats


To create an Ethernet loss statistics class, use the create class ether-loss-stats command.

create class ether-loss-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place a threshold on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for Ethernet loss statistics.

Examples This example shows how to create an Ethernet loss statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy p10

switch-A /eth-server/stats-threshold-policy # create class ether-loss-stats

switch-A /eth-server/stats-threshold-policy/class* # commit-buffer

switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 165
Commands
create class ether-pause-stats

create class ether-pause-stats


To create an Ethernet pause statistics class, use the create class ether-pause-stats command.

create class ether-pause-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.31. This command was introduced.

Usage Guidelines

Examples This example shows how to create a class for Ethernet pause statistics:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # create class ether-pause-stats
server /eth-server/stats-threshold-policy/class* # commit-buffer
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


delete class ether-pause-stats

enter class ether-pause-stats

scope class ether-pause-stats

show class ether-pause-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


166 OL-25718-02
Commands
create class ethernet-port-err-stats

create class ethernet-port-err-stats


To create an Ethernet port error statistics class, use the create class ethernet-port-err-stats command.

create class ethernet-port-err-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place a threshold on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for Ethernet port error statistics.

Examples This example shows how to create an Ethernet port error statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class ethernet-port-err-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 167
Commands
create class ethernet-port-multicast-stats

create class ethernet-port-multicast-stats


To create an Ethernet port multicast statistics class, use the create class ethernet-port-multicast-stats
command.

create class ethernet-port-multicast-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place a threshold on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for Ethernet port multicast statistics.

Examples This example shows how to create an Ethernet port multicast statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class ethernet-port-multicast-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


168 OL-25718-02
Commands
create class ethernet-port-over-under-sized-stats

create class ethernet-port-over-under-sized-stats


To create an Ethernet port over-under-sized statistics class, use the create class
ethernet-port-over-under-sized-stats command.

create class ethernet-port-over-under-sized-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place a threshold on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for Ethernet port over-under-sized statistics.

Examples This example shows how to create an Ethernet port statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class ethernet-port-over-under-sized-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 169
Commands
create class ethernet-port-stats

create class ethernet-port-stats


To create an Ethernet port statistics class, use the create class ethernet-port-stats command.

create class ethernet-port-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place a threshold on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for Ethernet port statistics.

Examples This example shows how to create an Ethernet port statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class ethernet-port-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


170 OL-25718-02
Commands
create class ethernet-port-stats-by-size-large-packets

create class ethernet-port-stats-by-size-large-packets


To create an Ethernet port large packet statistics class, use the create class
ethernet-port-stats-by-size-large-packets command.

create class ethernet-port-stats-by-size-large-packets

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place thresholds on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for Ethernet port small packet statistics.

Examples This example shows how to create an Ethernet port large packet statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class ethernet-port-stats-by-size-large-packets

switch-A /org/stats-threshold-policy/class* # commit-buffer

swicth-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 171
Commands
create class ethernet-port-stats-by-size-small-packets

create class ethernet-port-stats-by-size-small-packets


To create an Ethernet port small packet statistics class, use the create class
ethernet-port-stats-by-size-small-packets command.

create class ethernet-port-stats-by-size-small-packets

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place thresholds on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for Ethernet port small packet statistics.

Examples This example shows how to create an Ethernet port small packet statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class ethernet-port-stats-by-size-small-packets

switch-A /org/stats-threshold-policy/class* # commit-buffer

swicth-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


172 OL-25718-02
Commands
create class ether-rx-stats

create class ether-rx-stats


To create an Ethernet recieve statistics class, use the create class ether-rx-stats command.

create class ether-rx-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place a threshold on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for Ethernet recieve statistics.

Examples This example shows how to create an Ethernet recieve statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy p10

switch-A /eth-server/stats-threshold-policy # create class eth-rx-stats

switch-A /eth-server/stats-threshold-policy/class* # commit-buffer

switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show eth-uplink
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 173
Commands
create class ether-tx-stats

create class ether-tx-stats


To create an Ethernet transmission statistics class, use the create class ether-tx-stats command.

create class ether-tx-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)


Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place a threshold on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for Ethernet transmission statistics.

Examples This example shows how to create an Ethernet transmission statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy p10

switch-A /eth-server/stats-threshold-policy # create class eth-tx-stats

switch-A /eth-server/stats-threshold-policy/class* # commit-buffer

switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show eth-uplink
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


174 OL-25718-02
Commands
create class fan-module-stats

create class fan-module-stats


To create a fan module statistics class, use the create class fan-module-stats command.

create class fan-module-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for fan module statistics.

Examples This example shows how to create a fan module statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy p10

switch-A /eth-server/stats-threshold-policy # create class fan-module-stats

switch-A /eth-server/stats-threshold-policy* # commit-buffer

switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


show fan-module
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 175
Commands
create class fan-stats

create class fan-stats


To create a fan statistics class, use the create class fan-stats command.

create class fan-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to place thresholds on statistics. For example, you might want to define a threshold on a port that
raises a fault if the average number of packets dropped exceeds a certain amount. For this class, you would
create thresholds for fan statistics.

Examples This example shows how to create a fan statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy p10

switch-A /eth-server/stats-threshold-policy # create class fan-stats

switch-A /eth-server/stats-threshold-policy* # commit-buffer

switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


show fan-module
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


176 OL-25718-02
Commands
create class fc-error-stats

create class fc-error-stats


To create a Fibre Channel error statistics class, use the create class fc-error-stats command.

create class fc-error-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy /fc-uplink/stats-threshold-policy

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Fibre Channel error statistics.

Examples This example shows how to create a Fibre Channel error statistics class:

switch-A# scope fc-uplink

switch-A /org # scope stats-threshold-policy p10

Pubs-A /org/stats-threshold-policy # create class fc-error-stats

Pubs-A /org/stats-threshold-policy/class* # commit-buffer

Pubs-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 177
Commands
create class fc-if-event-stats

create class fc-if-event-stats


To create Fibre Channel event statistics, use the create class fc-if-event-stats command.

create class fc-if-event-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Fibre Channel event statistics.

Examples The following example

switch-A # scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class fc-if-event-stats

switch-A /org/stats-threshold-policy* # commit-buffer

switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


178 OL-25718-02
Commands
create class fc-if-fc4-counters

create class fc-if-fc4-counters


To create Fibre Channel counters, use the create class fc-if-fc4-counters command.

create class fc-if-fc4-counters

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Fibre Channel counter statistics.

Examples This example shows how to create Fibre Channel counters:

switch-A # scope org org3

switch-A /org # switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class fc-if-fc4-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 179
Commands
create class fc-if-frame-stats

create class fc-if-frame-stats


To create a Fibre Channel frame statistics class, use the create class fc-if-frame-stats command.

create class fc-if-frame-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Fibre Channel frame statistics.

Examples This example shows how to create a Fibre Channel frame statistics class:

switch-A # scope org org3

switch-A /org # switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class fc-if-frame-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


180 OL-25718-02
Commands
create class fc-port-stats

create class fc-port-stats


To create Fibre Channel port statistics class, use the create class fc-port-stats command.

create class fc-port-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Fibre Channel port statistics.

Examples This example shows how to create a Fibre Channel port statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class fc-port-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 181
Commands
create class fc-stats

create class fc-stats


To create a Fibre Channel statistics class, use the create class fc-stats command.

create class fc-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/fc-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Fibre Channel statistics.

Examples This example shows how to create a Fibre Channel statistics class:

switch-A# scope fc-uplink

switch-A /fc-uplink # scope stats-threshold-policy p10

switch-A /fc-uplink/stats-threshold-policy # create class fc-stats

switch-A /fc-uplink/stats-threshold-policy/class* # commit-buffer

switch-A /fc-uplink/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


182 OL-25718-02
Commands
create class fex-env-stats

create class fex-env-stats


To create an Fex environment statistics class, use the create class fex-env-stats command.

create class fex-env-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics Threshold Policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to create an Fex environment statistics class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # create class fex-env-stats
Switch-A /eth-server/stats-threshold-policy/class* # commit-buffer
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


scope class fex-env-stats
delete class fex-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 183
Commands
create class fex-power-summary

create class fex-power-summary


To create an Fex power summary statistics class, use the create class fex-power-summary command.

create class fex-power-summary

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to create an Fex power summary statistics class.
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # create class fex-power-summary
Switch-A /eth-server/stats-threshold-policy/class* # commit-buffer
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


scope class fex-power-summary
delete class fex-power-summary

Cisco UCS Manager CLI Command Reference, Release 2.0


184 OL-25718-02
Commands
create class fex-psu-input-stats

create class fex-psu-input-stats


To create an Fex power supply input statistics class, use the create class fex-psu-input-stats command.

create class fex-psu-input-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to create an Fex power supply input statistics class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # create class fex-psu-input-stats
Switch-A /eth-server/stats-threshold-policy/class* # commit-buffer
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


scope class fex-psu-input-stats
delete class fex-psu-input-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 185
Commands
create class io-card-stats

create class io-card-stats


To create an Ethernet IO card statistics class, use the create class io-card-stats command.

create class io-card-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to create an IO card statistics class:


server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # create class io-card-stats
server /eth-server/stats-threshold-policy/class* # commit-buffer
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


delete class io-card-stats

enter class io-card-stats

scope class io-card-stats

show class io-card-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


186 OL-25718-02
Commands
create class mb-power-stats

create class mb-power-stats


To create a mother board power statistics class, use the create class mb-power-stats command.

create class mb-power-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for mother board power statistics.

Examples This example shows how to create a mother board power statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class mb-power-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 187
Commands
create class mb-temp-stats

create class mb-temp-stats


To create a temporary mother board statistics class, use the create class mb-temp-stats command.

create class mb-temp-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Mb statistics.

Examples This example shows how to create a temporary mother board statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class mb-temp-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show class mb-temp-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


188 OL-25718-02
Commands
create class memory-array-env-stats

create class memory-array-env-stats


To create a class for memory array environment statistics, use the create class memory-array-env-stats
command.

create class memory-array-env-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistcis threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to create a class to store the memory array environment statistics:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # create class memory-array-env-stats
server /org/stats-threshold-policy/class* # commit-buffer
server /org/stats-threshold-policy/class #

Related Commands Command Description


delete class memory-array-env-stats

enter class memory-array-env-stats

scope class memory-array-env-stats

show class memory-array-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 189
Commands
create class memory-runtime

create class memory-runtime


To create a memory runtime class, use the create class memory-runtime command.

create class memory-runtime

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create a memory runtime class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class memory-runtime

switch-A /org/stats-threshold-policy* # commit-buffer

switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class
show memory

Cisco UCS Manager CLI Command Reference, Release 2.0


190 OL-25718-02
Commands
create class menlo-dce-port-stats

create class menlo-dce-port-stats


To create a Menlo port statistics class, use the create class menlo-dce-port-stats command.

create class menlo-dce-port-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo Ethernet port statistics.

Examples This example shows how to create a Menlo port statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-dce-port-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 191
Commands
create class menlo-eth-error-stats

create class menlo-eth-error-stats


To create a Menlo Ethernet error statistics class, use the create class menlo-eth-error-stats command.

create class menlo-eth-error-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo Ethernet error statistics.

Examples This example shows how to create a Menlo Ethernet error statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-eth-error-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


192 OL-25718-02
Commands
create class menlo-eth-stats

create class menlo-eth-stats


To create a Menlo Ethernet statistics class, use the create class menlo-eth-stats command.

create class menlo-eth-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo Ethernet statistics.

Examples This example shows how to create a Menlo Ethernet statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-eth-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 193
Commands
create class menlo-fc-error-stats

create class menlo-fc-error-stats


To create Menlo Fibre Channel error statistics, use the create class menlo-fc-error-stats command.

create class menlo-fc-error-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo Fibre Channel error statistics.

Examples This example shows how to create Menlo Fibre Channel error statistics:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-fc-error-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


194 OL-25718-02
Commands
create class menlo-fc-stats

create class menlo-fc-stats


To create Menlo Fibre Channel statistics, use the create class menlo-fc-stats command.

create class menlo-fc-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo Fibre Channel statistics.

Examples This example shows how to create Menlo Fibre Channel statistics:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-fc-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 195
Commands
create class menlo-host-port-stats

create class menlo-host-port-stats


To create Menlo host port statistics, use the create class menlo-host-port-stats command.

create class menlo-host-port-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo host port statistics.

Examples This example shows how to create Menlo host port statistics:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-host-port-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


196 OL-25718-02
Commands
create class menlo-mcpu-error-stats

create class menlo-mcpu-error-stats


To create a Menlo CPU error statistics class, use the create class menlo-mcpu-error-stats command.

create class menlo-mcpu-error-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo CPU error statistics.

Examples This example shows how to create a Menlo CPU error statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-mcpu-error-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 197
Commands
create class menlo-mcpu-stats

create class menlo-mcpu-stats


To create a Menlo CPU statistics class, use the create class menlo-mcpu-stats command.

create class menlo-mcpu-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo CPU statistics.

Examples This example shows how to create a Menlo CPU statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-mcpu-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


198 OL-25718-02
Commands
create class menlo-net-eg-stats

create class menlo-net-eg-stats


To create a Menlo network egress statistics class, use the create class menlo-net-eg-stats command.

create class menlo-net-eg-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo network egress traffic statistics.

Examples This example shows how to create a Menlo network egress statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-net-eg-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 199
Commands
create class menlo-net-in-stats

create class menlo-net-in-stats


To create a Menlo network ingress statistics class, use the create class menlo-net-in-stats command.

create class menlo-net-in-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo network ingress traffic statistics.

Examples This example shows how to create a Menlo network ingress statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-net-in-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


200 OL-25718-02
Commands
create class menlo-q-error-stats

create class menlo-q-error-stats


To create a Menlo Qlogic error statistics class, use the create class menlo-q-error-stats command.

create class menlo-q-error-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo Qlogic error statistics.

Examples This example shows how to create a Menlo Qlogic error statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-q-error-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 201
Commands
create class menlo-q-stats

create class menlo-q-stats


To create a Menlo Qlogic statistics class, use the create class menlo-q-stats command.

create class menlo-q-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Menlo Qlogic statistics.

Examples This example shows how to create a Menlo Qlogic statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class menlo-q-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


202 OL-25718-02
Commands
create class motherboard-temp-stats

create class motherboard-temp-stats


To create a motherboard temperature statistics class, use the create class motherboard-temp-stats command.

create class motherboard-temp-stats

Command Default None

Command Modes Statistics Threshold Policy (/org/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created in the organization mode to use this command.

Examples This example shows how to create a motherboard temperature statistics class.
UCS-A # scope org Test
UCS-A /org # scope stats-threshold-policy sample
UCS-A /org/stats-threshold-policy # create class motherboard-temp-stats
UCS-A /org/stats-threshold-policy/class* # commit-buffer
UCS-A /org/stats-threshold-policy/class #

Related Commands Command Description


enter class motherboard-temp-stats

scope class motherboard-temp-stats

show class motherboard-temp-stats

delete class motherboard-temp-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 203
Commands
create class pcie-fatal-completion-error-stats

create class pcie-fatal-completion-error-stats


To create a Peripheral Component Interconnect (PCI) Express (PCIe) fatal completion error statistics class,
use the create class pcie-fatal-completion-error-stats command.

create class pcie-fatal-completion-error-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to create a PCIe fatal completion error statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # create class pcie-fatal-completion-error-stats
server /org/stats-threshold-policy/class* # commit-buffer
server /org/stats-threshold-policy/class #

Related Commands Command Description


delete class pcie-fatal-completion-error-stats

enter class pcie-fatal-completion-error-stats

scope class pcie-fatal-completion-error-stats

show class pcie-fatal-completion-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


204 OL-25718-02
Commands
create class pcie-fatal-error-stats

create class pcie-fatal-error-stats


To create a Peripheral Component Interconnect (PCI) Express (PCIe) fatal errors statistics class, use the
create class pcie-fatal-error-stats command.

create class pcie-fatal-error-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to create a PCIe fatal error statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # create class pcie-fatal-error-stats
server /org/stats-threshold-policy/class* # commit-buffer
server /org/stats-threshold-policy/class #

Related Commands Command Description


delete class pcie-fatal-error-stats

enter class pcie-fatal-error-stats

scope class pcie-fatal-error-stats

show class pcie-fatal-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 205
Commands
create class pcie-fatal-protocol-error-stats

create class pcie-fatal-protocol-error-stats


To create a Peripheral Component Interconnect (PCI) Express (PCIe) fatal protocol error statistics class, use
the create class pcie-fatal-protocol-error-stats command.

create class pcie-fatal-protocol-error-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to create a PCIe fatal protocol error statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # create class pcie-fatal-protocol-error-stats
server /org/stats-threshold-policy/class* # commit-buffer
server /org/stats-threshold-policy/class #

Related Commands Command Description


delete class pcie-fatal-protocol-error-stats

enter class pcie-fatal-protocol-error-stats

scope class pcie-fatal-protocol-error-stats

show class pcie-fatal-protocol-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


206 OL-25718-02
Commands
create class pcie-fatal-receiving-error-stats

create class pcie-fatal-receiving-error-stats


To create a Peripheral Component Interconnect (PCI) Express (PCIe) fatal receive errors statistics class, use
the create class pcie-fatal-receiving-error-stats command.

create class pcie-fatal-receiving-error-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to create a PCIe fatal receive errors statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # create class pcie-fatal-receiving-error-stats
server /org/stats-threshold-policy/class* # commit-buffer
server /org/stats-threshold-policy/class #

Related Commands Command Description


delete class pcie-fatal-receiving-error-stats

enter class pcie-fatal-receiving-error-stats

scope class pcie-fatal-receiving-error-stats

show class pcie-fatal-receiving-error-statss

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 207
Commands
create class processor-runtime

create class processor-runtime


To create a processor runtime statistics class, use the create class processor-runtime command.

create class processor-runtime

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create a processor runtime statistics class:

switch-A# scope org org10

switch-A /org # scope stats-threshold-policy p10

switch-A /org/stats-threshold-policy # create class processor-runtime

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-statistics

Cisco UCS Manager CLI Command Reference, Release 2.0


208 OL-25718-02
Commands
create class psu-input-stats

create class psu-input-stats


To create a power supply input statistics class, use the create class psu-input-stats command.

create class psu-input-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for power supply input statistics.

Examples This example shows how to create a power supply input statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy p10

switch-A /eth-server/stats-threshold-policy # create class psu-input-stats

switch-A /eth-server/stats-threshold-policy/class* # commit-buffer

switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 209
Commands
create class psu-stats

create class psu-stats


To create a power supply statistics class, use the create class psu-stats command.

create class psu-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for power supply statistics.

Examples This example shows how to create power supply statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy p10

switch-A /eth-server/stats-threshold-policy # create class psu-stats

switch-A /eth-server/stats-threshold-policy/class* # commit-buffer

switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


210 OL-25718-02
Commands
create class rack-unit-fan-stats

create class rack-unit-fan-stats


To create a rack unit fan statistics class, use the create class rack-unit-fan-stats command.

create class rack-unit-fan-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to create a rack unit fan statistics class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # create class rack-unit-fan-stats
Switch-A /eth-server/stats-threshold-policy/class* # commit-buffer
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


scope class rack-unit-fan-stats
delete class rack-unit-fan-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 211
Commands
create class rack-unit-psu-stats

create class rack-unit-psu-stats


To create a rack unit power supply statistics class, use the create class rack-unit-psu-stats command.

create class rack-unit-psu-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to create a rack unit power supply statistics class:
Switch-A # scope org
Switch-A /org # scope stats-threshold-policy Default
Switch-A /org/stats-threshold-policy # create class rack-unit-psu-stats
Switch-A /org/stats-threshold-policy/class* # commit-buffer
Switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


scope class rack-unit-psu-stats
delete class rack-unit-psu-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


212 OL-25718-02
Commands
create class system-stats

create class system-stats


To create a system statistics class, use the create class system-stats command.

create class system-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for system statistics.

Examples This example shows how to create a system statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy p10

switch-A /eth-server/stats-threshold-policy # create class system-stats

switch-A /eth-server/stats-threshold-policy/class* # commit-buffer

switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show class
show system

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 213
Commands
create class vnic-stats

create class vnic-stats


To create a Virtual NIC statistics class, use the create class vnic-stats command.

create class vnic-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use classes to threshold statistics. For example, you might want to define a threshold on a port that raises a
fault if the average number of packets dropped exceeds a certain amount. For this class, you would create
thresholds for Virtual NIC statistics.

Examples This example shows how to create a Virtual NIC statistics class:

switch-A# scope org org3

switch-A /org # scope stats-threshold-policy p1

switch-A /org/stats-threshold-policy # create class vnic-stats

switch-A /org/stats-threshold-policy/class* # commit-buffer

switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


214 OL-25718-02
Commands
create client

create client
To create a client, use the create client command in port-profile mode.

create client client-name

Syntax Description client-name The name of the client. A unique set of numbers or letters that identifies the
client. The range of valid values is 1 to 16.

Command Default None

Command Modes Profile set (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Creates a client for a port profile. It also enters you into system VM management VMware profile set port
profile mode. This command is used along with other commands to configure port profiles.

Examples This example shows how to create a client:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope profile-set
switch-A /system/vm-mgmt/vmware/profile-set # scope port-profile pp100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile # create client c100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile* # commit-buffer
switch-A /system/vm-mgmt/vmware/profile-set/port-profile #

Related Commands Command Description


show port profile
show profile-set

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 215
Commands
create cluster

create cluster
To create a distributed virtual switch, use the create cluster command.

create cluster name

Syntax Description name The name of the distributed virtual switch. The name can include a maximum of 16
characters.

Command Default None

Command Modes Cluster set (/system/vm-mgmt/cluster-set)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines The name of the distributed virtual switch can include a maximum of 16 characters.

Examples This example shows how to a create a distributed virtual switch.


UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope cluster-set
UCS-A /system/vm-mgmt/cluster-set # create cluster sample
UCS-A /system/vm-mgmt/cluster-set/cluster* # commit-buffer
UCS-A /system/vm-mgmt/cluster-set/cluster #

Related Commands Command Description


enter cluster

scope cluster

show cluster

delete cluster

Cisco UCS Manager CLI Command Reference, Release 2.0


216 OL-25718-02
Commands
create cpu

create cpu
To create a CPU qualifier for a server pool policy, use the create cpu command.

create cpu

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command create a CPU qualifier for a server pool policy, and to enter organization CPU mode.
Only one CPU qualifier can be created.

Examples This example shows how to create a CPU qualifier:


switch# scope org org3
switch /org # scope server-qual sq20
switch /org/server-qual # create cpu
switch /org/server-qual/cpu* # commit-buffer
switch /org/server-qual/cpu #

Related Commands Command Description


show cpu
show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 217
Commands
create data-center

create data-center
To create a data center, use the create data-center command in vcenter mode. You can also create a data
center in folder mode.

create data-center datacenter-name

Syntax Description datacenter-name The name of the data center. A unique set of numbers or letters that identifies
the data center. The range of valid values is 1 to 16.

Command Default None

Command Modes VCenter (/system/vm-mgmt/vmware/vcenter)


Folder (/system/vm-mgmt/vmware/vcenter/folder

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Data center

Examples This example shows how to create a data center:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter
switch-A /system/vm-mgmt/vmware/vcenter # create data-center dc10
switch-A /system/vm-mgmt/vmware/vcenter* # commit-buffer
switch-A /system/vm-mgmt/vmware/vcenter #

Related Commands Command Description


show data-center
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


218 OL-25718-02
Commands
create default-auth

create default-auth
To create a default authentication method for an authentication domain, use the create default-auth command.

create default-auth

This command has no arguments or keywords.

Command Default None

Command Modes Authentication Domain (/security/auth-domain)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication domain must be created to use this command.

Examples This example shows how to create a default authentication method for an authentication domain:
Switch-A # scope security
Switch-A /security # scope auth-domain Default
Switch-A /security/auth-domain # create default-auth
Switch-A /security/auth-domain/default-auth* # commit-buffer
Switch-A /security/auth-domain/default-auth #

Related Commands Command Description


scope default-auth
delete default-auth

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 219
Commands
create default-behavior

create default-behavior
To create a default behavior mode, use the create default-behavior command.

create default-behavior {vhba | vnic}

Syntax Description vhba Specifies vHBA default behavior mode.

vnic Specifies vNIC default behavior mode.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to create a default behavior, and enter organization default-behavior mode.
hw-inherit sets

Examples This example shows how to create a vNIC default behavior mode:
switch-A# scope org org10
switch-A /org # scope service-profile sp10
switch-A /org/service-profile # create default-behavior vnic
switch-A /org/service-profile/default-behavior* # commit-buffer
switch-A /org/service-profile/default-behavior #

Related Commands Command Description


show default-behavior
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


220 OL-25718-02
Commands
create destination

create destination
To create an email destination, use the create destination command.

create destination email

Syntax Description email Email destination.

Command Default None

Command Modes Profile (/monitoring/callhome/profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create an email destination:

switch-A# scope monitoring

switch-A /monitoring # scope callhome

switch-A /monitoring/callhome # scope profile p3

switch-A /monitoring/callhome/profile # create destination home@test.com

switch-A /monitoring/callhome/profile* # commit-buffer

switch-A /monitoring/callhome/profile #

Related Commands Command Description


show callhome
show destination

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 221
Commands
create dest-interface

create dest-interface
To create a destination interface for the Fibre Channel traffic monitoring session or the Ethernet traffic
monitoring session, use the create dest-interface command.

create dest-interface slotid portid

Syntax Description slotid The slot ID of the interface. It must be a value between 1-5

portid The port ID of the interface. It must be a value between 1-40.

Command Default None

Command Modes Fibre Channel traffic monitoring session (/fc-traffic-mon/fabric/fc-mon-session)


Ethernet traffic monitoring session (/eth-traffic-mon/fabric/eth-mon-session)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A Fibre Channel traffic monitoring session or an Ethernet traffic monitoring session must be created prior to
using this command.

Examples This example shows how to create a destination interface for the Ethernet traffic monitoring session.
To create a destination interface for the Fibre Channel traffic monitoring session, replace eth-traffic-mon
with fc-traffic-mon , and eth-mon-session with fc-mon-session .
Switch-A # scope eth-traffic-mon
Switch-A /eth-traffic-mon # scope fabric a
Switch-A /eth-traffic-mon/fabric # scope eth-mon-session Default
Switch-A /eth-traffic-mon/fabric/eth-mon-session # create dest-interface 2 33
Switch-A /eth-traffic-mon/fabric/eth-mon-session/dest-interface* # commit buffer
Switch-A /eth-traffic-mon/fabric/eth-mon-session/dest-interface #

Related Commands Command Description


delete dest-interface

Cisco UCS Manager CLI Command Reference, Release 2.0


222 OL-25718-02
Commands
create dhcp-ip-params

create dhcp-ip-params
To configure DHCP for initiator IP parameters, use the create dhcp-ip-params command.

create dhcp-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface of the iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an IPv4 interface for an iSCSI VNIC before you use this command.

Examples This example shows how to configure the DHCP for initiator IP parameters:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # create dhcp-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/dhcp-ip-params* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/dhcp-ip-params #

Related Commands Command Description


enter dhcp-ip-params

scope dhcp-ip-params

delete dhcp-ip-params

create pooled-ip-params

create static-ip-params

create ip-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 223
Commands
create distributed-virtual-switch

create distributed-virtual-switch
To create a distributed virtual switch, use the create distributed-virtual-switch command in folder mode.

create distributed-virtual-switch dvs-name

Syntax Description dvs-name The name of the switch. A unique set of numbers or letters that identifies the
switch. The range of valid values is 1 to 16.

Command Default
• Admin State is disabled
• UUID is 00000000-0000-0000-0000-000000000000
• Extension key is blank

Command Modes VMware (/system/vm-mgmt/vmware/vcenter/data-center/folder)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Distributed virtual switch

Examples This example shows how to create a distributed virtual switch:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc10
switch-A /system/vm-mgmt/vmware/vcenter # scope data-center dc10
switch-A /system/vm-mgmt/vmware/vcenter/data-center # scope folder f10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder # create distributed-virtual-switch
dvs10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder* # commit-buffer
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder #

Related Commands Command Description


show distributed-virtual-switch
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


224 OL-25718-02
Commands
create dns

create dns
To create a DNS host name , use the create dns command.

create dns name

Syntax Description name DNS host name. The range of valid values is 1 to 16.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create a DNS host name:

switch-A# scope system

switch-A /system # scope services

switch-A /system/services # create dns dns10

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show dns
show ntp

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 225
Commands
create dynamic-vnic-conn

create dynamic-vnic-conn
To create a dynamic vNIC connection, use the create dynamic-vnic-conn command.

create dynamic-vnic-conn

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines The vNIC connection policy determines how the VN-link connectivity between VMs and dynamic vNICs is
configured. This policy is required for Cisco UCS domains that include servers with Cisco UCS M81KR
Virtual Interface Card adapters that host VMs and dynamic vNICs.
Each dynamic vNIC connection policy must include an adapter policy and designate the number of vNICs
that can be configured for any server associated with a service profile that includes the policy.

Examples This example shows how to create a dynamic vNIC connection:

switch-A# scope org org10


switch-A /org # scope service-profile sp10
switch-A /org/service-profile # create dynamic-vnic-conn
switch-A /org/service-profile* # commit-buffer
switch-A /org/service-profile #

Related Commands Command Description


show dynamic-vnic-con
show dynamic-vnic-con-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


226 OL-25718-02
Commands
create dynamic-vnic-conn-policy

create dynamic-vnic-conn-policy
To create a dynamic vNIC connection policy, use the create dynamic-vnic-conn-policy command.

create dynamic-vnic-conn-policy policy-name

Syntax Description policy-name The name of the vNIC connection policy. The range of valid values is 1 to
16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines The vNIC connection policy determines how the VN-link connectivity between VMs and dynamic vNICs is
configured. This policy is required for Cisco UCS domains that include servers with Cisco UCS M81KR
Virtual Interface Card adapters that host VMs and dynamic vNICs.
Each dynamic vNIC connection policy must include an adapter policy and designate the number of vNICs
that can be configured for any server associated with a service profile that includes the policy.

Examples This example shows how to create a dynamic VNIC connection policy:

switch-A# scope org org10


switch-A /org # create dynamic-vnic-conn-policy dvcp10
switch-A /org/dynamic-vnic-conn-policy* # commit-buffer
switch-A /org/dynamic-vnic-conn-policy #

Related Commands Command Description


show dynamic-vnic-connection-policy
show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 227
Commands
create egress-policy

create egress-policy
To create an egress policy, use the create data-center command in vcenter mode. You can also create a
data center in folder mode.

create egress-policy policy-name

Syntax Description policy-name The name of the policy. A unique set of numbers or letters that identifies the
policy. The range of valid values is 1 to 16.

Command Default None

Command Modes Egress policy (/org/qos-policy/egress-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Data center

Examples This example shows how to create a data center:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter
switch-A /system/vm-mgmt/vmware/vcenter # create data-center dc10
switch-A /system/vm-mgmt/vmware/vcenter* # commit-buffer
switch-A /system/vm-mgmt/vmware/vcenter #

Related Commands Command Description


show data-center
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


228 OL-25718-02
Commands
create eth-if

create eth-if
To create an Ethernet interface, use the create eth-if command.

create eth-if name

Syntax Description name Interface name. The range of valid values is 1 to 16.

Command Default None

Command Modes Virtual NIC (/org/service-profile/vnic)


Virtual NIC template (/org/vnic-templ)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create an Ethernet interface:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # scope vnic vn10

switch-A /org/service-profile/vnic # create eth-if if10

switch-A /org/service-profile/vnic/eth-if* # commit-buffer

switch-A /org/service-profile/vnic/eth-if #

Related Commands Command Description


show eth-profile
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 229
Commands
create eth-if (vnic-iscsi)

create eth-if (vnic-iscsi)


To create an Ethernet interface for an iSCSI VNIC, use the create eth-if command.

create eth-if

This command has no arguments or keywords.

Command Default None

Command Modes ISCSI VNIC (/org/service-profile/vnic-iscsi)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a service profile and an iSCSI VNIC for the service profile before you use this command.

Examples This example shows how to create an Ethernet interface for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-isci testing
UCS-A /org/service-profile/vnic-iscsi # create eth-if
UCS-A /org/service-profile/vnic-iscsi* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if #

Related Commands Command Description


enter eth-if

scope eth-if

create ip-if

Cisco UCS Manager CLI Command Reference, Release 2.0


230 OL-25718-02
Commands
create eth-mon-session

create eth-mon-session
To create an Ethernet traffic monitoring session mode, use the create eth-mon-session command.

create eth-mon-session name

Syntax Description name The name of the Ethernet traffic monitoring session. The name can include a maximum
of 16 characters.

Command Default None

Command Modes Fabric (/eth-traffic-mon/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the session can include alphanumeric characters. You cannot include special characters.

Examples This example shows how to create an Ethernet traffic monitoring session:
Switch-A # scope eth-traffic-mon
Switch-A /eth-traffic-mon # scope fabric a
Switch-A /eth-traffic-mon/fabric # create eth-mon-session Default
Switch-A /eth-traffic-mon/fabric/eth-mon-session* # commit-buffer
Switch-A /eth-traffic-mon/fabric/eth-mon-session #

Related Commands Command Description


scope eth-mon-session
delete eth-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 231
Commands
create eth-policy

create eth-policy
To create an Ethernet policy, use the create eth-policy command.

create eth-policy name

Syntax Description policy-name The name of the Ethernet policy. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create Ethernet policy ep100 in org100 mode:

switch-A# scope org org100

switch-A /org # create eth-policy ep100

switch-A /org/eth-policy* # commit-buffer

switch-A /org/eth-policy #

Related Commands Command Description


show eth-policy
show trans-queue

Cisco UCS Manager CLI Command Reference, Release 2.0


232 OL-25718-02
Commands
create eth-target

create eth-target
To create an Ethernet target endpoint for a fabric interface, use the create eth-target command.

create eth-target name

Syntax Description name Name of the Ethernet target endpoint. The name can include a maximum of 16
characters.

Command Default None

Command Modes Interface (/eth-storage/fabric/interface)


Port channel (/eth-storage/fabric/port-channel)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create an interface for a fabric before you use this command.
You must create a port channel for a fabric before you use this command.
The name of the Ethernet target endpoint can be alphanumeric, but cannot include special characters.

Examples This example shows how to create an Ethernet target endpoint for a fabric interface:
Switch-A # scope eth-storage
Switch-A /eth-storage # scope fabric a
Switch-A /eth-storage/fabric # scope interface 2 33
Switch-A /eth-storage/fabric/interface # create eth-target Testing
Switch-A /eth-storage/fabric/interface/eth-target* # commit-buffer
Switch-A /eth-storage/fabric/interface/eth-target #

Related Commands Command Description


set macaddress
scope eth-target
enter eth-target
show eth-target
delete eth-target

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 233
Commands
create ext-static-ip

create ext-static-ip
To create an external static management IP, use the create ext-static-ip command.

create ext-static-ip

This command has no arguments or keywords.

Command Default None

Command Modes CIMC (/chassis/server/cimc)


Service profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A service profile must be created to use this command.


You cannot use this command to set an external static management IP for a service profile that uses an initial
template.

Examples This example shows how to set an external static management IP address for the CIMC.
Switch-A # scope server 1/7
Switch-A /chassis/server # scope cimc
Switch-A /chassis/server/cimc # create ext-static-ip
Switch-A /chassis/server/cimc/ext-static-ip* # commit-buffer
Switch-A /chassis/server/cimc/ext-static-ip #

Related Commands Command Description


scope ext-static-ip
enter ext-static-ip
show ext-static-ip
delete ext-static-ip

Cisco UCS Manager CLI Command Reference, Release 2.0


234 OL-25718-02
Commands
create fc-mon-session

create fc-mon-session
To create a Fibre Channel traffic monitoring session, use the create fc-mon-session command.

create fc-mon-session Name

Syntax Description Name Name of the monitoring session. The name can include a maximum of 16 characters,
and can include alphanumeric characters.

Command Default None

Command Modes Fabric (/fc-traffic-mon/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The Fibre Channel traffic monitoring session must be created prior to using this command.
The name of the Fibre Channel monitoring session cannot include special characters.

Examples This example shows how to create a Fibre Channel monitoring session:
Switch-A # scope fc-traffic-mon
Switch-A /fc-traffic-mon # scope fabric a
Switch-A /fc-traffic-mon/fabric # create fc-mon-session Default
Switch-A /fc-traffic-mon/fabric/fc-mon-session* # commit-buffer

Related Commands Command Description


scope fc-mon-session
delete fc-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 235
Commands
create fcoe-if

create fcoe-if
To create a FCoE (Fibre Channel over Ethernet) interface, use the create fcoe-if command.

create fcoe-if

This command has no arguments or keywords.

Command Default None

Command Modes Virtual NIC (/org/service-profile/vnic)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create an FCoE interface:

switch# scope org org3

switch /org # scope service-profile sp1

switch /org/service-profile # scope vnic

switch /org/service-profile/vnic # create fcoe-if

switch /org/service-profile/vnic* # commit-buffer

switch /org/service-profile/vnic #

Related Commands Command Description


show interface
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


236 OL-25718-02
Commands
create fc-policy

create fc-policy
To create a Fibre Channel policy, use the create fc-policy command.

create fc-policy policy-name

Syntax Description policy-name The name of the Fibre Channel policy. The range of valid values is 1 to
16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a Fibre Channel policy, and enter organization fc-policy mode.

Examples This example shows how to create Fibre Channel policy fcp10 in org10 mode:

switch# scope org org10

switch /org # create fc-policy fcp10

switch /org/fc-policy* # commit-buffer

switch /org/fc-policy #

Related Commands Command Description


show fc-policy
show trans-queue

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 237
Commands
create folder

create folder
To create a folder, use the create folder command in vcenter mode. You can also create a folder in data-center
mode.

create folder folder-name

Syntax Description folder-name The name of the folder. A unique set of numbers or letters that identifies the
folder. The range of valid values is 1 to 16.

Command Default None

Command Modes VCenter (/system/vm-mgmt/vmware/vcenter)


Folder (/system/vm-mgmt/vmware/vcenter/data-center

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Folder

Examples This example shows how to create a folder:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter
switch-A /system/vm-mgmt/vmware/vcenter # create folder folder10
switch-A /system/vm-mgmt/vmware/vcenter* # commit-buffer
switch-A /system/vm-mgmt/vmware/vcenter #

Related Commands Command Description


show folder
show vcenter

Cisco UCS Manager CLI Command Reference, Release 2.0


238 OL-25718-02
Commands
create fw-host-pack

create fw-host-pack
To create a host pack, use the create fw-host-pack command.

create fw-host-pack name

Syntax Description name Pack name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines A pack is a collection of host firwmare images for devices like adapters, HBAs, NICs, and raid controllers.
Use this command to create a host firmware package and enter organization firmware host package mode.

Examples This example shows how to create a host pack:

switch-A# scope org org3

Pubs-A /org # create fw-host-pack hp4

Pubs-A /org/fw-host-pack* # commit-buffer

Pubs-A /org/fw-host-pack #

Related Commands Command Description


show fw- host-pack
show fw-mgmt-pack

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 239
Commands
create fw-mgmt-pack

create fw-mgmt-pack
To create a management pack, use the create fw-mgmt-pack command.

create fw-mgmt-pack name

Syntax Description name Pack name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines A pack is a collection of host firwmare images for devices like adapters, HBAs, NICs, and raid controllers.
Use this command to create a management firmware package and enter organization firmware management
package mode.

Examples This example shows how to create a management pack:

switch# scope org org3

switch /org # create fw-mgmt-pack mp4

switch /org/fw-host-pack* # commit-buffer

switch /org/fw-host-pack #

Related Commands Command Description


show fw- host-pack
show fw-mgmt-pack

Cisco UCS Manager CLI Command Reference, Release 2.0


240 OL-25718-02
Commands
create hv-conn

create hv-conn
To create an HV connection, use the create hv-conn command.

create hv-conn protection {none| protected}*

Syntax Description protection Specifies that the connection is protected.

none Specifies no protection.

protected Specifies protection.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a Hypervisor connection, and enter organization HV connection mode.

Examples This example shows how to create a HV connection:

switch# scope org org3

switch /org # scope service-profile sp1

switch /org/service-profile # create hv-conn

switch /org/service-profile/hv-conn* # commit-buffer

switch /org/service-profile/hv-conn #

Related Commands Command Description


show connectivity
show hv-conn

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 241
Commands
create import-config

create import-config
To create a import configuration, use the create import-config command.

create import-config {ftp:| scp:| sftp:| tftp:} {disabled| enabled} {merge| replace}

Syntax Description ftp: Specifies File Transfer Protocol.

scp: Specifies Secure Copy Protocol.

sftp: Specifies Secure File Transfer Protocol.

tftp: Specifies Trivial File Transfer Protocol.

disabled Specifies disabled.

enabled Specifies enabled.

merge Specifies merge.

replace Specifies replace.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a configuration for importing files, and enter organization import configuration
mode.

Examples This example shows how to create an import configuration:

switch# scope system

switch /system # create import-config ftp: enabled replace

switch /service/import-config* # commit-buffer

switch /service/import-config #

Cisco UCS Manager CLI Command Reference, Release 2.0


242 OL-25718-02
Commands
create import-config

Related Commands Command Description


show image
show import-config

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 243
Commands
create initiator

create initiator
To create an initiator, use the create initiator command.

create initiator id

Syntax Description id Initiator identification number. The range of valid values is 1 to 16.

Command Default None

Command Modes WWN pool (/org/wwn-pool)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a WWN initiator, and enter organization initiator mode.

Examples This example shows how to create an initiator:

switch-A# scope org org3

switch-A /org # scope wwn-pool wwnpool3

switch-A /org/wwn-pool # create initiator

switch-A /org/wwn-pool/initiator* # commit-buffer

switch-A /org/wwn-pool/initiator #

Related Commands Command Description


show block
show initiator

Cisco UCS Manager CLI Command Reference, Release 2.0


244 OL-25718-02
Commands
create interface

create interface
To create an interface, use the create interface command.

create interface slot-id port-id

Syntax Description slot-id Slot identification number. The range of valid values is 2 to 5.

port-id Port identification number. The range of valid values is 1 to 40.

Command Default None

Command Modes Fabric interconnect under Ethernet uplink (/eth-uplink/fabric)


Fabric interconnect under Fibre Channel uplink (/fc-uplink/fabric)
Fabric interconnect under Ethernet server (/eth-server/fabric)
Fabric interconnect under Ethernet storage (/eth-storage/fabric)

Command History Release Modification


1.0(1) This command was introduced.

2.0(1) This command can be used to create unified and non-unified ports.
Unified ports are supported on the 6200 series fabric interconnect with Cisco UCS
Manager, version 2.0.
Unified Ports are not supported on 6100 series fabric interconnects, even if they are
running Cisco UCS Manager, version 2.0.

Usage Guidelines Use this command to create an Ethernet or Fibre Channel interface, and enter organization interface mode.
Starting with 2.0(1), use this command to configure:
• Ethernet and Fibre Channel ports on both, 6100 and 6200 Fabric Interconnect series switches.
• non-unified ports for 6100 series fabric interconnects, and unified ports for 6200 series fabric interconnects
with Cisco UCS Manager, version 2.
When you create a new interface for an already configured slot ID and port ID, Cisco UCS Manager
deletes the previously configured interface and creates a new one. If a port mode change is required
because you configured a port that previously operated in the Ethernet port mode to a port type in Fibre
Channel port mode (or vice-versa), Cisco UCS Manager notes the change, and the Fabric Interconnect
will reboot when the change is committed.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 245
Commands
create interface

Examples This example shows how to create an interface:


switch-A# scope fc-uplink
switch-A /fc-uplink # scope fabric b
switch-A /fc-uplink/fabric # create interface 5 10
switch-A /fc-uplink/fabric/interface* # commit-buffer
switch-A /fc-uplink/fabric/interface #

Related Commands Command Description


show interface
show switch

Cisco UCS Manager CLI Command Reference, Release 2.0


246 OL-25718-02
Commands
create interface fc

create interface fc
To create a Fibre Channel interface for a fabric, use the create interface fc command.

create interface fc slot id port id

Syntax Description slot id The slot identification number. The range of valid values is 2 to 5.

port id The port identification of the interface. The range of valid values is 1 to 40.

Command Default None

Command Modes Fabric (/fc-storage/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to create a fibre channel interface for a fabric.
Switch-A # scope fc-storage
Switch-A /fc-storage # scope fabric a
Switch-A /fc-storage/fabric # create interface fc 2 33
Switch-A /fc-storage/fabric/fc* # commit-buffer
Switch-A /fc-storage/fabric/fc #

Related Commands Command Description


scope interface fc
enter interface fc
show interface fc
delete interface fc

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 247
Commands
create interface fcoe

create interface fcoe


To create a Fibre Channel over Ethernet interface for a fabric, use the create interface fcoe command.

create interface fcoe slot id port id

Syntax Description slot id The slot identification number. The range of valid values is 2 to 5.

port id The port identification number. The range of valid values is 1 to 40.

Command Default None

Command Modes Fabric (/fc-storage/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to create a Fibre Channel over Ethernet interface for a fabric.
Switch-A # scope fc-storage
Switch-A /fc-storage # scope fabric a
Switch-A /fc-storage/fabric # create interface fcoe 3 40
Switch-A /fc-storage/fabric/fcoe* # commit-buffer
Switch-A /fc-storage/fabric/fcoe #

Related Commands Command Description


scope interface fcoe
enter interface fcoe
show interface fcoe
delete interface fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


248 OL-25718-02
Commands
create ip-if

create ip-if
To create an IPv4 interface for an iSCSI VNIC, use the create ip-if command.

create ip-if

This command has no arguments or keywords.

Command Default None

Command Modes Ethernet interface within the iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI VNIC for a service profile and an Ethernet interface for the ISCSI VNIC before
you use this command.

Examples This example shows how to create an IPv4 interface for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # create ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if #

Related Commands Command Description


create dhcp-ip-params

create pooled-ip-params

create static-ip-params

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 249
Commands
create ipmi-access-profile

create ipmi-access-profile
To create an IPMI (Intelligent Platform Management Interface) access profile, use the create
ipmi-access-profile command.

create ipmi-access-profile name

Syntax Description name IPMI access profile name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create an IPMI access profile, and enter organization IPMI access profile mode.

Examples This example shows how to create an IPMI access profile:

switch# scope org org3

switch /org # create ipmi-access-profile ipmiProf1

switch /org/ipmi-access-profile* # commit-buffer

switch /org/ipmi-access-profile #

Related Commands Command Description


show epuser
show ipmi-access-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


250 OL-25718-02
Commands
create ipmi-user

create ipmi-user
To create an end-point user, use the create ipmi-user command.

create ipmi-user name

Syntax Description name End-point user name. The range of valid values is 1 to 16.

Command Default None

Command Modes IPMI access profile (/org/ipmi-access-profile)

Command History Release Modification


1.0(1) This command was introduced as create epuser.

1.4(1) This command was renamed as create ipmi-user.

Usage Guidelines Creates the specified endpoint user and enters organization IPMI access profile endpoint user mode.
More than one endpoint user can be created within an IPMI access profile, with each endpoint user having
its own password and privileges

Examples This example shows how to create an IPMI user:

switch-A# scope org org10

switch-A /org # scope ipmi-access-profile ap10

switch-A /org/ipmi-access-profile # create ipmi-user user10

switch-A /org/ipmi-access-profile/ipmi-user* # commit-buffer

switch-A /org/ipmi-access-profile/ipmi-user #

Related Commands Command Description


show ipmi-user
show ipmi-access-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 251
Commands
create iqn-pool

create iqn-pool
An IQN pool is a collection of iSCSI Qualified Names (IQNs) for use as initiator identifiers by iSCSI vNICs
in a Cisco UCS domain. To create an IQN pool, use the create iqn-pool command.

create iqn-pool name

Syntax Description name Name of the IQN pool. The name can include a maximum of 32 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines The IQN pool name can be alphanumeric and can include a maximum of 32 characters.

Examples This example shows how to create an IQN pool in the organization command scope.
UCS-A # scope org
UCS-A /org # create iqn-pool Sample1
UCS-A /org/iqn-pool* # set iqn-prefix iqn.alpha.com
UCS-A /org/iqn-pool* # set descr "This is a sample iqn pool"
UCS-A /org/iqn-pool* # create block beta 3 5
UCS-A /org/iqn-pool/block* # commit-buffer
UCS-A /org/iqn-pool/block # exit
UCS-A /org/iqn-pool #

Related Commands Command Description


enter iqn-pool

scope iqn-pool

show iqn-pool

delete iqn-pool

set iqn-prefix

set descr

Cisco UCS Manager CLI Command Reference, Release 2.0


252 OL-25718-02
Commands
create iqn-pool

Command Description
create block

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 253
Commands
create iscsi-policy

create iscsi-policy
To create an iSCSI adapter policy, use the create iscsi-policy command.

create iscsi-policy name

Syntax Description name Name of the iSCSI adapter policy. The name can include a maximum of 16
characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines The name of the iSCSI adapter policy can include a maximum of 16 characters.

Examples This example shows how to create an iSCSI policy in the organization mode:
UCS-A # scope org test
UCS-A /org # create iscsi-policy Sample
UCS-A /org/iscsi-policy* # commit-buffer
UCS-A /org/iscsi-policy #

Related Commands Command Description


scope iscsi-policy

enter iscsi-policy

show iscsi-policy

delete iscsi-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


254 OL-25718-02
Commands
create iscsi

create iscsi
To create a boot iSCSI policy for the organization mode, use the create iscsi command.

create iscsi

This command has no arguments or keywords.

Command Default None

Command Modes Boot definition of a service profile (/org/service-profile/boot-definition)


Boot policy (/org/boot-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to create a boot iSCSI policy for a service profile of an organization:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope boot-definition
UCS-A /org/service-profile/boot-definition # create iscsi
UCS-A /org/service-profile/boot-definition/iscsi* # commit-buffer
UCS-A /org/service-profile/boot-definition/iscsi #

Related Commands Command Description


scope iscsi

enter iscsi

show iscsi

delete iscsi

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 255
Commands
create keyring

create keyring
To create a keyring, use the create keyring command.

create keyring name

Syntax Description name Keyring name. The name can be up to 16 alphanumeric characters.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a keyring to store RSA keys, and enter organization keyring mode.

Examples This example shows how to create a keyring:


switch# scope security
switch /security # create keyring kr220
switch /security/keyring* # commit-buffer
switch /security/keyring #

Related Commands Command Description


show keyring

Cisco UCS Manager CLI Command Reference, Release 2.0


256 OL-25718-02
Commands
create lan

create lan
To create a LAN, use the create lan command.

create lan

This command has no arguments or keywords.

Command Default None

Command Modes Boot policy under organization (/org/boot-policy)


Boot definition under service-profile (/org/service-profile/boot-def)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a LAN, and enter organization lan mode.

Examples This example shows how to create a LAN:

switch-A# scope org org3

switch-A /org # scope boot-policy bp6

switch-A /org/boot-policy # create lan

switch-A /org/boot-policy/lan* # commit-buffer

switch-A /org/boot-policy/lan #

Related Commands Command Description


show boot-policy
show lan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 257
Commands
create ldap-group

create ldap-group
To create an LDAP group, use the create ldap-group command.

create ldap-group Group DN

Syntax Description Group DN The group description. The name of the LDAP group can contain a maximum
of 127 characters.

Command Default None

Command Modes LDAP (/security/ldap)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The LDAP group name can include alphanumeric and special characters.

Examples This example shows how to create an LDAP group.


Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # create ldap-group Sample
Switch-A /security/ldap/ldap-group* # commit-buffer
Switch-A /security/ldap/ldap-group #

Related Commands Command Description


scope ldap-group
delete ldap-group

Cisco UCS Manager CLI Command Reference, Release 2.0


258 OL-25718-02
Commands
create ldap-group-rule

create ldap-group-rule
To create an LDAP group rule, use the create ldap-group-rule command.

create ldap-group-rule

This command has no arguments or keywords.

Command Default None

Command Modes LDAP (/security/ldap)


Server (/security/ldap/server)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines While using this command in the server mode, an LDAP server must be created to use this command.

Examples This example shows how to create an LDAP group rule for a server.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope server Example
Switch-A /security/ldap/server # create ldap-group-rule
Switch-A /security/ldap/server/ldap-group-rule* # commit-buffer
Switch-A /security/ldap/server/ldap-group-rule #

Related Commands Command Description


scope ldap-group-rule
enter ldap-group-rule
show ldap-group-rule
delete ldap-group-rule

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 259
Commands
create local

create local
To create local storage, use the create local command.

create local

Command Default None

Command Modes Storage (/org/boot-policy/storage)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create local storage:

switch# scope org org10

switch /org # scope boot-policy bp10

switch /org/boot-policy # scope storage

switch /org/boot-policy/storage # create local storage10

switch /org/boot-policy/storage* # commit-buffer

switch /org/boot-policy/storage #

Related Commands Command Description


show local
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


260 OL-25718-02
Commands
create local-disk-config

create local-disk-config
To create a local disk configuration, use the create local-disk-config command.

create local-disk-config

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a local disk configuration, and enter organization local disk configuration mode.

Examples This example shows how to create a local disk configuration:

switch# scope org org3

switch /org # scope service-profile sp1

switch /org/service-profile # create local-disk-config

switch /org/service-profile/local-disk-config* # commit-buffer

switch /org/service-profile/local-disk-config #

Related Commands Command Description


show local-disk-config
show local-disk-config-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 261
Commands
create local-disk-config-policy

create local-disk-config-policy
To create a local disk configuration policy, use the create local-disk-config-policy command.

create local-disk-config-policy name

Syntax Description name Local disk configuration policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a local disk configuration policy, and enter organization local disk configuration
policy mode.

Examples This example shows how to create a local disk configuration policy:

switch# scope org org3

switch /org # create local-disk-config-policy ldcp1

switch /org/local-disk-config-policy* # commit-buffer

Pubs-A /org/local-disk-config-policy #

Related Commands Command Description


show local-disk-config
show local-disk-config-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


262 OL-25718-02
Commands
create locale

create locale
To create a locale, use the create locale command.

create locale name

Syntax Description name Locale name. The range of valid values is 1 to 16.

Command Default None

Command Modes Local user (/security/local-user)


Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a locale, and enter organization local user mode.
You cannot create locales for an administrator account.

Examples This example shows how to create a locale:

switch# scope security

switch /security # scope local-user lu1

switch /security # create locale locale1

switch /security/local-user* # commit-buffer

switch /security/local-user #

Related Commands Command Description


show locale
show local-user

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 263
Commands
create local-user

create local-user
To create a local user, use the create local-user command.

create local-user name

Syntax Description name Local user name. The range of valid values is 1 to 74.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a local user, and enter organization local user mode.

Examples This example shows how to create a local user:

switch# scope security

switch /security # scope local-user lu1

switch /security # create local-user lu2

switch /security/local-user* # commit-buffer

switch /security/local-user #

Related Commands Command Description


show locale
show local-user

Cisco UCS Manager CLI Command Reference, Release 2.0


264 OL-25718-02
Commands
create lun

create lun
To create a LUN for a static target interface priority, use the create lun command.

create lun

This command has no arguments or keywords.

Command Default None

Command Modes Static target interface (/org/service-profile/vnic-iscsi/eth-if/static-target-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a static target interface for an iSCSI VNIC before you use this command.

Examples This example shows how to create a LUN for a configured static target interface priority:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope static-target-if 1
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if # create lun
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if/lun* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if/lun #

Related Commands Command Description


set id

create static-target-if

enter static-target-if

scope static-target-if

show static-target-if

delete static-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 265
Commands
create mac-pool

create mac-pool
To create a MAC address pool, use the create mac-pool command.

create mac-pool name

Syntax Description name MAC address pool name. The name can be up to 32 alphanumeric characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a block of MAC addresses, and enter organization MAC pool mode.

Examples This example shows how to create a MAC pool:


switch# scope org org3
switch /org # create mac-pool mp1
switch /org/mac-pool* # commit-buffer
switch /org/mac-pool #

Related Commands Command Description


show block
show pooled

Cisco UCS Manager CLI Command Reference, Release 2.0


266 OL-25718-02
Commands
create mac-security

create mac-security
To create MAC security, use the create mac-security command.

create mac-security

This command has no arguments or keywords.

Command Default None

Command Modes Network Control Policy (/org/nw-ctrl-policy)


Network Control Policy (/eth-storage/nw-ctrl-policy)

Command History Release Modification


1.0(1) This command was first introduced in the port profile mode within the Ethernet Uplink
mode (/eth-uplink/port-profile).

1.4(1) This command is now available in the Network Control Policy mode within the
Organization mode (/org/nw-ctrl-policy) and Ethernet Storage mode
(/eth-storage/nw-ctrol-policy). This command is no longer available within the Port
Profile mode in the Ethernet Uplink Mode.

Usage Guidelines Use this command to create MAC security, and enter organization MAC security mode.
A network control policy for an organization must be created prior to using this command.

Examples This example shows how to create MAC security:

switch# scope org Testing

switch /org # scope nw-ctrl-policy sample

switch /org/nw-ctrl-policy # create mac-security

switch /org/nw-ctrl-policy/mac-security* # commit-buffer

switch /org/nw-ctrl-policy/mac-security #

Related Commands Command Description


show mac-security

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 267
Commands
create maint-policy

create maint-policy
To create a maintenance policy, use the create maint-policy command.

create maint-policy Name

Syntax Description name The name of the maintenance policy. This name can include a maximum of 16
characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the maintenance policy can include alphanumeric characters, but cannot include special characters.

Examples This example shows how to create a maintenance policy.


Switch-A # scope org
Switch-A /org # create maint-policy Default
Switch-A /org/maint-policy* # commit-buffer
Switch-A /org/maint-policy #

Related Commands Command Description


scope maint-policy
enter maint-policy
delete maint-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


268 OL-25718-02
Commands
create member-port

create member-port
To create a member port, use the create member-port command.

create member-port {a| b} slot-id port-id

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number. The range of valid values is 1 to 5.

port-id Port identification number. Depending on the command mode, the range of valid
values is 1 to 40 or 1 to 256.

Command Default None

Command Modes VLAN within Ethernet storage (/eth-storage/vlan)


VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within a fabric in the Ethernet uplink mode (/eth-uplink/fabric/vlan)
VSAN within the Fibre Channel uplink mode (/fc-uplink/vsan)
VSAN within the fabric interconnect mode (/fc-uplink/fabric/vsan)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command is not available in the Port Channel mode within /eth-uplink/switch
mode.
This command can be used in the VLAN mode within Ethernet Storage.
(/eth-storage/vlan).

2.0(1) This command was introduced in the following command modes:


• VLAN within Ethernet uplink (/eth-uplink/vlan)
• VLAN within a fabric in the Ethernet uplink mode (/eth-uplink/fabric/vlan)

Usage Guidelines Use this command to create a member port, and enter organization member port mode.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 269
Commands
create member-port

The valid values for Port ID in the VLAN mode is 1 to 40.


The valid values for Port ID in the VSAN modes is 1 to 256.

Examples This example shows how to create a member port for a VLAN within the Ethernet Storage command mode:

UCS-A # scope eth-storage


UCS-A /eth-storage # scope vlan sample
UCS-A /eth-storage/vlan # create member-port a 1 22
UCS-A /eth-storage/vlan/member-port* # commit-buffer
UCS-A /eth-storage/vlan/member-port #

Related Commands Command Description


show member-port
show port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


270 OL-25718-02
Commands
create member-port fc

create member-port fc
To create a fibre channel member port, use the create member-port fc command.

create member-port fc {a| b} slot-id port-id

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number. It must be a value between 1 and 5.

port-id Port identification number. It must be a value between 1 and 256.

Command Default None

Command Modes VSAN within Fibre channel storage mode (/fc-storage/vsan)


VSAN within a fabric in the Fibre channel storage mode (/fc-storage/fabric/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create a VSAN before you use this command.

Examples This example shows how to create a fibre channel member port within a fabric in the Fibre Channel storage
mode:
UCS-A # scope fc-storage
UCS-A /fc-storage # scope fabric a
UCS-A /fc-storage/fabric # scope vsan sample
UCS-A /fc-storage/fabric/vsan # create member-port fc 1 223
UCS-A /fc-storage/fabric/vsan/member-port* # commit-buffer
UCS-A /fc-storage/fabric/vsan/member-port #

Related Commands Command Description


enter member-port fc

scope member-port fc

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 271
Commands
create member-port fc

Command Description
show member-port fc

delete member-port fc

Cisco UCS Manager CLI Command Reference, Release 2.0


272 OL-25718-02
Commands
create member-port fcoe

create member-port fcoe


To create a Fibre Channel over Ethernet member port, use the create member-port fcoe command.

create member-port fcoe {a| b} slot-id port-id

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number. The value must be between 1 and 5.

port-id Port identification number. The value must be between 1 and 256.

Command Default None

Command Modes VSAN within the Fibre Channel storage command mode (/fc-storage/vsan)
VSAN within a fabric (/fc-storage/fabric/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create a VSAN before you use this command.

Examples This example shows how to create a Fibre Channel over Ethernet member port:
UCS-A # scope fc-storage
UCS-A /fc-storage # scope vsan sample
UCS-A /fc-storage/vsan # create member-port fcoe 1 233
UCS-A /fc-storage/vsan/member-port* # commit-buffer
UCS-A /fc-storage/vsan/member-port #

Related Commands Command Description


enter member-port fcoe

scope member-port fcoe

show member-port fcoe

delete member-port fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 273
Commands
create member-port (/port-channel)

create member-port (/port-channel)


To create a member-port within the port channel command mode, use the create member-port command.

create member-port slotid portid

Syntax Description slot id Slot identification number. The value must be between 1 and 5.

port id Port identification number. Depending on the command mode that you are in, the
values must be between 1 and 40 or 1 and 48.

Command Default None

Command Modes Port-Channel within the Ethernet Uplink mode (/eth-uplink/fabric/port-channel)


Port channel within a Fabric in the Ethernet storage mode (/eth-storage/fabric/port-channel)
Port-Channel within the Fibre Channel Uplink mode (/fc-uplink/fabric/port-channel)

Command History Release Modification


1.4(1) This command was introduced.

2.0(1) This command was introduced in the port channel mode within a Fabric in the
Ethernet storage mode (/eth-storage/fabric/port-channel).

Usage Guidelines You must create port channels before you use this command.
You can specify a port ID between 1 and 48 while creating a member port in the following command modes:
• Port channel within a Fabric in the Ethernet storage mode (/eth-storage/fabric/port-channel)
• Port-Channel within the Fibre Channel Uplink mode (/fc-uplink/fabric/port-channel)

You can specify a port ID between 1 and 40 while creating a member port in the following command mode:
• Port-Channel within the Ethernet Uplink mode (/eth-uplink/fabric/port-channel)

Examples This example shows how to create a member port for a port channel within the Fibre Channel uplink mode:
UCS-A # scope fc-uplink
UCS-A /fc-uplink # scope fabric a
UCS-A /fc-uplink/fabric # scope port-channel sample
UCS-A /fc-uplink/fabric/port-channel # create member-port 1 22

Cisco UCS Manager CLI Command Reference, Release 2.0


274 OL-25718-02
Commands
create member-port (/port-channel)

UCS-A /fc-uplink/fabric/port-channel/member-port* # commit-buffer


UCS-A /fc-uplink/fabric/port-channel/member-port #

Related Commands Command Description


show member-port

scope member-port

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 275
Commands
create member-port-channel

create member-port-channel
To create a member port channel, use the create member-port-channel command.

create member-port-channel {a| b} port channel id

Syntax Description a Specifies fabric A.

b Specifies fabric B.

port channel id Specifies the ID of the port channel. It must be a value between 1- 256.

Command Default None

Command Modes VSAN (/fc-uplink/vsan)


VSAN within fabric (/fc-uplink/fabric/vsan)
VLAN within Ethernet storage (/eth-storage/vlan)
VLAN within a fabric in the Ethernet storage (/eth-storage/fabric/vlan)
VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within a fabric in Ethernet uplink (/eth-uplink/fabric/vlan)

Command History Release Modification


1.4(1) This command was introduced.

2.0(1) This command was introduced in Ethernet uplink mode (/eth-uplink/vlan and
/eth-uplink/fabric/vlan).

Usage Guidelines You must create a VSAN or a VLAN before you use this command.

Examples This example shows how to create a member port channel for a sample VSAN within a fabric:
UCS-A # scope fc-uplink
UCS-A /fc-uplink # scope fabric a
UCS-A /fc-uplink/fabric # scope vsan Sample
UCS-A /fc-uplink/fabric/vsan # create member-port-channel a 22
UCS-A /fc-uplink/fabric/vsan* # commit-buffer
UCS-A /fc-uplink/fabric/vsan #

Cisco UCS Manager CLI Command Reference, Release 2.0


276 OL-25718-02
Commands
create member-port-channel

Related Commands Command Description


scope member-port-channel
enter member-port-channel
show member-port-channel
delete member-port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 277
Commands
create memory

create memory
To create a memory qualifier, use the create memory command.

create memory

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a memory qualifier, and enter organization memory mode.

Examples This example shows how to create a memory qualifier:

Pubs-A# scope org org3

Pubs-A /org # scope server-qual sq20

Pubs-A /org/server-qual # create memory

Pubs-A /org/server-qual/memory* # commit-buffer

Pubs-A /org/server-qual/memory #

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


278 OL-25718-02
Commands
create mon-src

create mon-src
To create a monitor source session, use the create mon-src command.

create mon-src session name

Syntax Description session name The name of the monitoring source session. This name can include a maximum
of 16 characters.

Command Default None

Command Modes VHBA (/org/service-profile/vhba)


VNIC (/org/service-profile/vnic)
External Ethernet interface (/chassis/server/adapter/ext-eth-if)
Fibre Channel (/fc-storage/fabric/fc)
Fibre Channel over Ethernet (/fc-storage/fabric/fcoe)
Port channel within Ethernet uplink (/eth-uplink/fabric/port-channel)
Port channel within Fibre Channel uplink (/fc-uplink/fabric/port-channel)
VSAN within Fibre Channel uplink(/fc-uplink/vsan)
VSAN within Fibre Channel storage (/fc-storage/vsan)
VSAN within Fibre Channel uplink (/fc-uplink/fabric/vsan)
VSAN within Fibre Channel storage (/fc-storage/fabric/vsan)
VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within a fabric in Ethernet uplink (/eth-uplink/fabric/vlan)
Interface within Ethernet uplink (/eth-uplink/fabric/interface)
Interface within Fibre Channel uplink (/fc-uplink/fabric/interface)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The session of the monitoring source can include a maximum of 16 characters. The session can be alphanumeric,
but cannot include special characters.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 279
Commands
create mon-src

Examples This example shows how to create a monitoring source for VNIC within a service profile.
Switch-A # scope org
Switch-A /org # scope service-profile sample
Switch-A /org/service-profile # scope vnic test
Switch-A /org/service-profile/vnic # create mon-src example
Switch-A /org/service-profile/vnic/mon-src* # commit-buffer
Switch-A /org/service-profile/vnic/mon-src #

Related Commands Command Description


set direction
scope mon-src
enter mon-src
show mon-src
delete mon-src

Cisco UCS Manager CLI Command Reference, Release 2.0


280 OL-25718-02
Commands
create network (/eth-uplink/port-profile)

create network (/eth-uplink/port-profile)


To create a Ethernet interface, use the create network command.

create network name

Syntax Description name Ethernet interface name. The range of valid values is 1 to 16.

Command Default None

Command Modes Port profile (/eth-uplink/port-profile)

Command History Release Modification


1.0(1) This command was introduced.

Use this command to create a network, and enter organization network mode.

Examples This example shows how to create an Ethernet interface:

switch# scope eth-uplink

switch /eth-uplink # scope port-profile pp1

switch /eth-uplink/port-profile # create network eth1

switch /eth-uplink/port-profile/network* # commit-buffer

switch /eth-uplink/port-profile/network #

Related Commands Command Description


show fc-uplink
show network

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 281
Commands
create network (/profile-set/port-profile)

create network (/profile-set/port-profile)


To create a network, use the create network command in port-profile mode.

create network network-name

Syntax Description network-name The name of the network. A unique set of numbers or letters that identifies the
network. The range of valid values is 1 to 32.

Command Default None

Command Modes Profile set (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Network

Examples This example shows how to create a network:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope profile-set
switch-A /system/vm-mgmt/vmware/profile-set # scope port-profile
switch-A /system/vm-mgmt/vmware/profile-set/port-profile # create network n100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile* # commit-buffer
switch-A /system/vm-mgmt/vmware/profile-set/port-profile #

Related Commands Command Description


show port profile
show profile-set

Cisco UCS Manager CLI Command Reference, Release 2.0


282 OL-25718-02
Commands
create ntp-server

create ntp-server
To create an NTP server, use the create ntp-server command.

create ntp-server name

Syntax Description name Server name.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create an NTP server, and enter organization NTP server mode.

Examples This example shows how to create an NTP server:

switch-A# scope system

switch-A /system # scope services

switch-A /system/services # create ntp-server ntps1

switch-A /system/services/ntp-server* # commit-buffer

switch-A /system/services/ntp-server #

Related Commands Command Description


show dns
show ntp

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 283
Commands
create nw-ctrl-policy

create nw-ctrl-policy
To create a network control policy, use the create nw-ctrl-policy command.

create nw-ctrl-policy policy-name

Syntax Description policy-name Policy name. Enter up to 16 characters.

Command Default None

Command Modes Organization (/org)


Ethernet storage (/eth-storage)

Command History Release Modification


1.0(2) This command was introduced.

1.4(1) This command was introduced in the Ethernet storage command mode.

Usage Guidelines The name of the network control policy can be alphanumeric, but cannot include special characters.
When you create a network control policy, you can use the policy to perform the following tasks:
• Enable CDP
• Set up an uplink fail action

Examples This example shows how to create a network control policy:

UCS-A # scope org org10


UCS-A /org # create nw-ctrl-policy netCtrlP10
UCS-A /org/nw-ctrl-policy* # commit-buffer
UCS-A /org/nw-ctrl-policy #

Related Commands Command Description


scope nw-ctrl-policy

set uplink-fail-action

enter nw-ctrl-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


284 OL-25718-02
Commands
create nw-ctrl-policy

Command Description
delete nw-ctrl-policy

show nw-ctrl-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 285
Commands
create occurrence one-time

create occurrence one-time


To create a one-time occurrence for a schedule, use the create occurrence one-time command.

create occurrence one-time name

Syntax Description name Name of the one-time occurrence for the schedule. The name can include a maximum
of 16 characters.

Command Default None

Command Modes Schedule (/system/schedule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A schedule must be created to use this command.


The name of the one-time occurrence of the schedule can include alphanumeric characters, but cannot include
special characters.

Examples This example shows how to create a one-time occurrence for a schedule.
Switch-A # scope system
Switch-A /system # scope schedule Sample
Switch-A /system/schedule # create occurrence one-time Trial
Switch-A /system/schedule/one-time* # commit-buffer
Switch-A /system/schedule/one-time #

Related Commands Command Description


scope occurrence one-time
enter occurrence one-time
show occurrence one-time
delete occurrence one-time

Cisco UCS Manager CLI Command Reference, Release 2.0


286 OL-25718-02
Commands
create occurrence recurring

create occurrence recurring


To create a recurring occurrence for a schedule, use the create occurrence recurring command.

create occurrence recurring Name

Syntax Description Name The name of the recurring occurrence instance. This name can include a maximum
of 16 characters.

Command Default None

Command Modes Schedule (/system/schedule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A schedule must be created to use this command.


The name of the recurring occurrence instance can be alphanumeric, but cannot include special characters.

Examples This example shows how to create a recurring occurrence instance for a schedule.
Switch-A # scope system
Switch-A /system # scope schedule Default
Switch-A /system/schedule # create occurrence recurring Sample
Switch-A /system/schedule/recurring* # commit-buffer
Switch-A /system/schedule/recurring #

Related Commands Command Description


scope occurrence recurring

enter occurrence recurring

show occurrence recurring

delete occurrence recurring

set concur-tasks

set day

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 287
Commands
create occurrence recurring

Command Description
set hour

set max-duration

set min-interval

set minute

set proc-cap

Cisco UCS Manager CLI Command Reference, Release 2.0


288 OL-25718-02
Commands
create org

create org
To create an org, use the create org command.

create org name

Syntax Description name Org name. The range of valid values is 1 to 80.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Organizations are logical entities that you can use to divide up large physical infrastructures into smaller
infrastructures.
Use this command to create an organization, and enter organization mode.

Examples This example shows how to create an org:

Switch-A# scope org org3

Switch-A /org # create org org4

Switch-A /org* # commit-buffer

Switch-A /org #

Related Commands Command Description


show mac-pool
show org

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 289
Commands
create org-ref

create org-ref
To create a organization reference, use the create org-ref command.

create org-ref name orgdn domain-name

Syntax Description name Organization name. The range of valid values is 1 to 16.

orgdn Specifies the organization domain name.

domain-name Domain name.

Command Default None

Command Modes Locale (/security/locale)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines The create org-ref command creates a an organization reference to a locale. Use this command to create a
organization reference, and enter organization organization reference mode.
You can specify more than one org-ref-name and orgdn-name argument on the same command line to reference
multiple organizations to the locale, or you can add organizations to the same locale using multiple create
org-ref commands.

Examples This example shows how to create an organization reference to a locale:

switch-A# scope security

switch-A /security # scope locale locale1

switch-A /security/locale # create org-ref or3 orgdn or30

switch-A /security/locale/org-ref* # commit-buffer

switch-A /security/locale/org-ref #

Related Commands Command Description


show locale

Cisco UCS Manager CLI Command Reference, Release 2.0


290 OL-25718-02
Commands
create org-ref

Command Description
show org

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 291
Commands
create pack-image

create pack-image
To create an image pack, use the create pack-image command.

create pack-image hw-vendor hw-model {server-bios| adapter| raid-controller| host-nic| host-hba|


host-hba-optionrom} version

Syntax Description hw-vendor Hardware vendor.

hw-model Hardware model number.

server-bios Specifies the image for the server.

adapter Specifies the image for the adapter.

raid-controller Specifies the image for the RAID array.

host-nic Specifies the image for the host NIC.

host-hba Specifies the image for the host HBA.

host-hba-optionrom Specifies the image for the host HBA optional ROM.

version Hardware version.

Command Default None

Command Modes Firmware management package (/org/fw-mgmt-pack)


Firmware host package (/org/fw-host-pack)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines A pack is a collection of host firwmare images.


Use this command to create a pack-image, and enter organization pack image mode.
Keywords found in the create pack-image command are not supported in /org/fw-mgmt-pack mode.

Cisco UCS Manager CLI Command Reference, Release 2.0


292 OL-25718-02
Commands
create pack-image

Examples This example shows how to create an image pack:

switch-A# scope org org3

switch-A /org # scope fw-mgmt-pack fmp1

switch-A /org/fw-mgmt-pack # create pack-image hp 1100 bmc 1.2

switch-A /org/fw-mgmt-pack/pack-image* # commit-buffer

switch-A /org/fw-mgmt-pack/pack-image #

Related Commands Command Description


show fw-host-pack
show fw-mgmt-pack

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 293
Commands
create path

create path
To create a LAN image path, use the create path command.

create path {primary| secondary}

Syntax Description primary Specifies a primary path.

secondary Specifies a secondary path.

Command Default None

Command Modes SAN image under boot-definition/storage (/org/service-profile/boot-def/storage/san-image)


LAN under boot-policy (/org/boot-policy/lan)
LAN under boot-definition /org/service-profile/boot-def/lan
SAN image under boot-policy/storage (/org/boot-policy/storage/san-image)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines The LAN image path is the path the vNIC used when booting from an image on a LAN, such as a PXE boot.
For each path you can specify the vNIC to use.
Use this command to create a LAN image path, and enter organization path mode.

Examples This example shows how to create a LAN image path:

switch-A# scope org org3

switch-A /org # scope boot-policy boot1

switch-A /org/boot-policy # scope lan

switch-A /org/boot-policy/lan # create path primary

switch-A /org/boot-policy/lan/path* # commit-buffer

switch-A /org/boot-policy/lan/path #

Cisco UCS Manager CLI Command Reference, Release 2.0


294 OL-25718-02
Commands
create path

Related Commands Command Description


show lan
show path

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 295
Commands
create path (iscsi)

create path (iscsi)


To create an iSCSI image path, use the create path command.

create path {primary| secondary}

Syntax Description primary Specifies a primary iSCSI image path.

secondary Specifies a secondary iSCSI image path.

Command Default None

Command Modes iSCSI within a boot policy (/org/boot-policy/iscsi)


iSCSI within a boot definition (/org/service-profile/boot-definition/iscsi)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a service profile and a boot definition before you use this command.
You must create a boot policy before you can use this command in the boot-policy command mode.

Examples This example shows how to create a primary path for an iSCSI image for a boot policy:
UCS-A # scope org test
UCS-A /org # scope boot-policy default
UCS-A /org/boot-policy # scope iscsi
UCS-A /org/boot-policy/iscsi # create path primary
UCS-A /org/boot-policy/iscsi/path* # commit-buffer
UCS-A /org/boot-policy/iscsi/path #

Related Commands Command Description


set iscsivnicname

Cisco UCS Manager CLI Command Reference, Release 2.0


296 OL-25718-02
Commands
create physical-qual

create physical-qual
To create a physical qualifier for a server pool policy, use the create physical-qual command.

create physical-qual

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command create a physical qualifier for a server pool policy, and to enter organization physical
qualifier mode.

Examples This example shows how to create a physical qualifier:


switch-A# scope org org3
switch-A /org # scope server-qual sq20
switch-A /org/server-qual # create physical-qual
switch-A /org/server-qual/physical-qual* # commit-buffer
switch-A /org/server-qual/physical-qual #

Related Commands Command Description


show physical-qual
show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 297
Commands
create pin-group

create pin-group
To create a pin group, use the create pin-group command.

create pin-group name

Syntax Description name Pin group name. The range of valid values is 1 to 16.

Command Default None

Command Modes Ethernet uplink (/eth-uplink)


Fibre Channel uplink (/fc-uplink)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Pinning in Cisco UCS is only relevant to uplink ports.


When you determine the optimal configuration for pin groups and pinning for an uplink port, consider the
estimated bandwidth usage for the servers. If you know that some servers in the system will use a lot of
bandwidth, ensure that you pin these servers to different uplink ports.
Use this command to create a pin group, and enter organization pin-group mode.

Examples This example shows how to create a pin group:

switch-A# scope eth-uplink

switch-A /eth-uplink # create pin-group pg110

switch-A /eth-uplink/pin-group* # commit-buffer

switch-A /eth-uplink/pin-group #

Related Commands Command Description


show eth-uplink
show pin-group

Cisco UCS Manager CLI Command Reference, Release 2.0


298 OL-25718-02
Commands
create policy

create policy
To create a policy, use the create policy command.

callhome mode
create policy event

flow-control mode
create policy name

Syntax Description event Select a predefined fault or system event type. See Usage Guidelines for event
options.

name Policy name. The name can be from 1 to 16 characters.

Command Default None

Command Modes Callhome (/monitoring/callhome)


Flow control (/eth-uplink/flow-control)

Command History Release Modification


1.0(1) This command was introduced.

1.1(1) This command was modified to add additional event types for Call Home.

Usage Guidelines Use this command to create a policy, and enter either organization callhome or organization flow control
mode.
In Call Home configuration, use this command to create an instance of a policy for a predefined type of fault
or system event. The following list shows the available keywords for Call Home event types:
• association-failed
• chassis-seeprom-error
• configuration-failure
• connectivity-problem
• election-failure
• equipment-inaccessible

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 299
Commands
create policy

• equipment-inoperable
• equipment-problem
• fru-problem
• identity-unestablishable
• link-down
• management-services-failure
• management-services-unresponsive
• power-problem
• thermal-problem
• unspecified
• version-incompatible
• voltage-problem

In Flow Control configuration, use this command to create a named policy.

Examples This example shows how to create and enable a Call Home policy instance for link-down events:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # create policy link-down
switch-A /monitoring/callhome/policy # set admin-state enabled
switch-A /monitoring/callhome/policy* # commit-buffer
switch-A /monitoring/callhome/policy #
This example shows how to create a named policy for flow control:
switch-A # scope eth-uplink
switch-A /eth-uplink # scope flow-control
switch-A /eth-uplink/flow-control # create policy policy1
switch-A /eth-uplink/flow-control* # commit-buffer
switch-A /eth-uplink/flow-control #

Related Commands Command Description


enter policy
show policy
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


300 OL-25718-02
Commands
create pooled-ip-params

create pooled-ip-params
To configure a pool for initiator IP parameters, use the create pooled-ip-params command.

create pooled-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface within the iSCSI VNIC mode (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an IPv4 interface for the iSCSI VNIC before you use this command.

Examples This example shows how to configure a pool for initiator IP parameters:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # create pooled-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/pooled-ip-params* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/pooled-ip-params #

Related Commands Command Description


enter pooled-ip-params

scope pooled-ip-params

delete pooled-ip-params

create dhcp-ip-params

create static-ip-params

create ip-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 301
Commands
create pooling-policy

create pooling-policy
To create a pooling policy, use the create pooling-policy command.

create pooling-policy name

Syntax Description name Policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Creates a server pooling policy, and enters organization pooling policy mode.

Examples This example shows how to create a pooling policy:

switch-A# scope org org3

switch-A /org # create pooling-policy pp110

switch-A /org/pooling-policy* # commit-buffer

switch-A /org/pooling-policy #

Related Commands Command Description


show policy
show pooling-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


302 OL-25718-02
Commands
create port-channel

create port-channel
To create a port channel, use the create port-channel command.

create port-channel id

Syntax Description id Port identification number. The range of valid values is 1 to 256.

Command Default None

Command Modes Fabric within the Ethernet Uplink mode (/eth-uplink/fabric)


Fabric within the Fibre Channel Uplink mode (/fc-uplink/fabric)
Fabric within the Ethernet storage mode (/eth-storage/fabric)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was introduced for a Fabric within the Fibre Channel uplink mode
(fc-uplink/fabric) and the Ethernet storage mode (/eth-storage).
The range of valid values was modified to 1 to 256 from 1 to 40.

Usage Guidelines Consider using a port channel to make best use of capacity when multiple uplinks are used on a switch.
Use this command to create a port channel, and enter organization port channel mode.

Examples This example shows how to create a port channel:

UCS-A # scope eth-uplink


UCS-A /eth-uplink # scope fabric b
UCS-A /eth-uplink/fabric # create port-channel 20
UCS-A /eth-uplink/fabric/port-channel* # commit-buffer
UCS-A /eth-uplink/fabric/port-channel #

Related Commands Command Description


show port-channel
set adminspeed
set mon-src

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 303
Commands
create port-profile (/eth-uplink)

create port-profile (/eth-uplink)


To create a port profile, use the create port-profile command.

create port-profile name

Syntax Description name Port profile name. The range of valid values is 1 to 16.

Command Default None

Command Modes Ethernet uplink (/eth-uplink)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a port profile, and enter organization port profile mode.

Examples This example shows how to create a port profile:

switch-A# scope eth-uplink

switch-A /eth-uplink # create port-profile pp110

switch-A /eth-uplink/port-profile* # commit-buffer

switch-A /eth-uplink/port-profile #

Related Commands Command Description


show eth-uplink
show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


304 OL-25718-02
Commands
create port-profile (/profile-set)

create port-profile (/profile-set)


To create a port profile, use the create port-profile command in profile-set mode.

create port-profile profile-name

Syntax Description profile-name The name of the profile. A unique set of numbers or letters that identifies the
profile. The range of valid values is 1 to 31.

Command Default None

Command Modes Profile set (/system/vm-mgmt/vmware/profile-set)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines The port profile client determines the DVSes to which a port profile is applied. By default, a port profile
applies to all DVSes in the vCenter; however, you can use a port profile client to apply a port profile to all
DVSes in a specific datacenter or datacenter folder, or to a specific DVS.
create port-profile creates the specified port profile and enters system VM management VMware profile
set port profile mode.

Examples This example shows how to create a port profile:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # create port-profile pp100
switch-A /system/vm-mgmt/vmware* # commit-buffer
switch-A /system/vm-mgmt/vmware #

Related Commands Command Description


show
show port profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 305
Commands
create power-control-policy

create power-control-policy
To create a power policy, use the create power-control-policy command.

create power-control-policy name

Syntax Description name The name of the power policy. The name can include a maximum of 16 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the power policy can be alphanumeric, but cannot include special characters.

Examples This example shows how to create a power policy.


Switch-A # scope org
Switch-A /org # create power-control-policy Sample
Switch-A /org/power-control-policy* # commit-buffer
Switch-A /org/power-control-policy #

Related Commands Command Description


scope power-control-policy
enter power-control-policy
set power-control-policy
delete power-control-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


306 OL-25718-02
Commands
create power-group

create power-group
To create a power group, use the create power-group command.

create power-group name

Syntax Description name The name of the power group. The name can include a maximum of 16 characters.

Command Default None

Command Modes Power Capping Management (/power-cap-mgmt)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the power group can include alphanumeric characters, but cannot include special characters.
The global capping policy must be set as policy-driven-chassis--group-cap to create power groups.

Examples This example shows how to create a power group.


Switch-A # scope power-cap-mgmt
Switch-A /power-cap-mgmt # create power-group Testing
Switch-A /power-cap-mgmt/power-group* # commit-buffer
Switch-A /power-cap-mgmt/power-group #

Related Commands Command Description


scope power-group
enter power-group
show power-group
delete power group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 307
Commands
create processor

create processor
To create a processor qualifier for a server pool policy, use the create processor command.

create processor

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

1.3(1) This command was removed.

Usage Guidelines Use this command create a processor qualifier for a server pool policy, and to enter organization processor
mode.
Only one processor qualifier can be created.

Note In later releases, this command is replaced by the create cpu command.

Examples This example shows how to create a processor qualifier:


switch-A# scope org org3
switch-A /org # scope server-qual sq20
switch-A /org/server-qual # create processor
switch-A /org/server-qual/processor* # commit-buffer
switch-A /org/server-qual/processor #

Related Commands Command Description


show processor
show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


308 OL-25718-02
Commands
create profile

create profile
To create a profile, use the create profile command.

create profile name

Syntax Description name Profile name. The range of valid values is 1 to 16.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a profile, and enter organization profile mode.

Examples This example shows how to create a profile:

switch-A# scope monitoring

switch-A /monitoring # scope callhome

switch-A /monitoring/callhome # create profile p210

switch-A /monitoring/callhome/profile* # commit-buffer

switch-A /monitoring/callhome/profile #

Related Commands Command Description


show callhome
show profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 309
Commands
create qos-policy

create qos-policy
To create a QoS policy, use the create qos-policy command in org mode.

create qos-policy policy-name

Syntax Description policy-name The name of the QoS policy. A unique set of numbers or letters that identifies
the policy. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to create a QoS policy:


switch-A# scope org
switch-A /org # create qos-policy qp10
switch-A /org* # commit-buffer
switch-A /org #

Related Commands Command Description


show egress-policy
show qos-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


310 OL-25718-02
Commands
create rack

create rack
To create a rack qualifier, use the create rack command.

create rack minimum-slot-id maximum-slot-id

Syntax Description minimum-slot-id The minimum slot ID for the rack. It must be a value between 1 and
255.

maximum-slot-id The maximum slot ID for the rack. It must be a value between 1 and
255.

Command Default None

Command Modes Server Pool Policy Qualification (/org/server-qual)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A server pool policy qualification must be created to use this command.

Examples This example shows how to create a rack qualifier.


UCS-A # scope org test
UCS-A /org # scope server-qual sample-policy
UCS-A /org/server-qual # create rack 2 45
UCS-A /org/server-qual/rack* # commit-buffer
UCS-A /org/server-qual/rack #

Related Commands Command Description


enter rack

scope rack

show rack

delete rack

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 311
Commands
create role

create role
To create a role, use the create role command.

create role name

Syntax Description name Role name. The range of valid values is 1 to 16.

Command Default None

Command Modes Local user (/security/local-user)


Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a role, and enter organization role mode.

Examples This example shows how to create a role:

switch-A# scope security

switch-A /security # create role admin

switch-A /security/role* # commit-buffer

switch-A /security/role #

Related Commands Command Description


show local-user
show role

Cisco UCS Manager CLI Command Reference, Release 2.0


312 OL-25718-02
Commands
create san-image

create san-image
To create a SAN image, use the create san-image command.

create san-image {primary| secondary}

Syntax Description primary Specifies primary image.

secondary Specifies secondary image.

Command Default None

Command Modes Storage (/org/service-profile/boot-def/storage)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Only one SAN image can be created and committed.
Use this command to create a SAN image, and enter organization SAN image mode.

Examples This example shows how to create a SAN image:


switch#
scope org org3

switch /org # scope service-profile sp1

switch /org/service-profile # scope boot-def

switch /org/service-profile/boot-def # scope storage

switch /org/service-profile/boot-def/storage # create san-image primary

switch /org/service-profile/boot-def/storage/san-image* # commit-buffer

switch /org/service-profile/boot-def/storage/san-image #

Related Commands Command Description


show local
show san-image

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 313
Commands
create scheduler

create scheduler
To create a scheduler, use the create scheduler command.

create scheduler name

Syntax Description name The name of the scheduler. This name can include a maximum of 16 characters.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the scheduler can include alphanumeric characters, but cannot include any special characters.

Examples This example shows how to create a scheduler.


Switch-A # scope system
Switch-A /system # create scheduler Default
Switch-A /system/scheduler* # commit-buffer
Switch-A /system/scheduler #

Related Commands Command Description


scope scheduler
enter scheduler
show scheduler
set scheduler
delete scheduler

Cisco UCS Manager CLI Command Reference, Release 2.0


314 OL-25718-02
Commands
create scrub-policy

create scrub-policy
To create a scrub policy, use the create scrub-policy command.

create scrub-policy name

Syntax Description name Scrub policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a scrub policy, and enter organization scrub policy mode.

Examples This example shows how to create a scrub policy:

switch# scope org org100

switch /org # create scrub-policy scrub100

switch /org/scrub-policy* # commit-buffer

switch /org/scrub-policy #

Related Commands Command Description


show server-disc-policy
show scrub-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 315
Commands
create server

create server
To create a server, use the create server command.

create server {server-name}

Syntax Description server-name The name of the server. Valid entries for this value are a name or an IP address.
The range of valid values for a name is 1 to 16.

Command Default None

Command Modes LDAP (/security/ldap)


TACACS (/security/tacacs)
RADIUS (/security/radius)

Command History Release Modification


1.0(1) This command was introduced with two options server-name and chassis-id/slot-id.
Also, this command could have been used to create a server in the VMware management
mode and the server pool mode.

1.4(1) The command options have been modified. With this release, you only need to specify the
name of the server, or the host IP address. The name of the server can include a maximum
of 16 characters.
This command is not available in the VMware management mode.
The options for this command in the server pool mode have been modified. See create
server server-pool command.

Usage Guidelines This command takes the name argument only in the /org/server-pool mode.
Use this command to create a server, and enter organization server mode.

Examples This example shows how to create a server:


switch-A#
scope security

switch-A /security # scope radius

switch-A /security/radius # create server radius 209.165.200.226

switch-A /security/radius/server* # commit-buffer

Cisco UCS Manager CLI Command Reference, Release 2.0


316 OL-25718-02
Commands
create server

switch-A /security/radius/server #

Related Commands Command Description


create server server-pool
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 317
Commands
create server (/org/server-pool)

create server (/org/server-pool)


To create a server in the server pool, use the create server command.

create server {rack-id| chassis-id / blade-id}

Syntax Description rack-id The ID of the rack that the server will belong to. The value must be an
integer between 1 and 255.

chassis-id / blade-id The chassis and blade identification numbers.

Command Default None

Command Modes Server Pool (/org/server-pool)

Command History Release Modification


1.4(1) This command was introduced in the Server Pool mode with modified options.

Usage Guidelines A server pool must be created to use this command.


The ID of the rack that the server will belong to must be an integer between 1 and 255.

Examples This example shows how to create a server in the server-pool.


Switch-A # scope org Sample
Switch-A /org # scope server-pool default
Switch-A /org/server-pool # create server 4/5
Switch-A /org/server-pool* # commit-buffer
Switch-A /org/server-pool #

Related Commands Command Description


create server-pool

create server

Cisco UCS Manager CLI Command Reference, Release 2.0


318 OL-25718-02
Commands
create server-autoconfig-policy

create server-autoconfig-policy
To create a server automatice configuration policy, use the create server-autoconfig-policy command.

create server-autoconfig-policy name

Syntax Description name Policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines The server-autoconfig-policy command is definable only in org /.


Use this command to create a server automatic configuration policy with the specified policy name, and enters
organization server automatic configuration policy mode.

Examples This example shows how to create a server autoconfiguration policy:

switch#scope org org3

switch /org # create server-autoconfig-policy sap110

switch /org/server-autoconfig-policy* # commit-buffer

switch /org/server-autoconfig-policy #

Related Commands Command Description


show server-disc-policy
show server-autoconfig-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 319
Commands
create server-disc-policy

create server-disc-policy
To create a server discovery policy, use the create server-disc-policy command.

create server-disc-policy name

Syntax Description name Server discovery policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines The server-disc-policy command is definable only in org /.


Use this command to create a server discovery policy, and enter organization server discovery policy mode.

Examples This example shows how to create a server discovery policy:

switch#scope org org3

switch /org # create server-disc-policy sdp110

switch /org/server-disc-policy* # commit-buffer

switch /org/server-disc-policy #

Related Commands Command Description


show server-disc-policy
show server-autoconfig-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


320 OL-25718-02
Commands
create server-inherit-policy

create server-inherit-policy
To create a server inherit policy, use the create server-inherit-policy command.

create server-inherit-policy name

Syntax Description name Policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines The server-inherit-policy command is definable only in org /.


Use this command to create a server inherit policy, and enter organization server inherit policy mode.

Examples This example shows how to create a server inherit policy:

switch#scope org /

switch /org # create server-inherit-policy sip110

switch /org/server-inherit-policy* # commit-buffer

switch /org/server-inherit-policy #

Related Commands Command Description


show server-disc-policy
show server-inherit-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 321
Commands
create server-pool

create server-pool
To create a server pool, use the create server-pool command.

create server-pool name

Syntax Description name Server pool name. The name can be up to 32 alphanumeric characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a server pool, and enter organization server pool mode.

Examples This example shows how to create a server pool:


switch#scope org org3
switch /org # create server-pool sPool10
switch /org/server-pool* # commit-buffer
switch /org/server-pool #

Related Commands Command Description


show org
show server-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


322 OL-25718-02
Commands
create server-qual

create server-qual
To create a server qualifier, use the create server-qual command.

create server-qual name

Syntax Description name Server qualifier name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a server qualifier, and enter organization server qualification mode.

Examples This example shows how to create a server qualifier:

switch#scope org org3

switch /org # create server-qual sql10

switch /org/server-qual* # commit-buffer

switch /org/server-qual #

Related Commands Command Description


show server-pool
show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 323
Commands
create server-ref

create server-ref
To create a server reference for an authentication server group, use the create server-ref command.

create server-ref name

Syntax Description name The name of the server. You can enter either a name or the IP address of the server.

Command Default None

Command Modes Authentication Server Group within LDAP (/security/ldap/auth-server-group)


Authentication Server Group within Radius (/security/radius/auth-server-group)
Authentication Server Group within TACACS (/security/tacacs/auth-server-group)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication server group and a server must be created to use this command.

Examples This example shows how to add a server reference to an authentication server group within LDAP.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope auth-server-group Sample
Switch-A /security/ldap/auth-server-group # create server-ref example
Switch-A /security/ldap/auth-server-group/server-ref* # commit-buffer
Switch-A /security/ldap/auth-server-group/server-ref #

Related Commands Command Description


scope server-ref
enter server-ref
show server-ref
delete server-ref

Cisco UCS Manager CLI Command Reference, Release 2.0


324 OL-25718-02
Commands
create service-profile

create service-profile
To create a service profile, use the create service-profile command.

create service-profile name [initial-template| instance| updating-template]

Syntax Description name The service profile name. This name can be between 2 and 32 alphanumeric
characters long. You cannot use spaces or any special characters, and you
cannot change this name after the object has been saved.

initial-template Specifies that instances will not automatically update if this template is updated.

instance Specifies the service profile instance.

updating-template Specifies that instances will automatically update if this template is updated.

Command Default None.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a service profile, and enter service profile mode.

Examples The following example shows how to create a service profile.


switch# scope org org110
switch /org # create service-profile spEast110
switch /org/service-profile* # commit-buffer
switch /org/service-profile #

Related Commands Command Description


show ipmi-access-profile
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 325
Commands
create slot

create slot
To create a slot, use the create slot command.

create slot min-id max-id

Syntax Description min-id Minimum slot identification number. The range of valid values is 1 to 8.

max-id Maximum slot identification number. The range of valid values is 1 to 8.

Command Default None

Command Modes Chassis (/org/server-qual/chassis)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a slot with the specified ID, and enters organization slot mode.

Examples This example shows how to create a slot:

switch# scope org org10

switch /org # scope server-qual sq10

switch /org/server-qual # scope chassis 1 1

switch /org/server-qual/chassis # create slot 1 1

switch /org/server-qual/chassis/slot* # commit-buffer

switch /org/server-qual/chassis/slot #

Related Commands Command Description


show chassis
show slot

Cisco UCS Manager CLI Command Reference, Release 2.0


326 OL-25718-02
Commands
create snmp-trap

create snmp-trap
To create an SNMP trap, use the create snmp-trap command.

create snmp-trap ip-address

Syntax Description ip-address Host IP address. Specify the IP address in the format A.B.C.D.

Command Default None

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You must create an SNMP community before you create an SNMP trap.

Examples This example shows how to create an SNMP trap:

switch#scope monitoring

switch /monitoring # create snmp-trap 192.0.2.34

switch /monitoring/snmp-trap* # commit-buffer

switch /monitoring/snmp-trap #

Related Commands Command Description


show snmp
show snmp-trap

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 327
Commands
create snmp-user

create snmp-user
To create an SNMPv3 user, use the create snmp-user command.

createsnmp-useruser-name

Syntax Description user-name User name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(2) This command was introduced.

Examples This example shows how to create an SNMPv3 user:

switch-A# scope monitoring

switch-A /monitoring # create snmp-user snmpUser10

switch-A /monitoring* # commit-buffer

switch-A /monitoring #

Related Commands Command Description


show snmp
show snmp-user

Cisco UCS Manager CLI Command Reference, Release 2.0


328 OL-25718-02
Commands
create sol-config

create sol-config
To create a Serial over LAN (SoL) configuration, use the create sol-config command.

create sol-config

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a SoL configuration, and enter organization SoL configuration mode.

Examples This example shows how to create a SoL configuration:

switch-A# scope org org30

switch-A /org # scope service-profile sp30a

switch-A /org/service-profile # create sol-config

switch-A /org/service-profile/sol-config* # commit-buffer

switch-A /org/service-profile/sol-config #

Related Commands Command Description


show sol-config
show sol-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 329
Commands
create sol-policy

create sol-policy
To create an SoL policy, use the create sol-policy command.

create sol-policy name

Syntax Description name SoL policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a SoL policy with the specified name, and enters organization SoL policy mode.

Examples This example shows how to create a SoL policy:

switch-A# scope org org3

switch-A /org # create sol-policy solpol1

switch-A /org/sol-policy* # commit-buffer

switch-A /org/sol-policy #

Related Commands Command Description


show org
show sol-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


330 OL-25718-02
Commands
create static-ip-params

create static-ip-params
To configure static initiator IP parameters, use the create static-ip-params command.

create static-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface of the iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an IPv4 interface for the iSCSI VNIC before you use this command.

Examples This example shows how to configure static initiator IP parameters for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # create static-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/static-ip-params* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/static-ip-params #

Related Commands Command Description


set addr

set default-gw

set primary-dns

set secondary-dns

set subnet

enter static-ip-params

scope static-ip-params

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 331
Commands
create static-ip-params

Command Description
delete static-ip-params

show static-ip-params

create dhcp-ip-params

create pooled-ip-params

create ip-if

Cisco UCS Manager CLI Command Reference, Release 2.0


332 OL-25718-02
Commands
create static-target-if

create static-target-if
To configure a static target interface for an iSCSI VNIC, use the create static-target-if command.

create static-target-if static target priority

Syntax Description static target priority Priority level of the static target interface. The value can either be 1
or 2.

Command Default None

Command Modes Ethernet interface of an iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI VNIC, and an Ethernet interface for the iSCSI VNIC before you use this command.

Examples This example shows how to create a static target interface for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # create static-target-if 1
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if #

Related Commands Command Description


create lun

enter static-target-if

scope static-target-if

show static-target-if

delete static-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 333
Commands
create stats-threshold-policy

create stats-threshold-policy
To create a statistics threshold policy, use the create stats-threshold-policy command.

create stats-threshold-policy name

Syntax Description name Policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a statistics threshold policy, and enter organization statistics threshold policy
mode.

Examples This example shows how to create a statistics threshold policy:

switch# scope org org10

switch /org # create stats-threshold-policy stp10

switch /org/stats-threshold-policy* # commit-buffer

switch /org/stats-threshold-policy #

Related Commands Command Description


show pooling-policy
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


334 OL-25718-02
Commands
create storage

create storage
To create storage, use the create storage command.

create storage

This command has no arguments or keywords.

Command Default None

Command Modes Boot definition (/org/service-profile/boot-def)


Boot policy (/org/boot-policy)
Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a storage qualification, and enter organization server qualification storage mode.

Examples This example shows how to create storage:

switch-A# scope org org3

switch-A /org # scope service-profile sp1

switch-A /org/service-profile # scope boot-def bd1

switch-A /org/service-profile/boot-def # create storage

switch-A /org/service-profile/boot-def/storage* # commit-buffer

switch /org/service-profile/boot-def/storage #

Related Commands Command Description


show boot-definition
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 335
Commands
create threshold-value

create threshold-value
To create a threshold value for a property, use the create threshold-value command.

create threshold-value {above-normal | below-normal} {cleared | condition | critical | info | major |


minor | warning}

Syntax Description above-normal Sets the value to above normal.

below-normal Sets the value to below normal.

cleared Sets the threshold value to cleared.

condition Sets the threshold value to condition.

critical Sets the threshold value to critical.

info Sets the threshold value to info.

major Sets the threshold value to major.

minor Sets the threshold value to minor.

warning Sets the threshold value to warning.

Command Default None

Command Modes Ethernet uplink (/eth-uplink/stats-threshold-policy/class/property)


Fibre channel (/fc-uplink/stats-threshold-policy/class/property)
Ethernet server (/eth-server/stats-threshold-policy/class/property)
Organization (/org/stats-threshold-policy/class/property)

Command History Release Modification


1.0.1 This command was introduced.

Usage Guidelines This command creates the specified threshold value for the class property and enters organization statistics
threshold policy class property threshold value mode. You must have a class and a property created in order
to execute the set threshold-value command. The command is used to set the value of the property you
created.

Cisco UCS Manager CLI Command Reference, Release 2.0


336 OL-25718-02
Commands
create threshold-value

You can configure multiple threshold values for a class property. Before you use this command, use the set
normal-value command to set a baseline.

Examples The following example shows how to set the threshold value for the bytes-rx-delta property in vnic-stats class:
switch-A#scope org org100
switch-A /org # scope stats-threshold-policy stp100

switch-A /org/stats-threshold-policy # scope class vnic-stats


switch-A /org/stats-threshold-policy/class # scope property bytes-rx-delta
switch-A /org/stats-threshold-policy/class/property # create threshold-value above-normal
critical
switch-A /org/stats-threshold-policy/class/property* # commit-buffer
switch-A /org/stats-threshold-policy/class/property #

Related Commands Command Description


show property
show threshold-value

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 337
Commands
create trustpoint

create trustpoint
To create a trustpoint, use the create trustpoint command.

create trustpoint name

Syntax Description name Trustpoint name. The name can be up to 16 alphanumeric characters.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to identify the trustpoints that will be used to validate a certificate during Internet Key
Exchange (IKE) authentication, and enter organization trustpoint mode.

Examples This example shows how to create a trustpoint:


switch-A# scope security
switch-A /security # create trustpoint tPoint10
switch-A /security/trustpoint* # commit-buffer
switch-A /security/trustpoint #

Related Commands Command Description


show keyring
show trustpoint

Cisco UCS Manager CLI Command Reference, Release 2.0


338 OL-25718-02
Commands
create uuid-suffix-pool

create uuid-suffix-pool
To create a UUID suffix pool, use the create uuid-suffix-pool command.

create uuid-suffix-pool name

Syntax Description name UUID suffix pool name. The name can be up to 32 alphanumeric characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Creates a UUID suffix pool with the specified name, and enters organization UUID suffix pool mode.

Examples This example shows how to create a UUID suffix pool:


switch-A# scope org org3
switch-A /org # create uuid-suffix-pool uuidsp1
switch-A /org/uuid-suffix-pool* # commit-buffer
switch-A /org/uuid-suffix-pool #

Related Commands Command Description


show uuid-suffix-pool
show wwn-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 339
Commands
create vcenter

create vcenter
To create a VCenter, use the create vcenter command in vmware mode.

create vcenter vcenter-name

Syntax Description vcenter-name The name of the VCenter. A unique set of numbers or letters that identifies the
VCenter. The range of valid values is 1 to 16.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to create a VCenter:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # create vcenter vc10
switch-A /system/vm-mgmt/vmware* # commit-buffer
switch-A /system/vm-mgmt/vmware #

Related Commands Command Description


show vcenter
show virtual-machine

Cisco UCS Manager CLI Command Reference, Release 2.0


340 OL-25718-02
Commands
create vcon

create vcon
To create a vCon (virtual network interface connection), use the create vcon command.

create vcon {1 | 2}

Syntax Description 1 Specifies virtual network interface connection 1.

2 Specifies virtual network interface connection 2.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to create a vCon:


switch-A# scope org org100
switch-A /org # scope service-profile sp100
switch-A /org/service-profile # create vcon vc100
switch-A /org/service-profile* # commit-buffer
switch-A /org/service-profile #

Related Commands Command Description


show service-profile
show vcon

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 341
Commands
create vcon-policy

create vcon-policy
To create a vCon policy (vNIC/vHBA placement profile), use the create vcon-policy command.

create vcon-policy policy-name

Syntax Description policy-name The name of the policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Creates the specified vCon policy and enters organization vcon-policy mode. vCon policies determine the
placement and distribution of vNICs and vHBAs between the adapters for a server that has more than one
adapter.
policy-name should be a unique set of numbers or letters that identifies the policy. The range of valid values
is 1 to 16.

Examples This example shows how to create a vCon policy:


switch-A# scope org /
switch-A /org # create vcon-policy vcp100
switch-A /org* # commit-buffer
switch-A /org #

Related Commands Command Description


show vcon
show vcon-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


342 OL-25718-02
Commands
create vhba

create vhba
To create a virtual HBA vHBA), use the create vhba command.

create vhba name {fabric {a| b}| fc-if fc-if}*

Syntax Description name vHBA name. The range of valid values is 1 to 16.

fabric Specifies a fabric.

a Specifies fabric A.

b Specifies fabric B.

fc-if Specifies a Fibre Channel interface.

interface-name Interface name. The range of valid values is 1 to 16.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a vHBA, and enter organization virtual HBA mode.

Examples This example shows how to create a vHBA:

switch-A# scope org org30

switch-A /org # scope service-profile sp10a

switch-A /org/service-profile # create vhba 10a

switch-A /org/service-profile/vhba* # commit-buffer

switch-A /org/service-profile/vhba #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 343
Commands
create vhba

Related Commands Command Description


show vhba
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


344 OL-25718-02
Commands
create vhba-templ

create vhba-templ
To create a vHBA template, use the create vhba-templ command.

create vhba-templ name {fabric {a| b}| fc-if fci-name}*

Syntax Description name vHBA template name. The range of valid values is 1 to 16.

fabric Specifies fabric.

a Specifies fabric A.

b Specifies fabric B.

fc-if Specifies a Fibre Channel interface.

fci-name Fibre Channel interface name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines A vHBA is a virtualized host bus adapter that is configured on a physical network adapter and appears to be
a physical HBA to the operating system of the server. The type of adapter in the system determines how many
vHBAs you can create.
Use this command to create a vHBA template, and enter organization virtual HBA template mode.

Examples This example shows how to create a vHBA template:

switch-A# scope org org10

switch-A /org # create vhba-templ vhbat10

switch-A /org/vhba-templ* # commit-buffer

switch-A /org/vhba-templ #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 345
Commands
create vhba-templ

Related Commands Command Description


show fc-if
show vhba-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


346 OL-25718-02
Commands
create virtual-media

create virtual-media
To create virtual media, use the create virtual-media command.

create virtual-media {read-only| read-write}

Syntax Description read-only Specifies read-only virtual media.

read-write Specifies read and write virtual media.

Command Default None

Command Modes Boot policy (/org/boot-policy)


Boot definition (/org/service-profile/boot-def)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create virtual media with the specified name, and enters organization virtual-media
mode.

Examples This example shows how to create virtual media:

switch-A# scope org org3

switch-A /org # scope service-profile sp1

switch-A /org/service-profile # scope boot-def

switch-A /org/service-profile/boot-definition # create virtual-media read-write

switch-A /org/service-profile/boot-definition/virtual-media* # commit-buffer

switch-A /org/service-profile/boot-definition/virtual-media #

Related Commands Command Description


show storage
show virtual-media

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 347
Commands
create vlan

create vlan
To create a VLAN, use the create vlan command.

create vlan name id

Syntax Description name VLAN name. The name can contain up to 32 characters.

id VLAN identification number. The range of valid values is 1 to 3967 and 4049 to
4093.

Command Default None

Command Modes Ethernet uplink (/eth-uplink)


Fabric within Ethernet Uplink (/eth-uplink/fabric)
Fabric within Ethernet Storage (eth-storage/fabric)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was introduced for a fabric within the Ethernet Storage command mode.
In addition, the following changes were introduced:
• Number of characters for the vlan name has been extended from 16 to 32.
• The range of valid values was modified from 4048 - 4093 to 4049 - 4093.

2.0(2) Starting with this release, overlapping Ethernet VLAN and FCoE VLAN IDs are not
allowed. If Cisco UCS Manager detects an overlapping ID, it raises a critical fault.

Usage Guidelines Use this command to create a VLAN with the specified name and identifier number and enter vlan mode.
Starting with 2.0(2) release, overlapping Ethernet VLAN and FCoE VLAN IDs are not allowed. If Cisco UCS
Manager detects an overlapping ID, it raises a critical fault and drops Ethernet traffic on the overlapped
VLANs. Ensure that there are no overlapping Ethernet and FCoE VLAN IDs before upgrading to Cisco UCS
Release 2.0.

Examples This example shows how to create a VLAN:


switch-A# scope eth-uplink
switch-A /eth-uplink # create vlan vlan1 10

Cisco UCS Manager CLI Command Reference, Release 2.0


348 OL-25718-02
Commands
create vlan

switch-A /eth-uplink/vlan* # commit-buffer


switch-A /eth-uplink/vlan #

Related Commands Command Description


show interface
show vlan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 349
Commands
create vlan (/port-profile)

create vlan (/port-profile)


To create a VLAN for a port profile, use the create vlan command.

create vlan name

Syntax Description name VLAN name. The name can contain up to 32 characters.

Command Default None

Command Modes Port profile (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.1(1) This command was introduced.

1.4(1) The command option was modified to accept a value with a maximum of 32
characters. Prior to this release, the maximum number of characters was 16.

Usage Guidelines Use this command to create a VLAN with the specified name for a port profile and enter vlan mode.

Examples This example shows how to create a VLAN for a port profile:
switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope profile-set
switch-A /system/vm-mgmt/vmware/profile-set # scope port-profile pp100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile # create vlan v100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile/vlan* # commit-buffer
switch-A /system/vm-mgmt/vmware/profile-set/port-profile/vlan #

Related Commands Command Description


show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


350 OL-25718-02
Commands
create vnic

create vnic
To create a VNIC (Virtual Network Interface Card), use the create vnic command.

create vnic name {fabric {a| a-b| b| b-a}| eth-if eth-if}*

Syntax Description name VNIC template name. The range of valid values is 1 to 16.

fabric Specifies the fabric switch identification number.

a Specifies switch A.

a-b Specifies redundant, with switch A as primary.

b Specifies switch B.

b-a Specifies redundant, with switch B as primary.

eth-if Specifies a Ethernet interface.

eth-if Ethernet interface name. The range of valid values is 1 to 16.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a vNIC with the specified name, and enters organization virtual NIC mode.

Examples This example shows how to create a vNIC:

switch-A# scope org org3

switch-A /org # scope service-profile sp1

switch-A /org/service-profile # create vnic vnic110

switch-A /org/service-profile/vnic* # commit-buffer

switch-A /org/service-profile/vnic #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 351
Commands
create vnic

Related Commands Command Description


show interface
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


352 OL-25718-02
Commands
create vnic-egress-policy

create vnic-egress-policy
To create a VNIC egress policy, use the create vnic-egress-policy command.

create vnic-egress-policy

This command has no arguments or keywords.

Command Default None

Command Modes Virtual NIC QoS (/org/vnic-qos)

Command History Release Modification


1.0(1) This command was introduced.

Use this command to create a vNIC egress policy, and enter organization virtual NIC egress policy mode.

Examples This example shows how to create a vNIC egress policy:

switch-A# scope org org3

switch-A /org # scope vnic-qos vnicq1

switch-A /org/vnic-qos # create vnic-egress-policy

switch-A /org/vnic-qos* # commit-buffer

switch-A /org/vnic-qos #

Related Commands Command Description


show vnic
show vnic-egress-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 353
Commands
create vnic-iscsi

create vnic-iscsi
To create an iSCSI VNIC for a service profile, use the create vnic-iscsi command.

create vnic-iscsi name

Syntax Description name Name of the iSCSI VNIC. The name can include a maximum of 16 characters.

Command Default None

Command Modes Service Profile (/org/service-profile)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a service profile before you use this command.
The name of the iSCSI VNIC cannot exceed 16 characters.

Examples This example shows how to create an iSCSI VNIC for a service profile:
UCS-A # scope org Test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # create vnic-iscsi Trial
UCS-A /org/service-profile/vnic-iscsi* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi #

Related Commands Command Description


scope vnic-iscsi

enter vnic-iscsi

show vnic-iscsi

delete vnic-iscsi

Cisco UCS Manager CLI Command Reference, Release 2.0


354 OL-25718-02
Commands
create vnic-templ

create vnic-templ
To create a VNIC template, use the create vnic-templ command.

create vnic-templ name {fabric {a| a-b| b| b-a}| target {adapter| vm}+| eth-if eth-if}*

Syntax Description name vNIC template name. The range of valid values is 1 to 16.

fabric Specifies the fabric switch identification number.

a Specifies switch A.

a-b Specifies redundant, with switch A as primary.

b Specifies switch B.

b-a Specifies redundant, with switch B as primary.

target Specifies whether or not Cisco UCS Manager automatically creates a VM-FEX
port profile with the appropriate settings for the vNIC template. The target can
either be an adapter or a VM.

adapter Specifies the adapter.

vm Specifies the virtual machine.

eth-if Specifies a Ethernet interface.

eth-if Ethernet interface name. The range of valid values is 1 to 16.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a vNIC template, and enters organization virtual NIC template mode.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 355
Commands
create vnic-templ

Examples This example shows how to create a vNIC template:


UCS-A# scope org org3
UCS-A /org # create vnic-templ vnict1 eth-if 10
UCS-A /org/vnic-templ* # commit-buffer
UCS-A /org/vnic-templ #

Related Commands Command Description


show eth-if
show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


356 OL-25718-02
Commands
create vsan

create vsan
To create a VSAN, use the create vsan command.

create vsan name id fcoe-vlan

Syntax Description name VSAN name. The range of valid values is 1 to 16.

id VSAN identification number. The range of valid values is 1 to 4093.

fcoe-vlan Fibre Channel over Ethernet VLAN. The range of valid values is 1 to 4093.

Command Default None

Command Modes Fibre Channel uplink (/fc-uplink)


Fibre Channel Storage (/fc-storage)
Fabric within Fibre Uplink (/fc-uplink/fabric)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was introduced in the following command modes:


Fibre Channel Storage (/fc-storage)
Fabric within Fibre Uplink (/fc-uplink/fabric)
This command was obsoleted from the following mode:
Switch within Fibre Channel uplink (/fc-uplink/switch)
The maximum number of characters of the VLAN interface name is modified from 16
to 32.

Usage Guidelines Use this command to create a VSAN with the specified name, and enters organization VSAN mode.
You can create a named VSAN with IDs from 1 to 4093. VSANs configured on different FCoE VLANs
cannot share the same ID.

Examples This example shows how to create a VSAN:

switch-A# scope fc-uplink

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 357
Commands
create vsan

switch-A /fc-uplink # create vsan vs2 6 10

switch-A /fc-uplink/vsan* # commit-buffer

switch-A /fc-uplink/vsan #

Related Commands Command Description


show vif
show vsan

Cisco UCS Manager CLI Command Reference, Release 2.0


358 OL-25718-02
Commands
create wwn-pool

create wwn-pool
To create a WWN (World Wide Name) pool, use the create wwn-pool command.

create wwn-pool name{node-wwn-assignment| port-wwn-assignment}

Syntax Description name WWN pool name. The name can be up to 32 alphanumeric
characters.

node-wwn-assignment Specifies world wide node name assignment.

port-wwn-assignment Specifies world wide node port assignment.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a WWN pool with the specified name, and enters organization WWN pool mode.
A WWN pool can include only WWNNs or WWPNs in the 20:xx range. All other WWN ranges are reserved.

Examples This example shows how to create a WWN pool:


switch-A# scope org org3
switch-A /org # create wwn-pool wwnp1 port-wwn-assignment
switch-A /org/wwn-pool* # commit-buffer
switch-A /org/wwn-pool #

Related Commands Command Description


show mac-pool
show wwn-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 359
Commands
cycle

cycle
To cycle a server, use the cycle command.

cycle {cycle-immediate| cycle-wait}

Syntax Description cycle-immediate Specifies cycle immediately.

cycle-wait Specifies wait to cycle.

Command Default None

Command Modes Server (/chassis/server)


Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to cycle a server:

switch-A# scope server 2/4

switch-A /chassis/server # cycle cycle-immediate

switch-A /chassis/server* # commit-buffer

switch-A /chassis/server #

Cisco UCS Manager CLI Command Reference, Release 2.0


360 OL-25718-02
Commands
decommission chassis

decommission chassis
To decommission a chassis, use the decommission chassis command.

decommission chassis id

Syntax Description id Chassis identification number.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to decommission a chassis:

switch-A# decommission chassis 2

switch-A* # commit-buffer

switch-A #

Related Commands Command Description


show chassis
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 361
Commands
decommission fex

decommission fex
To decommission a Fabric extender module, use the decommission fex command.

decommission fex id

Syntax Description id The ID of the Fabric extender module.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to decommission a Fabric extender module.


Switch-A # scope org
Switch-A /org # decommission fex 2
Switch-A /org* # commit-buffer
Switch-A /org #

Related Commands Command Description


remove fex

Cisco UCS Manager CLI Command Reference, Release 2.0


362 OL-25718-02
Commands
decommission server

decommission server
To decommission a server, use the decommission server command.

decommission server {ID | chassis-id/blade-id}

Syntax Description Id Chassis identification number. It


must be a value between 1 and 255.

chassis-id/blade-id Server chassis and blade


identification number. The values
must be entered in the n/n format.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced with the chassis-id/blade-id option.

1.4(1) The option to specify the chassis identification number was introduced.

Examples This example shows how to decommission a server:

switch-A# decommission server 1/1

switch-A* # commit-buffer

switch-A #

Related Commands Command Description


decommission server (chassis)

show chassis
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 363
Commands
decommission server (chassis)

decommission server (chassis)


To decommission a server for a chassis, use the decommission server command.

decommission server slot ID

Syntax Description ID The identification number of the slot. It must be a value between 1 and 8.

Command Default None

Command Modes Chassis (/chassis)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to decommission a server for a chassis.


Switch-A # scope chassis 1
Switch-A /chassis # decommission server 1
Switch-A /chassis* # commit-buffer
Switch-A /chassis #

Related Commands Command Description


decommission server

Cisco UCS Manager CLI Command Reference, Release 2.0


364 OL-25718-02
Commands
delete adapter

delete adapter
To delete the adapter, use the delete adapter command.

delete adapter

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete an adapter:

switch-A# scope org org3

switch-A /org # scope server-qual squal100

switch-A /org/server-qual # delete adapter

switch-A /org/server-qual* # commit-buffer

switch-A /org/server-qual #

Related Commands Command Description


show adapter
show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 365
Commands
delete auth-domain

delete auth-domain
To delete an authentication domain, use the delete auth-domain command.

delete auth-domain name

Syntax Description name The name of the authentication domain.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication domain must be created to use this command.

Examples This example shows how to delete an authentication domain:


Switch-A # scope security
Switch-A /security # delete auth-domain Default
Switch-A /security* # commit-buffer
Switch-A /security #

Related Commands Command Description


scope auth-domain
create auth-domain

Cisco UCS Manager CLI Command Reference, Release 2.0


366 OL-25718-02
Commands
delete auth-profile

delete auth-profile
To delete an iSCSI authorization profile for the organization mode, use the delete auth-profile command.

delete auth-profile iscsi-auth-profile-name

Syntax Description iscsi-auth-profile-name The name of the iSCSI authorization profile. It is the name that you
provided while creating the profile.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines An iSCSI authorization profile must be created to use this command.

Examples This example shows how to delete an iSCSI authorization profile for the organization mode.
UCS-A # scope org test
UCS-A /org # delete auth-profile sample
UCS-A /org* # commit-buffer
UCS-A /org #

Related Commands Command Description


create auth-profile

enter auth-profile

scope auth-profile

show auth-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 367
Commands
delete auth-server-group

delete auth-server-group
To delete an authentication server group, use the delete auth-server-group command.

delete auth-server-group authentication server group

Syntax Description authentication server group The name of the authentication server group.

Command Default None

Command Modes LDAP (/security/ldap)


RADIUS (/security/radius)
TACACS (/security/tacacs)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None.

Examples This example shows how to delete an authentication server group.


Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # delete auth-server-group Default
Switch-A /security/ldap/auth-server-group* # commit-buffer
Switch-A /security/ldap #

Related Commands Command Description


create auth-server-group
scope auth-server-group

Cisco UCS Manager CLI Command Reference, Release 2.0


368 OL-25718-02
Commands
delete auto-target-if

delete auto-target-if
To delete a configured automatic target interface of the Ethernet interface for an iSCSI VNIC, use the delete
auto-target-if command.

delete auto-target-if

This command has no arguments or keywords.

Command Default None

Command Modes Ethernet interface within the iSCSI VNIC mode (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI VNIC, an Ethernet interface for the iSCSI VNIC, and an automatic target interface
before you use this command.

Examples This example shows how to delete an automatic target interface of the Ethernet interface for the iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # delete auto-target-if
UCS-A /org/service-profile/vnic-iscsi/eth-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if #

Related Commands Command Description


create auto-target-if

enter auto-target-if

scope auto-target-if

show auto-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 369
Commands
delete backup

delete backup
To delete backup, use the delete backup command.

delete backup name

Syntax Description name Backup name.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete backup:

switch-A# scope system

switch-A /system # delete backup backUpFDrive

switch-A /system* # commit-buffer

switch-A /system #

Related Commands Command Description


show backup
show import-config

Cisco UCS Manager CLI Command Reference, Release 2.0


370 OL-25718-02
Commands
delete bladeserver-disc-policy

delete bladeserver-disc-policy
To delete a compute blade server discovery policy, use the delete bladeserver-disc-policy command.

delete bladeserver-disc-policy name

Syntax Description name The name of the compute blade server discovery policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to delete a compute blade server discovery policy.
Switch-A # scope org
Switch-A /org # delete bladeserver-disc-policy Default
Switch-A /org* # commit-buffer
Switch-A /org #

Related Commands Command Description


create bladeserver-disc-policy
scope bladeserver-disc-policy
enter bladeserver-disc-policy
show bladeserver-disc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 371
Commands
delete block

delete block
To delete a block, use the delete block command.

delete block from to

IQN Pool Configuration


delete block suffix from to

Syntax Description suffix The name of the suffix for the block
that you had specified for an IQN
pool.

from Start UUID.


For an IQN pool, it is a number
between 0 and 65535.

to End UUID.
For an IQN pool, it is a number
between 0 and 65535.

Command Default None

Command Modes UUID suffix pool (/org/uuid-suffix-pool)


IP pool (/org/ip-pool)
IQN pool (/org/iqn-pool)
WWN pool (/org/wwn-pool)
MAC pool (/org/mac-pool)

Command History Release Modification


1.0(1) This command was introduced.

2.0(2) This command was introduced in the IQN pool command mode.

Examples This example shows how to delete a block:


UCS-A # scope org org10
UCS-A /org # scope uuid-suffix-pool usp10
UCS-A /org/uuid-suffix-pool # delete block 1234-123412341230 1234-123412341234

Cisco UCS Manager CLI Command Reference, Release 2.0


372 OL-25718-02
Commands
delete block

UCS-A /org/uuid-suffix-pool* # commit-buffer


UCS-A /org/uuid-suffix-pool #

---------------------------------------------

UCS-A # scope org


UCS-A /org # scope iqn-pool Sample1
UCS-A /org/iqn-pool # delete block testing 1 34
UCS-A /org/iqn-pool* # commit-buffer
UCS-A /org/iqn-pool #

Related Commands Command Description


show block
show pooled

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 373
Commands
delete boot-definition

delete boot-definition
To delete a boot definition, use the delete boot-definition command.

delete boot-definition

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a boot definition:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # delete boot-definition bp10

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show boot-definition
show boot-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


374 OL-25718-02
Commands
delete boot-policy

delete boot-policy
To delete a boot policy, use the delete boot-policy command.

delete boot-policy name

Syntax Description name Boot policy name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a boot policy:

switch-A# scope org org3

switch-A /org # delete boot-policy bp110

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


show boot-policy
show chassis-disk-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 375
Commands
delete boot-target

delete boot-target
To delete a boot-target object, use the delete boot-target command.

delete boot-target {primary| secondary}

Syntax Description primary Specifies the primary boot target.

secondary Specifies the secondary boot target.

Command Default None

Command Modes WWN initiator (/org/wwn-pool/initiator)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines Before using this command, you must create a boot target object by using the create boot-target command.

Examples The following example shows how to delete a boot target:


server# scope org
server /org # scope wwn-pool default
server /org/wwn-pool # scope initiator 20:00:00:25:B5:00:00:00
server /org/wwn-pool/initiator # delete boot-target secondary
server /org/wwn-pool/initiator* # commit-buffer

Related Commands Command Description


create boot-target
enter boot-target
scope boot-target
show boot-target
show initiator

Cisco UCS Manager CLI Command Reference, Release 2.0


376 OL-25718-02
Commands
delete cap-qual

delete cap-qual
To delete a capacity qualification, use the delete cap-qual command.

delete cap-qual {fcoe| non-virtualized-eth-if| non-virtualized-fc-if| path-encap-consolidated|


path-encap-virtual| protected-eth-if| protected-fc-if| protected-fcoe| virtualized-eth-if| virtualized-fc-if|
virtualized-scsi-if}

Syntax Description fcoe Specifies the Fibre Channel over Ethernet (FCoE) qualification.

non-virtualized-eth-if Specifies the nonvirtualized Ethernet interface qualification.

non-virtualized-fc-if Specifies the nonvirtualized Fibre Channel (FC) interface


qualification.

path-encap-consolidated Specifies the path encapsulation consolidated qualification.

path-encap-virtual Specifies the path encapsulation virtual qualification.

protected-eth-if Specifies the protected Ethernet interface qualification.

protected-fc-if Specifies the protected Fibre Channel (FC) interface qualification.

protected-fcoe Specifies the protected Fcoe qualification.

virtualized-eth-if Specifies the virtualized Ethernet interface qualification.

virtualized-fc-if Specifies the virtualized Fibre Channel (FC) interface qualification.

virtualized-scsi-if Specifies the virtualized SCSI interface qualification.

Command Default None

Command Modes Adapter (/org/server-qual/adapter)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example show how to delete an FCoE capacity qualification:


server# scope org
server /org # scope server-qual all-chassis

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 377
Commands
delete cap-qual

server /org/server-qual # scope adapter


server /org/server-qual/adapter # delete cap-qual fcoe
server /org/server-qual/adapter #

Related Commands Command Description


create cap-qual

enter cap-qual

scope cap-qual

show cap-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


378 OL-25718-02
Commands
delete certreq

delete certreq
To delete a certificate request, use the delete certreq command.

delete certreq

This command has no arguments or keywords.

Command Default None

Command Modes Keyring (/security/keyring)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete certificate request:

switch-A# scope security

switch-A /security # scope keyring kr10

switch-A /security/keyring # delete certreq

switch-A /security/keyring* # commit-buffer

switch-A /security/keyring #

Related Commands Command Description


show certreq
showkeyring

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 379
Commands
delete chassis

delete chassis
To delete a chassis, use the delete chassis command.

delete chassis min-id max-id

Syntax Description min-id Minimum chassis identification number. The range of valid values is 1 to 8.

max-id Minimum chassis identification number. The range of valid values is 1 to 8.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a chassis:

switch-A# scope org org10

switch-A /org # scope server-qual sq10

switch-A /org/server-qual # delete chassis 1 1

switch-A /org/server-qual* # commit-buffer

switch-A /org/server-qual #

Related Commands Command Description


show chassis
show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


380 OL-25718-02
Commands
delete class chassis-stats

delete class chassis-stats


To delete the chassis statistics class, use the delete class chassis-stats command.

delete class chassis-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the chassis statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy stp10

switch-A /eth-server/stats-threshold-policy # delete class chassis-stats

switch-A /eth-server/stats-threshold-policy* # commit-buffer

switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


show chassis
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 381
Commands
delete class cpu-env-stats

delete class cpu-env-stats


To delete a CPU environment statistics class, use the delete class cpu-env-stats command.

delete class cpu-env-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples The following example shows how to delete the CPU statistics class:

switch-A# scope org org100

switch-A /eth-server # scope stats-threshold-policy stp100

switch-A /eth-server/stats-threshold-policy # delete class cpu-stats

switch-A /eth-server/stats-threshold-policy* # commit-buffer

switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


382 OL-25718-02
Commands
delete class dimm-env-stats

delete class dimm-env-stats


To delete a dual in-line memory module (DIMM) environment statistics class, use the delete class
dimm-env-stats command.

delete class dimm-env-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete the DIMM environment statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # delete class dimm-env-stats
server /org/stats-threshold-policy # commit-buffer
server /org/stats-threshold-policy #

Related Commands Command Description


create class dimm-env-stats

enter class dimm-env-stats

scope class dimm-env-stats

show class dimm-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 383
Commands
delete class dimm-stats

delete class dimm-stats


To delete the DIMM statistics class, use the delete class dimm-stats command.

delete class dimm-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the DIMM statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy stp10

switch-A /eth-server/stats-threshold-policy # delete class dimm-stats

switch-A /eth-server/stats-threshold-policy* # commit-buffer

switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


384 OL-25718-02
Commands
delete class env-stats

delete class env-stats


To delete an environment statistics class, use the delete class env-stats command.

delete class env-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet server statistics threshold policy(eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete an environment statistics class:


server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # delete class env-stats
server /eth-server/stats-threshold-policy* # commit-buffer
server /eth-server/stats-threshold-policy #

Related Commands Command Description


delete class env-stats

enter class env-stats

scope class env-stats

show class env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 385
Commands
delete class ether-error-stats

delete class ether-error-stats


To delete the Ethernet error statistics class, use the delete class ether-error-stats command.

delete class ether-error-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink /eth-uplink/stats-threshold-policy

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the Ethernet error statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy stp10

switch-A /eth-server/stats-threshold-policy # delete class ether-error-stats

switch-A /eth-server/stats-threshold-policy* # commit-buffer

switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


386 OL-25718-02
Commands
delete class ether-if-stats

delete class ether-if-stats


To delete the Ethernet interface statistics class, use the delete class ether-if-stats command.

delete class ether-if-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the Ethernet interface statistics class:

switch-A#scope org org3

switch-A /org # scope stats-threshold-policy stp20

switch-A /org/stats-threshold-policy # delete class ether-if-stats

switch-A /org/stats-threshold-policy* # commit-buffer

switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class
show ether-if-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 387
Commands
delete class ether-loss-stats

delete class ether-loss-stats


To delete the Ethernet loss statistics class, use the delete class ether-loss-stats command.

delete class ether-loss-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)


Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the Ethernet loss statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy stp10

switch-A /eth-server/stats-threshold-policy # delete class ether-loss-stats

switch-A /eth-server/stats-threshold-policy* # commit-buffer

switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


388 OL-25718-02
Commands
delete class ethernet-port-err-stats

delete class ethernet-port-err-stats


To delete an Ethernet port error statistics class, use the delete class ethernet-port-err-stats command.

delete class ethernet-port-err-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to delete an Ethernet port error statistics class.

Examples This example shows how to delete an Ethernet port error statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # delete class ethernet-port-err-stats
switch-A /org/stats-threshold-policy* # commit-buffer
switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 389
Commands
delete class ethernet-port-multicast-stats

delete class ethernet-port-multicast-stats


To delete an Ethernet port multicast statistics class, use the delete class ethernet-port-multicast-stats
command.

delete class ethernet-port-multicast-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to delete an Ethernet port multicast statistics class.

Examples This example shows how to delete an Ethernet port multicast statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # delete class ethernet-port-multicast-stats
switch-A /org/stats-threshold-policy/class* # commit-buffer
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


create class ethernet-port-multicast-stats
show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


390 OL-25718-02
Commands
delete class ethernet-port-over-under-sized-stats

delete class ethernet-port-over-under-sized-stats


To delete an Ethernet port over-under-sized statistics class, use the delete class
ethernet-port-over-under-sized-stats command.

delete class ethernet-port-over-under-sized-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to delete an Ethernet port over-under-sized statistics class.

Examples This example shows how to delete an Ethernet port over-under-sized statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # delete class ethernet-port-over-under-sized-stats
switch-A /org/stats-threshold-policy* # commit-buffer
switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 391
Commands
delete class ethernet-port-stats

delete class ethernet-port-stats


To delete an Ethernet port statistics class, use the delete class ethernet-port-stats command.

delete class ethernet-port-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to delete an Ethernet port statistics class.

Examples This example shows how to delete an Ethernet port statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # delete class ethernet-port-stats
switch-A /org/stats-threshold-policy* # commit-buffer
switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


392 OL-25718-02
Commands
delete class ethernet-port-stats-by-size-large-packets

delete class ethernet-port-stats-by-size-large-packets


To delete an Ethernet port large packet statistics class, use the delete class
ethernet-port-stats-by-size-large-packets command.

delete class ethernet-port-stats-by-size-large-packets

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to delete an Ethernet port large packet statistics class.

Examples This example shows how to delete an Ethernet port large packet statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # delete class ethernet-port-stats-by-size-large-packets
switch-A /org/stats-threshold-policy* # commit-buffer
switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 393
Commands
delete class ethernet-port-stats-by-size-small-packets

delete class ethernet-port-stats-by-size-small-packets


To delete an Ethernet port small packet statistics class, use the delete class
ethernet-port-stats-by-size-small-packets command.

delete class ethernet-port-stats-by-size-small-packets

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to delete an Ethernet port small packet statistics class.

Examples This example shows how to delete an Ethernet port small packet statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # delete class ethernet-port-stats-by-size-small-packets
switch-A /org/stats-threshold-policy* # commit-buffer
switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


394 OL-25718-02
Commands
delete class ether-pause-stats

delete class ether-pause-stats


To delete an Ethernet pause statistics class, use the delete class ether-pause-stats command.

delete class ether-pause-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to delete the Ethernet pause statistics class:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # delete class ether-pause-stats
server /eth-server/stats-threshold-policy* # commit-buffer
server /eth-server/stats-threshold-policy #

Related Commands Command Description


create class ether-pause-stats

enter class ether-pause-stats

scope class ether-pause-stats

show class ether-pause-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 395
Commands
delete class ether-rx-stats

delete class ether-rx-stats


To delete the Ethernet recieve statistics class, use the delete class ether-rx-stats command.

delete class ether-rx-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)


Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the Ethernet recieve statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy stp10

switch-A /eth-server/stats-threshold-policy # delete class ether-rx-stats

switch-A /eth-server/stats-threshold-policy* # commit-buffer

switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


396 OL-25718-02
Commands
delete class ether-tx-stats

delete class ether-tx-stats


To delete the Ethernet transmit statistics class, use the delete class ether-tx-stats command.

delete class ether-tx-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)


Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the Ethernet transmit statistics class:

switch-A# scope eth-server

switch-A /eth-server # scope stats-threshold-policy stp10

switch-A /eth-server/stats-threshold-policy # delete class ether-tx-stats

switch-A /eth-server/stats-threshold-policy* # commit-buffer

switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 397
Commands
delete class fan-module-stats

delete class fan-module-stats


To delete a fan module statistics class, use the delete class fan-module-stats command.

delete class fan-module-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete the fan module statistics classes:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # delete class fan-module-stats
server /eth-server/stats-threshold-policy* # commit-buffer
server /eth-server/stats-threshold-policy #

Related Commands Command Description


create class fan-module-stats

enter class fan-module-stats

scope class fan-module-stats

show class fan-module-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


398 OL-25718-02
Commands
delete class fan-stats

delete class fan-stats


To delete the fan statistics class, use the delete class fan-stats command.

delete class fan-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.31. This command was introduced.

Usage Guidelines

Examples This example shows how to delete a fan statistics class:


server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # delete class fan-stats
server /eth-server/stats-threshold-policy* # commit-buffer
server /eth-server/stats-threshold-policy #

Related Commands Command Description


create class fan-stats

enter class fan-stats

scope class fan-stats

show class fan-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 399
Commands
delete class fc-error-stats

delete class fc-error-stats


To delete the Fibre Channel (FC) error statistics class, use the delete class fc-error-stats command.

delete class fc-error-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Fibre channel uplink statistics threshold policy (/fc-uplink/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete the Fibre Channel error statistics classes in the system:
server# scope fc-uplink
server /fc-uplink # scope stats-threshold-policy default
server /fc-uplink/stats-threshold-policy # delete class fc-error-stats
server /fc-uplink/stats-threshold-policy* # commit-buffer
server /fc-uplink/stats-threshold-policy #

Related Commands Command Description


create class fc-error-stats

enter class fc-error-stats

scope class fc-error-stats

show class fc-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


400 OL-25718-02
Commands
delete class fc-port-stats

delete class fc-port-stats


To delete the Fibre Channel (FC) port statistics class, use the delete class fc-port-stats command.

delete class fc-port-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete the Fibre Channel port statistics classes in the system:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # delete class fc-port-stats
server /org/stats-threshold-policy* # commit-buffer
server /org/stats-threshold-policy #

Related Commands Command Description


create class fc-port-stats

enter class fc-port-stats

scope class fc-port-stats

show class fc-port-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 401
Commands
delete class fc-stats

delete class fc-stats


To delete the Fibre Channel (FC) statistics class, use the delete class fc-stats command.

delete class fc-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Fabric Channel statistics threshold policy (/fc-uplink/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a Fibre Channel statistics class:
server# scope fc-uplink
server /fc-uplink # scope stats-threshold-policy default
server /fc-uplink/stats-threshold-policy # delete class fc-stats
server /fc-uplink/stats-threshold-policy* # commit-buffer
server /fc-uplink/stats-threshold-policy #

Related Commands Command Description


create class fc-stats

enter class fc-stats

scope class fc-stats

show class fc-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


402 OL-25718-02
Commands
delete class fex-env-stats

delete class fex-env-stats


To delete an Fex environment statistics class, use the delete class fex-env-stats command.

delete class fex-env-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics Threshold Policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to delete an Fex environment statistics class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # create class fex-env-stats
Switch-A /eth-server/stats-threshold-policy/class* # commit-buffer
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


scope class fex-env-stats
create class fex-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 403
Commands
delete class fex-power-summary

delete class fex-power-summary


To delete an Fex power summary statistics class, use the delete class fex-power-summary command.

delete class fex-power-summary

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to delete an Fex power summary statistics class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # delete class fex-power-summary
Switch-A /eth-server/stats-threshold-policy* # commit-buffer
Switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


scope class fex-power-summary
create class fex-power-summary

Cisco UCS Manager CLI Command Reference, Release 2.0


404 OL-25718-02
Commands
delete class fex-psu-input-stats

delete class fex-psu-input-stats


To delete an Fex power supply input statistics class, use the delete class fex-psu-input-stats command.

delete class fex-psu-input-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics Threshold Policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to delete an Fex power supply input statistics class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # delete class fex-psu-input-stats
Switch-A /eth-server/stats-threshold-policy* # commit-buffer
Switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


scope class fex-psu-input-stats
create class fex-psu-input-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 405
Commands
delete class io-card-stats

delete class io-card-stats


To delete an IO card statistics class, use the delete class io-card-stats command.

delete class io-card-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete an Ethernet IO card statistics class:
server# scope eth-server
server /eth-server # scope stats-threshold-policy
server /eth-server/stats-threshold-policy # delete class io-card-stats
server /eth-server/stats-threshold-policy # commit-buffer
server /eth-server/stats-threshold-policy #

Related Commands Command Description


create class io-card-stats

enter class io-card-stats

scope class io-card-stats

show class io-card-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


406 OL-25718-02
Commands
delete class mb-power-stats

delete class mb-power-stats


To delete a mother board power statistics class, use the delete class mb-power-stats command.

delete class mb-power-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a mother board power statistics class and commit the transaction:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # delete class mb-power-stats
server /org/stats-threshold-policy* # commit-buffer
server /org/stats-threshold-policy #

Related Commands Command Description


create class mb-power-stats

enter class mb-power-stats

scope class mb-power-stats

show class mb-power-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 407
Commands
delete class mb-temp-stats

delete class mb-temp-stats


To delete a temporary mother board statistics class, use the delete class mb-temp-stats command.

delete class mb-temp-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a temporary mother board statistics class and commit the transaction:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # delete class mb-temp-stats
server /org/stats-threshold-policy* # commit-buffer
server /org/stats-threshold-policy #

Related Commands Command Description


create class mb-temp-stats

enter class mb-temp-stats

scope class mb-temp-stats

show class mb-temp-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


408 OL-25718-02
Commands
delete class memory-array-env-stats

delete class memory-array-env-stats


To delete the memory array environment statistics class, use the delete class memory-array-env-stats
command.

delete class memory-array-env-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistcis threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete the memory array environment statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # delete class memory-array-env-stats
server /org/stats-threshold-policy* # commit-buffer
server /org/stats-threshold-policy #

Related Commands Command Description


create class memory-array-env-stats

enter class memory-array-env-stats

scope class memory-array-env-stats

show class memory-array-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 409
Commands
delete class motherboard-temp-stats

delete class motherboard-temp-stats


To delete a motherboard temperature statistics class, use the delete class motherboard-temp-stats command.

delete class motherboard-temp-stats

Command Default None

Command Modes Statistics Threshold Policy (/org/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy and a motherboard temperature statistics class must be created to use this command.

Examples This example shows how to delete a motherboard temperature statistics class.
UCS-A # scope org test
UCS-A /org # scope stats-threshold-policy sample
UCS-A /org/stats-threshold-policy # delete class motherboard-temp-stats
UCS-A /org/stats-threshold-policy* # commit-buffer
UCS-A /org/stats-threshold-policy #

Related Commands Command Description


create class motherboard-temp-stats

enter class motherboard-temp-stats

scope class motherboard-temp-stats

show class motherboard-temp-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


410 OL-25718-02
Commands
delete class pcie-fatal-completion-error-stats

delete class pcie-fatal-completion-error-stats


To delete a Peripheral Component Interconnect (PCI) Express (PCIe) fatal completion error statistics class,
use the delete class pcie-fatal-completion-error-stats command.

delete class pcie-fatal-completion-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete the PCIe fatal completion error statistics class and commit the transaction:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # delete class pcie-fatal-completion-error-stats
server /org/stats-threshold-policy* # commit-buffer
server /org/stats-threshold-policy #

Related Commands Command Description


create class pcie-fatal-completion-error-stats

enter class pcie-fatal-completion-error-stats

scope class pcie-fatal-completion-error-stats

show class pcie-fatal-completion-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 411
Commands
delete class pcie-fatal-error-stats

delete class pcie-fatal-error-stats


To delete the Peripheral Component Interconnect (PCI) Express (PCIe) fatal error statistics class, use the
delete class pcie-fatal-error-stats command.

delete class pcie-fatal-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a PCIe fatal error statistics class and commit the transaction:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # delete class pcie-fatal-error-stats
server /org/stats-threshold-policy* # commit-buffer
server /org/stats-threshold-policy #

Related Commands Command Description


create class pcie-fatal-error-stats

enter class pcie-fatal-error-stats

scope class pcie-fatal-error-stats

show class pcie-fatal-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


412 OL-25718-02
Commands
delete class pcie-fatal-protocol-error-stats

delete class pcie-fatal-protocol-error-stats


To delete the Peripheral Component Interconnect (PCI) Express (PCIe) fatal protocol error statistics class,
use the delete class pcie-fatal-protocol-error-stats command.

delete class pcie-fatal-protocol-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a PCIe fatal protocol error statistics class and commit the transaction:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # delete class pcie-fatal-protocol-error-stats
server /org/stats-threshold-policy* # commit-buffer
server /org/stats-threshold-policy #

Related Commands Command Description


create class pcie-fatal-protocol-error-stats

enter class pcie-fatal-protocol-error-stats

scope class pcie-fatal-protocol-error-stats

show class pcie-fatal-protocol-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 413
Commands
delete class pcie-fatal-receiving-error-stats

delete class pcie-fatal-receiving-error-stats


To delete the Peripheral Component Interconnect (PCI) Express (PCIe) fatal receive error statistics class, use
the delete class pcie-fatal-receiving-error-stats command.

delete class pcie-fatal-receiving-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete the PCIe fatal receive error statistics class and commit the transaction:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # delete class pcie-fatal-receiving-error-stats
server /org/stats-threshold-policy* # commit-buffer
server /org/stats-threshold-policy #

Related Commands Command Description


create class pcie-fatal-receiving-error-stats

enter class pcie-fatal-receiving-error-stats

scope class pcie-fatal-receiving-error-stats

show class pcie-fatal-receiving-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


414 OL-25718-02
Commands
delete class psu-input-stats

delete class psu-input-stats


To delete the power supply input statistics class, use the delete class psu-input-stats command.

delete class psu-input-stats

Command Default None

Command Modes Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.31. This command was introduced.

Usage Guidelines

Examples This example shows how to delete a PSU input statistics class and commit the transaction:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # delete psu-input-stats
server /eth-server/stats-threshold-policy* # commit-buffer
server /eth-server/stats-threshold-policy #

Related Commands Command Description


create class psu-input-stats

enter class psu-input-stats

scope class psu-input-stats

show class psu-input-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 415
Commands
delete class psu-stats

delete class psu-stats


To delete a power supply input statistics class, use the delete class psu-stats command.

delete class psu-stats

Command Default None

Command Modes Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.31. This command was introduced.

Usage Guidelines

Examples This example shows how to delete a power supply input statistics class and commit the transaction:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # delete psu-stats
server /eth-server/stats-threshold-policy* # commit-buffer
server /eth-server/stats-threshold-policy #

Related Commands Command Description


create class psu-stats

enter class psu-stats

scope class psu-stats

show class psu-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


416 OL-25718-02
Commands
delete class rack-unit-fan-stats

delete class rack-unit-fan-stats


To delete a rack unit fan statistics class, use the delete class rack-unit-fan-stats command.

delete class rack-unit-fan-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to delete a rack unit fan statistics class.
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # delete class rack-unit-fan-stats
Switch-A /eth-server/stats-threshold-policy* # commit buffer
Switch-A /eth-server/stats-threshold-policy #

Related Commands Command Description


scope class rack-unit-fan-stats
create class rack-unit-fan-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 417
Commands
delete class rack-unit-psu-stats

delete class rack-unit-psu-stats


To delete a rack unit power supply statistics class, use the delete class rack-unit-psu-stats command.

delete class rack-unit-psu-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to delete a rack unit power supply statistics class.
Switch-A # scope org
Switch-A /org # scope stats-threshold-policy Default
Switch-A /org/stats-threshold-policy # delete class rack-unit-psu-stats
Switch-A /org/stats-threshold-policy* # commit-buffer
Switch-A /org/stats-threshold-policy #

Related Commands Command Description


create class rack-unit-psu-stats
scope class rack-unit-psu-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


418 OL-25718-02
Commands
delete class system-stats

delete class system-stats


To delete a system statistics class, use the delete class system-stats command.

delete class system-stats

Command Default None

Command Modes Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.31. This command was introduced.

Usage Guidelines

Examples This example shows how to delete a system statistics class and commit the transaction:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # delete system-stats
server /eth-server/stats-threshold-policy* # commit-buffer
server /eth-server/stats-threshold-policy #

Related Commands Command Description


create class system-stats

enter class system-stats

scope class system-stats

show class system-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 419
Commands
delete class vnic-stats

delete class vnic-stats


To delete the virtual NIC statistics class, use the delete class vnic-stats command.

delete class vnic-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a virtual NIC statistics class and commit the transaction:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # delete class vnic-stats
server /org/stats-threshold-policy* # commit-buffer
server /org/stats-threshold-policy #

Related Commands Command Description


create class vnic-stats

enter class vnic-stats

scope class vnic-stats

show class vnic-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


420 OL-25718-02
Commands
delete client

delete client
To delete a client, use the delete client command in port-profile mode.

delete client client-name

Syntax Description client-name The name of the client.

Command Default None

Command Modes Profile set (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to delete a client:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope profile-set
switch-A /system/vm-mgmt/vmware/profile-set # scope port-profile pp100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile # delete client c100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile* # commit-buffer
switch-A /system/vm-mgmt/vmware/profile-set/port-profile #

Related Commands Command Description


show client
show port profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 421
Commands
delete cluster

delete cluster
To delete a distributed virtual switch, use the delete cluster command.

delete cluster name

Syntax Description name The name of the distributed virtual switch. It is the name you provided when you
created the switch.

Command Default None

Command Modes Cluster set (/system/vm-mgmt/cluster-set)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines A distributed virtual switch must be created to use this command.

Examples This example shows how to delete a distributed virtual switch.


UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope cluster-set
UCS-A /system/vm-mgmt/cluster-set # delete cluster sample
UCS-A /system/vm-mgmt/cluster-set* # commit-buffer
UCS-A /system/vm-mgmt/cluster-set #

Related Commands Command Description


create cluster

enter cluster

scope cluster

show cluster

Cisco UCS Manager CLI Command Reference, Release 2.0


422 OL-25718-02
Commands
delete cpu

delete cpu
To delete a CPU qualifier for a server pool policy, use the delete cpu command.

delete cpu

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to delete a CPU qualifier for a server pool policy.

Examples This example shows how to delete a CPU qualifier:


switch-A# scope org org3
switch-A /org # scope server-qual squal10
switch-A /org/server-qual # delete cpu
switch-A /org/server-qual* # commit-buffer
switch-A /org/server-qual #

Related Commands Command Description


show cpu

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 423
Commands
delete data-center

delete data-center
To delete a data center, use the delete data-center command in vcenter mode. You can also delete a data
center in folder mode.

delete data-center datacenter-name

Syntax Description datacenter-name The name of the data center.

Command Default None

Command Modes VCenter (/system/vm-mgmt/vmware/vcenter)


Folder (/system/vm-mgmt/vmware/vcenter/folder

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to delete a data center:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt # scope vcenter vc10
switch-A /system/vm-mgmt/vmware # delete data-center DC1
switch-A /system/vm-mgmt/vmware* # commit-buffer
switch-A /system/vm-mgmt/vmware #

Related Commands Command Description


show data-center
show vcenter

Cisco UCS Manager CLI Command Reference, Release 2.0


424 OL-25718-02
Commands
delete default-auth

delete default-auth
To delete a default authentication mechanism, use the delete default-auth command.

delete default-auth

This command has no arguments or keywords.

Command Default None

Command Modes Authentication Domain (/security/auth-domain)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication domain must be created to use this command.

Examples This example shows how to delete a default authentication method for an authentication domain.
Switch-A # scope security
Switch-A /security # scope auth-domain Default
Switch-A /security/auth-domain # delete default-auth
Switch-A /security/auth-domain* # commit-buffer
Switch-A /security/auth-domain #

Related Commands Command Description


create auth-domain
create default-auth
scope default-auth

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 425
Commands
delete default-behavior

delete default-behavior
To delete a default behavior mode, use the delete default-behavior command.

delete default-behavior {vhba | vnic}

Syntax Description vhba Specifies vHBA default behavior mode.

vnic Specifies vNIC default behavior mode.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to delete a vNIC default behavior mode:
switch-A# scope org org100
switch-A /org # scope service-profile sp100
switch-A /org/service-profile # delete default-behavior vnic
switch-A /org/service-profile/* # commit-buffer
switch-A /org/service-profile/ #

Related Commands Command Description


show default-behavior
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


426 OL-25718-02
Commands
delete destination

delete destination
To delete the destination, use the delete destination command.

delete destination email

Syntax Description email Email destination.

Command Default None

Command Modes Profile (/monitoring/callhome/profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the destination:

switch-A# scope monitoring

switch-A /monitoring # scope callhome

switch-A /monitoring/callhome # scope profile pro10

switch-A /monitoring/callhome/profile # delete destination test@csx.com

switch-A /monitoring/callhome/profile* # commit-buffer

switch-A /monitoring/callhome/profile #

Related Commands Command Description


show destination
show profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 427
Commands
delete dest-interface

delete dest-interface
To delete a destination interface for the Fibre Channel traffic monitoring session or the Ethernet traffic
monitoring session, use the delete dest-interface command.

delete dest-interface slotid portid

Syntax Description slotid The slot ID of the destination interface. It must be a value between 1-5.

portid The port ID of the destination interface. It must be a value between 1-40.

Command Default None

Command Modes Fibre Channel monitoring session (/fc-traffic-mon/fabric/fc-mon-session)


Ethernet monitoring session (/eth-traffic-mon/fabric/eth-mon-session)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A Fibre Channel traffic monitoring session or an Ethernet traffic monitoring session must be created prior to
using this command.

Examples This example shows how to delete the destination interface for the Ethernet monitoring session.
To delete the destination interface for the Fibre Channel monitoring session, replace eth-traffic-mon with
fc-traffic-mon , and eth-mon-session with fc-mon-session .
Switch-A # scope eth-traffic-mon
Switch-A /eth-traffic-mon # scope fabric a
Switch-A /eth-traffic-mon/fabric # scope eth-mon-session Default
Switch-A /eth-traffic-mon/fabric/eth-mon-session # delete dest-interface 1 33
Switch-A /eth-traffic-mon/fabric/eth-mon-session/dest-interface* # commit buffer
Switch-A /eth-traffic-mon/fabric/eth-mon-session #

Related Commands Command Description


create dest-interface

Cisco UCS Manager CLI Command Reference, Release 2.0


428 OL-25718-02
Commands
delete dhcp-ip-params

delete dhcp-ip-params
To delete a configured DHCP for initiator IP parameters, use the delete dhcp-ip-params command.

delete dhcp-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface of the iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a DHCP initiator for IP parameters before you use this command.

Examples This example shows how to delete the configured DHCP for initiator IP parameters:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # delete dhcp-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if #

Related Commands Command Description


create dhcp-ip-params

enter dhcp-ip-params

scope dhcp-ip-params

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 429
Commands
delete distributed-virtual-switch

delete distributed-virtual-switch
To delete a distributed virtual switch, use the delete distributed-virtual-switch command in folder mode.

delete distributed-virtual-switch dvs-name

Syntax Description dvs-name The name of the switch.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware/vcenter/data-center/folder)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to delete a distributed virtual switch:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc10
switch-A /system/vm-mgmt/vmware/vcenter # scope data-center dc10
switch-A /system/vm-mgmt/vmware/vcenter/data-center # scope folder f10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder # delete distributed-virtual-switch
dvs10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder* # commit-buffer
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder #

Related Commands Command Description


show distributed-virtual-switch
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


430 OL-25718-02
Commands
delete dns

delete dns
To delete DNS service, use the delete dns command.

delete dns name

Syntax Description name DNS service name.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete DNS service:

switch-A# scope system

switch-A /system # scope services

switch-A /system/services # delete dns dns100

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show dns
show ntp

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 431
Commands
delete download-task

delete download-task
To delete a downloaded firmware image, use the delete download-task command.

delete download-task filename

Syntax Description filename Firmware image filename. The filename can be a maximum of 64 characters.

Command Default None

Command Modes Firmware (/firmware)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a downloaded firmware image and commit the transaction:
server# scope firmware
server /firmware # delete download-task firmware-image.bin
server /firmware* # commit-buffer
server /firmware

Related Commands Command Description


scope download-task

show download-task

Cisco UCS Manager CLI Command Reference, Release 2.0


432 OL-25718-02
Commands
delete dynamic-vnic-conn

delete dynamic-vnic-conn
To delete a dynamic vNIC connection, use the delete dynamic-vnic-conn command.

delete dynamic-vnic-conn

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to create a dynamic vNIC connection:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # delete dynamic-vnic-conn

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show dynamic-vnic-con
show dynamic-vnic-con-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 433
Commands
delete dynamic-vnic-conn-policy

delete dynamic-vnic-conn-policy
To delete a dynamic vNIC connection policy, use the delete dynamic-vnic-conn-policy command.

delete dynamic-vnic-conn-policy policy-name

Syntax Description policy-name The name of the vNIC connection policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a dynamic vNIC connection policy:

switch-A# scope org org10

switch-A /org # delete dynamic-vnic-conn-policy dvcp10

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


show dynamic-vnic-conn-policy
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


434 OL-25718-02
Commands
delete egress-policy

delete egress-policy
To delete an egress policy, use the delete egress-policy command in egress-policy mode.

delete egress-policy policy-name

Syntax Description policy-name The name of the policy.

Command Default None

Command Modes Egress policy (/org/qos-policy/egress-policy)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to delete a data center:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt # scope vcenter vc10
switch-A /system/vm-mgmt/vmware # delete data-center DC1
switch-A /system/vm-mgmt/vmware* # commit-buffer
switch-A /system/vm-mgmt/vmware #

Related Commands Command Description


show data-center
show vcenter

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 435
Commands
delete eth-if

delete eth-if
To delete an Ethernet interface, use the delete eth-if command.

delete eth-if name

Syntax Description name Ethernet interface name.

Command Default None

Command Modes Virtual NIC (/org/service-profile/vnic)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command

Examples This example shows how to delete an Ethernet interface:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # delete eth-if ethIF10

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show service-profile sp10
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


436 OL-25718-02
Commands
delete eth-mon-session

delete eth-mon-session
To delete an Ethernet traffic monitoring session, use the delete eth-mon-session command.

delete eth-mon-session name

Syntax Description name The name of the Ethernet monitoring session.

Command Default None

Command Modes Fabric (/eth-traffic-mon/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to delete an Ethernet traffic monitoring session:
Switch-A # scope eth-traffic-mon
Switch-A # /eth-traffic-mon # scope fabric a
Switch-A # /eth-traffic-mon/fabric # delete eth-mon-session Default
Switch-A # /eth-traffic-mon/fabric* # commit-buffer
Switch-A # /eth-traffic-mon/fabric #

Related Commands Command Description


create eth-mon-session
scope eth-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 437
Commands
delete eth-policy

delete eth-policy
To delete an Ethernet policy, use the delete eth-policy command.

delete eth-policy name

Syntax Description policy-name The name of the Ethernet policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete Ethernet policy ep100 in org100 mode:

switch-A# scope org org100

switch-A /org # delete eth-policy ep100

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


show eth-policy
show trans-queue

Cisco UCS Manager CLI Command Reference, Release 2.0


438 OL-25718-02
Commands
delete eth-target

delete eth-target
To delete an Ethernet target endpoint for a fabric interface, use the delete eth-target command.

delete eth-target name

Syntax Description name The name of the Ethernet target endpoint.

Command Default None

Command Modes Interface (/eth-storage/fabric/interface)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An interface for a fabric and an Ethernet target endpoint for the interface must be created to use this command.

Examples This example shows how to delete an Ethernet target endpoint for a fabric interface.
Switch-A # scope eth-storage
Switch-A /eth-storage # scope fabric a
Switch-A /eth-storage/fabric # scope interface 2 33
Switch-A /eth-storage/fabric/interface # delete eth-target Testing
Switch-A /eth-storage/fabric/interface* # commit-buffer
Switch-A /eth-storage/fabric/interface #

Related Commands Command Description


create eth-target
set macaddress
scope eth-target
enter eth-target
show eth-target

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 439
Commands
delete ext-static-ip

delete ext-static-ip
To delete an external static management IP address for the CIMC or for a service profile, use the delete
ext-static-ip command.

delete ext-static-ip

This command has no arguments or keywords.

Command Default None

Command Modes CIMC (/chassis/server/cimc)


Service profile (org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to delete an external static management IP address for the CIMC.
Switch-A # scope server 1/7
Switch-A /chassis/server # scope cimc
Switch-A /chassis/server/cimc # delete ext-static-ip
Switch-A /chassis/server/cimc* # commit-buffer
Switch-A /chassis/server/cimc #

Related Commands Command Description


create ext-static-ip
scope ext-static-ip
enter ext-static-ip
show ext-static-ip

Cisco UCS Manager CLI Command Reference, Release 2.0


440 OL-25718-02
Commands
delete fc-mon-session

delete fc-mon-session
To delete a Fibre Channel monitoring session, use the delete fc-mon-session command.

delete fc-mon-session Name

Syntax Description Name Name of the monitoring session. This name can include a maximum of 16 characters,
and can be alphanumeric.

Command Default None

Command Modes Fabric (/fc-traffic-mon/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the monitoring session cannot include special characters.
A traffic monitoring session must be created prior to using this command.

Examples This example shows how to delete a Fibre Channel monitoring session:
Switch-A # scope fc-traffic-mon
Switch-A /fc-traffic-mon # scope fabric a
Switch-A /fc-traffic-mon/fabric # delete fc-mon-session default
Switch-A /fc-traffic-mon/fabric* # commit-buffer
Swithc-A /fc-traffic-mon/fabric #

Related Commands Command Description


scope fc-mon-session
create fc-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 441
Commands
delete fc-policy

delete fc-policy
To delete a Fibre Channel policy, use the delete fc-policy command.

delete fc-policy policy-name

Syntax Description policy-name The name of the Fibre Channel policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete Fibre Channel policy fcp10 in org10 mode:

switch-A# scope org org10

switch-A /org # delete fc-policy fcp10

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


show fc-policy
show trans-queue

Cisco UCS Manager CLI Command Reference, Release 2.0


442 OL-25718-02
Commands
delete folder

delete folder
To delete a folder, use the delete folder command in vcenter mode. You can also delete a folder in data-center
mode.

delete folder folder-name

Syntax Description folder-name The name of the container.

Command Default None

Command Modes VCenter (/system/vm-mgmt/vmware/vcenter)


Folder (/system/vm-mgmt/vmware/vcenter/data-center

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to delete a folder:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt # scope vcenter vc10
switch-A /system/vm-mgmt/server # delete folder F10
switch-A /system/vm-mgmt/server* # commit-buffer
switch-A /system/vm-mgmt/server #

Related Commands Command Description


show data-center
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 443
Commands
delete fw-host-pack

delete fw-host-pack
To delete a host firmware package, use the delete fw-host-pack command.

delete fw-host-pack host-pack-name

Syntax Description host-pack-name Name of the server host firmware package image. The name can be a
maximum of 16 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a host firmware package and commit the transaction:
server# scope org
server /org # delete fw-host-pack app1
server /org* # commit-buffer
server /org

Related Commands Command Description


create fw-host-pack

enter fw-host-pack

scope fw-host-pack

show fw-host-pack

Cisco UCS Manager CLI Command Reference, Release 2.0


444 OL-25718-02
Commands
delete fw-mgmt-pack

delete fw-mgmt-pack
To delete a management firmware package, use the delete fw-mgmt-pack command.

delete fw-mgmt-pack mgmt-pack-name

Syntax Description mgmt-pack-name Name of the management firmware package. The name can be a maximum
of 16 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a firmware management package and commit the transaction:
server# scope org
server /org # delete fw-mgmt-pack cimc1
server /org* # commit-buffer
server /org #

Related Commands Command Description


create fw-mgmt-pack

enter fw-mgmt-pack

scope fw-mgmt-pack

show fw-mgmt-pack

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 445
Commands
delete image

delete image
To delete an image, use the delete image command.

delete image {name} | {type {adapter| server-bios| bmc| host-hba| host-hba-combined|


host-hba-optionrom| host-nic| iom| raid-controller| switch-kernel| switch-software| system| unspecified}|
version version}+

Syntax Description name Image name.

type Specifies image type.

adapter Specifies an adapter image.

server-bios Specifies the server BIOS image.

bmc Specifies the BMC image.

host-hba Specifies the host HBA image.

host-hba-combined Specifie the combined host HBA


image.

host-hba-optionrom Specifies the host optional ROM


image.

host-nic Specifies the host NIC image.

iom Specifies the I/O module image.

raid-controller Specifies the RAID controller


image.

switch-kernel Specifies the switch kernel image.

switch-software Specifies the switch software


image.

system Specifies the system image.

unspecified Specifies an unspecified image.

version Specifies the version number.

version Version number.

Command Default None

Cisco UCS Manager CLI Command Reference, Release 2.0


446 OL-25718-02
Commands
delete image

Command Modes Firmware (/firmware)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete an image:

switch-A# scope firmware

switch-A /firmware # delete image serverImage10

switch-A /firmware* # commit-buffer

switch-A /firmware #

Related Commands Command Description


show image
show package

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 447
Commands
delete import-config

delete import-config
To delete an import configuration, use the delete import-config command.

delete import-config name

Syntax Description name Import configuration name.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete an import configuration:

switch-A# scope system

switch-A /system # delete import-config ic10

switch-A /system* # commit-buffer

switch-A /system #

Related Commands Command Description


show import-config
show managed-entity

Cisco UCS Manager CLI Command Reference, Release 2.0


448 OL-25718-02
Commands
delete initiator

delete initiator
To delete an initiator, use the delete initiator command.

delete initiator id

Syntax Description id Initiator identification number.

Command Default None

Command Modes WWN pool (/org/wwn-pool)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete an initiator:

switch-A# scope org org10

switch-A /org # scope wwn-pool wwnp10

switch-A /org/wwn-pool # delete initiator init10

switch-A /org/wwn-pool* # commit-buffer

switch-A /org/wwn-pool #

Related Commands Command Description


show initiator
show wwn-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 449
Commands
delete interface

delete interface
To delete an interface, use the delete interface command.

delete interface slot-id port-id

Syntax Description slot-id Slot identification number.

port-id Port identification number.

Command Default None

Command Modes Fabric interconnect under Ethernet uplink (/eth-uplink/fabric)


Fabric interconnect under Ethernet server (/eth-server/fabric)
Fabric interconnect under Ethernet storage (/eth-storage/fabric)
Fabric interconnect under Fibre Channel uplink (/fc-uplink/fabric)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete an interface:

switch-A#scope eth-uplink

switch-A /eth-uplink # scope fabric b

switch-A /eth-uplink/fabric # delete interface 1 3

switch-A /eth-uplink/fabric* # commit-buffer

switch /eth-uplink/fabric #

Related Commands Command Description


show interface
show vlan

Cisco UCS Manager CLI Command Reference, Release 2.0


450 OL-25718-02
Commands
delete interface fc

delete interface fc
To delete a fibre channel interface for a fabric, use the delete interface fc command.

delete interface fc slot id port id

Syntax Description slot id The port identification number. The range of valid values is between 2 and 5.

port id The port identification number. The range of valid values is between 1 and 40.

Command Default None

Command Modes Fabric (/fc-storage/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A fibre channel interface for a fabric must be created to use this command.

Examples This example shows how to delete a fibre channel interface for a fabric.
Switch-A # scope fc-storage
Switch-A /fc-storage # scope fabric a
Switch-A /fc-storage/fabric # delete interface fc 2 33
Switch-A /fc-storage/fabric* # commit-buffer
Switch-A /fc-storage/fabric #

Related Commands Command Description


create interface fc
scope interface fc
enter interface fc
show interface fc

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 451
Commands
delete interface fcoe

delete interface fcoe


To delete a Fibre Channel over Ethernet interface for a fabric, use the delete interface fcoe command.

delete interface fcoe slot id port id

Syntax Description slot id The slot identification number.

port id The port identification number

Command Default None

Command Modes Fabric (/fc-storage/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A Fibre Channel over Ethernet interface for a fabric must be created to use this command.

Examples This example shows how to delete a Fibre Channel over Ethernet interface for a fabric.
Switch-A # scope fc-storage
Switch-A /fc-storage # scope fabric a
Switch-A /fc-storage/fabric # delete interface fcoe 2 33
Switch-A /fc-storage/fabric* # commit-buffer
Switch-A /fc-storage/fabric #

Related Commands Command Description


create interface fcoe
scope interface fcoe
enter interface fcoe
show interface fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


452 OL-25718-02
Commands
delete ip-if

delete ip-if
To delete an IPv4 interface, use the delete ip-if command.

delete ip-if

This command has no arguments or keywords.

Command Default None

Command Modes Ethernet interface within the iSCSI VNIC mode (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an IPv4 interface before you use this command.

Examples This example shows how to delete an IPv4 interface:


UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi example
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # delete ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if #

Related Commands Command Description


create dhcp-ip-params

create pooled-ip-params

create static-ip-params

create ip-if

enter ip-if

scope ip-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 453
Commands
delete ipmi-access-profile

delete ipmi-access-profile
To delete an IPMI access profile, use the delete ipmi-access-profile command.

delete ipmi-access-profile name

Syntax Description name IPMI access profile name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete an IPMI access profile:

switch-A# scope org org300

switch-A /org # delete ipmi-access-profile ipmiap100

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


show service-profile
show ipmi-access-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


454 OL-25718-02
Commands
delete ipmi-user

delete ipmi-user
To delete an IPMI user, use the delete ipmi-user command.

delete ipmi-user name

Syntax Description name IPMI user name.

Command Default None

Command Modes IPMI access profile (/org/ipmi-access-profile)

Command History Release Modification


1.0(1) This command was introduced as delete epuser.

1.4(1) This command was renamed as delete ipmi-user.

Examples This example shows how to delete an IPMI user:

switch-A# scope org org10

switch-A /org # scope ipmi-access-profile ipmiAP10

switch-A /org/ipmi-access-profile # delete ipmi-user epuser10

switch-A /org/ipmi-access-profile* # commit-buffer

switch-A /org/ipmi-access-profile #

Related Commands Command Description


show ipmi-user
show ipmi-access-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 455
Commands
delete iqn-pool

delete iqn-pool
To delete an IQN pool, use the delete iqn-pool command.

delete iqn-pool name

Syntax Description name Name of the IQN pool.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines An IQN pool must be configured to use this command.

Examples This example shows how to delete an IQN pool.


UCS-A # scope org
UCS-A /org # delete iqn-pool Sample1
UCS-A /org* # commit-buffer
UCS-A /org #

Related Commands Command Description


create iqn-pool

enter iqn-pool

scope iqn-pool

show iqn-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


456 OL-25718-02
Commands
delete iscsi-policy

delete iscsi-policy
To delete an iSCSI adapter policy, use the delete iscsi-policy command.

delete iscsi-policy name

Syntax Description name Name of the iSCSI adapter policy. Enter the name that you provided while creating
the policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You should have created an iSCSI adapter policy to use this command.

Examples This example shows how to delete an iSCSI adapter policy:


UCS-A # scope org test
UCS-A /org # delete iscsi-policy sample
UCS-A /org* # commit-buffer
UCS-A /org #

Related Commands Command Description


create iscsi-policy

scope iscsi-policy

enter iscsi-policy

show iscsi-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 457
Commands
delete iscsi

delete iscsi
To delete iSCSI devices from a boot policy, use the delete iscsi command.

delete iscsi

This command has no arguments or keywords.

Command Default None

Command Modes Boot definition for a service-profile (/org/service-profile/boot-definition)


Boot policy for an organization (/org/boot-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to delete iSCSI devices from a boot policy for a service profile of an organization:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope boot-definition
UCS-A /org/service-profile/boot-definition # delete iscsi
UCS-A /org/service-profile/boot-definition* # commit-buffer
UCS-A /org/service-profile/boot-definition #

Related Commands Command Description


create iscsi

scope iscsi

enter iscsi

show iscsi

Cisco UCS Manager CLI Command Reference, Release 2.0


458 OL-25718-02
Commands
delete keyring

delete keyring
To delete a keyring, use the delete keyring command.

delete keyring name

Syntax Description name Keyring name.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a keyring:

switch-A# scope security

switch-A /security # delete keyring kr10

switch-A /security* # commit-buffer

switch-A /security #

Related Commands Command Description


show keyring
show trustpoint

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 459
Commands
delete lan

delete lan
To delete the LAN, use the delete lan command.

delete lan

Command Default None

Command Modes Boot policy (/org/boot-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the LAN:

switch-A# scope org org10

switch-A /org # scope boot-policy bp10

switch-A /org/boot-policy # delete lan

switch-A /org/boot-policy* # commit-buffer

switch-A /org/boot-policy #

Related Commands Command Description


show boot-policy
show lan

Cisco UCS Manager CLI Command Reference, Release 2.0


460 OL-25718-02
Commands
delete ldap-group

delete ldap-group
To delete an LDAP group, use the delete ldap-group command.

delete ldap-group Group DN

Syntax Description Group DN The LDAP group name.

Command Default None

Command Modes LDAP (/security/ldap)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to delete an LDAP group.


Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # delete ldap-group Sample
Switch-A /security/ldap* # commit-buffer
Switch-A /security/ldap #

Related Commands Command Description


create ldap-group
scope ldap-group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 461
Commands
delete ldap-group-rule

delete ldap-group-rule
To delete an LDAP group rule, use the delete ldap-group-rule command.

delete ldap-group-rule

This command has no arguments or keywords.

Command Default None

Command Modes LDAP (/security/ldap)


Server (/security/ldap/server)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines To use this command in the LDAP server mode, an LDAP server must be created.

Examples This example shows how to delete an LDAP group rule for an LDAP server.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope server Default
Switch-A /security/ldap/server # delete ldap-group-rule
Switch-A /security/ldap/server* # commit-buffer
Switch-A /security/ldap/server #

Related Commands Command Description


create ldap-group-rule
scope ldap-group-rule
enter ldap-group-rule

Cisco UCS Manager CLI Command Reference, Release 2.0


462 OL-25718-02
Commands
delete local

delete local
To delete the local storage, use the delete local command.

delete local

This command has no arguments or keywords.

Command Default None

Command Modes Storage (/org/boot-policy/storage)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the local storage:

switch-A# scope org org10

switch-A /org # scope boot-policy bp10

switch-A /org/boot-policy # scope storage

switch-A /org/boot-policy/storage # delete local

switch-A /org/boot-policy/storage* # commit-buffer

switch-A /org/boot-policy/storage #

Related Commands Command Description


show local
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 463
Commands
delete locale

delete locale
To delete a locale, use the delete locale command.

delete locale name

Syntax Description name Locale name. The range of valid values is 1 to 16.

Command Default None

Command Modes Local user (/security/local-user)


Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a locale:

switch-A# scope security

switch-A /security # delete locale dtoEngineering

switch-A /security* # commit-buffer

switch-A /security #

Related Commands Command Description


show locale
show role

Cisco UCS Manager CLI Command Reference, Release 2.0


464 OL-25718-02
Commands
delete local-disk-config

delete local-disk-config
To delete the local disk configuration, use the delete local-disk-config command.

delete local-disk-config

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the local disk configuration:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # delete local-disk-config

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show local-disk-config
show local-disk-config-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 465
Commands
delete local-disk-config-policy

delete local-disk-config-policy
To delete a configuration policy set in the local disk, use the delete local-disk-config-policy command.

delete local-disk-config-policy policy-name

Syntax Description policy-name Policy name. The name is case sensitivie, and can be a maximum of 16
characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a configuration policy stored in the local disk and commit the transaction:
server# scope org
server /org # delete local-disk-config-policy myPolicy1
server /org* # commit-buffer
server /org

Related Commands Command Description


create local-disk-config-policy

enter local-disk-config-policy

scope local-disk-config-policy

show local-disk-config-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


466 OL-25718-02
Commands
delete local-user

delete local-user
To delete a local user, use the delete local-user command.

delete local-user name

Syntax Description name Local user name.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to delete a user account.

Examples This example shows how to delete a local user:

switch-B# scope security

switch-B /security # delete local-user lu1

switch-B /security* # commit-buffer

switch-B /security #

Related Commands Command Description


show local-user
show remote-user

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 467
Commands
delete lun

delete lun
To delete a target LUN for a static target interface priority of an iSCSI VNIC, use the delete lun command.

delete lun

This command has no arguments or keywords.

Command Default None

Command Modes Static target interface priority (/org/service-profile/vnic-iscsi/eth-if/static-target-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a static target interface priority for an iSCSI VNIC before you use this command.

Examples This example shows how to delete a target LUN for a static target interface priority of an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope static-target-if 1
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if # delete lun
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if #

Related Commands Command Description


create lun

enter lun

scope lun

show lun

Cisco UCS Manager CLI Command Reference, Release 2.0


468 OL-25718-02
Commands
delete mac-pool

delete mac-pool
To delete a MAC pool, use the delete mac-pool command.

delete mac-pool name

Syntax Description name MAC pool name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a MAC pool:

switch-A# scope org org10

switch-A /org # delete mac-pool mp10

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


show mac-pool
show server-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 469
Commands
delete mac-security

delete mac-security
To delete MAC security, use the delete mac-security command.

delete mac-security

This command has no arguments or keywords.

Command Default None

Command Modes Port profile (/eth-uplink/port-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to delete the MAC security policy.

Examples This example shows how to delete MAC security:

switch-A# scope eth-uplink

switch-A /eth-uplink # scope port-profile pp10

switch-A /eth-uplink/port-profile # delete mac-security

switch-A /eth-uplink/port-profile* # commit-buffer

switch-A /eth-uplink/port-profile #

Related Commands Command Description


show mac-security
show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


470 OL-25718-02
Commands
delete maint-policy

delete maint-policy
To delete a maintenance policy, use the delete maint-policy command.

delete maint-policy name

Syntax Description name Name of the maintenance policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to delete a maintenance policy.


Switch-A # scope org
Switch-A /org # delete maint-policy Default
Switch-A /org* # commit-buffer
Switch-A /org #

Related Commands Command Description


create maint-policy
scope maint-policy
enter maint-policy
show maint-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 471
Commands
delete member-port

delete member-port
To delete a member port, use the delete member-port command.

port channel configuration


delete member-port slot-id port-id

vsan configuration
delete member-port {a| b} slot-id port-id

Syntax Description a Specifies switch A.

b Specifies switch B.

slot-id Slot identification number. The range of valid values is 2 to 5.

port-id Port identification number. The range of valid values is 1 to 40.

Command Default None

Command Modes Port channel (/eth-uplink/switch/port-channel)


VSAN (/fc-uplink/switch/vsan)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a member port:

switch-A#scope fc-uplink

switch-A /fc-uplink # scope fabric a

switch-A /fc-uplink/fabric # scope vsan vs1

switch-A /fc-uplink/fabric/vsan # delete member-port a 3 3

switch-A /fc-uplink/fabric/vsan* # commit-buffer

switch-A /fc-uplink/fabric/vsan #

Cisco UCS Manager CLI Command Reference, Release 2.0


472 OL-25718-02
Commands
delete member-port

Related Commands Command Description


show fc-uplink
show port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 473
Commands
delete member-port fc

delete member-port fc
To delete a Fibre Channel member port, use the delete member-port fc command.

delete member-port fc {a| b} slot-id port-id

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number.

port-id Port identification number.

Command Default None

Command Modes VSAN within the Fibre Channel storage mode (/fc-storage/vsan)
VSAN within a Fabric in the Fibre Channel storage mode (/fc-storage/fabric/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create Fibre Channel member ports before you use this command.

Examples This example shows how to delete Fibre channel member ports from the Fibre Channel storage command
mode:
UCS-A # scope fc-storage
UCS-A /fc-storage # scope vsan sample
UCS-A /fc-storage/vsan # delete member-port fc 1 223
UCS-A /fc-storage/vsan* # commit-buffer
UCS-A /fc-storage/vsan #

Related Commands Command Description


create member-port fc

enter member-port fc

scope member-port fc

Cisco UCS Manager CLI Command Reference, Release 2.0


474 OL-25718-02
Commands
delete member-port fc

Command Description
show member-port fc

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 475
Commands
delete member-port fcoe

delete member-port fcoe


To delete Fibre Channel over Ethernet member ports, use the delete member-port fcoe command.

delete member-port fcoe {a| b} slot-id port-id

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number.

port-id Port identification number.

Command Default None

Command Modes VSAN within the Fibre Channel storage command mode (/fc-storage/vsan)
VSAN within a fabric in the Fibre Channel storage command mode (/fc-storage/fabric/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create Fibre Channel over Ethernet member ports before you use this command.

Examples This example shows how to delete Fibre Channel over Ethernet member port from the Fibre Channel storage
command mode:
UCS-A # scope fc-storage
UCS-A /fc-storage # scope vsan sample
UCS-A /fc-storage/vsan # delete member-port fcoe a 1 223
UCS-A /fc-storage/vsan* # commit-buffer
UCS-A /fc-storage/vsan #

Related Commands Command Description


create member-port fcoe

enter member-port fcoe

scope member-port fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


476 OL-25718-02
Commands
delete member-port fcoe

Command Description
show member-port fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 477
Commands
delete member-port-channel

delete member-port-channel
To delete a member port channel, use the delete member-port-channel command.

delete member-port-channel {a| b} port channel id

Syntax Description a Specifies port A.

b Specifies port B.

port channel id Port channel ID.

Command Default None

Command Modes VSAN (/fc-uplink/vsan)


VSAN under fabric (/fc-uplink/fabric/vsan)
VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within a fabric in Ethernet uplink (/eth-uplink/fabric/vlan)
VLAN within Ethernet storage (/eth-storage/vlan)
VLAN within a fabric in the Ethernet storage (/eth-storage/fabric/vlan)

Command History Release Modification


1.4(1) This command was introduced.

2.0(1) This command was introduced in Ethernet uplink mode (/eth-uplink/vlan and
/eth-uplink/fabric/vlan).

Usage Guidelines You must create a VSAN or a VLAN and a member port channel before you use this command.

Examples This example shows how to delete a member port channel for VSAN for a fabric.
UCS-A # scope fc-uplink
UCS-A /fc-uplink # scope fabric a
UCS-A /fc-uplink/fabric # scope vsan default
UCS-A /fc-uplink/fabric/vsan # delete member-port-channel a 22
UCS-A /fc-uplink/fabric/vsan* # commit-buffer
UCS-A /fc-uplink/fabric/vsan #

Cisco UCS Manager CLI Command Reference, Release 2.0


478 OL-25718-02
Commands
delete member-port-channel

Related Commands Command Description


create member-port-channel
scope member-port-channel
enter member-port-channel
show member-port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 479
Commands
delete memory

delete memory
To delete memory, use the delete memory command.

delete memory

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete memory:

switch-A# scope org org99

switch-A /org # scope server-qual sq100

switch-A /org/server-qual # delete memory

switch-A /org/server-qual* # commit-buffer

switch-A /org/server-qual #

Related Commands Command Description


show memory
show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


480 OL-25718-02
Commands
delete mon-src

delete mon-src
To delete a monitoring source, use the delete mon-src command.

delete mon-src session name

Syntax Description session name The name of the monitor source session.

Command Default None

Command Modes External Ethernet Interface (/chassis/server/adapter/ext-eth-if)


Fibre channel interface within Fibre Channel storage (/fc-storage/fabric/fc)
Fibre Channel over Ethernet within Fibre Channel storage (/fc-storage/fabric/fcoe)
Interface within Ethernet Uplink (/eth-uplink/fabric/interface)
Interface within Fibre Channel uplink (/fc-uplink/fabric/interface)
Port channel within ethernet uplink (/eth-uplink/fabric/port-channel)
Port Channel within Fibre Channel uplink (/fc-uplink/fabric/port-channel)
VHBA within Service profile (/org/service-profile/vhba)
VLAN within Ethernet uplink (/eth-uplink/fabric/vlan)
VLAN within Ethernet Uplink (/eth-uplink/vlan)
VSAN within Fibre Channel uplink (/fc-uplink/fabric/vsan)
VSAN within Fibre Channel uplink (/fc-uplink/vsan)
VSAN within Fibre Channel storage (/fc-storage/fabric/vsan)
VSAN within Fibre Channel storage (/fc-storage/vsan)
VNIC within service profile (/org/service-profile/vnic)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A monitoring source session must be created to use this command.

Examples This example shows how to delete a monitoring source session for a VNIC within a service profile.
Switch-A # scope org
Switch-A /org # scope service-profile sample

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 481
Commands
delete mon-src

Switch-A /org/service-profile # scope vnic example


Switch-A /org/service-profile/vnic # delete mon-src trial
Switch-A /org/service-profile/vnic* # commit-buffer
Switch-A /org/service-profile/vnic #

Related Commands Command Description


create mon-src
set direction
enter mon-src
scope mon-src
show mon-src

Cisco UCS Manager CLI Command Reference, Release 2.0


482 OL-25718-02
Commands
delete network

delete network
To delete an Ethernet interface under a virtual machine port profile, use the delete network command.

delete network port-profile-name

Syntax Description port-profile-name Port profile name. The name is case sensitive, and can be a maximum of
32 characters.

Command Default None

Command Modes VM management VMware profile set port profile (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete an Ethernet interface for a virtual machine port profile and commit the
transaction:
server# scope system
server /system # scope vm-mgmt
server /system/vm-mgmt # scope vmware
server /system/vm-mgmt/vmware # scope profile-set
server /system/vm-mgmt/vmware/profile-set # scope port-profile mprofile1
server /system/vm-mgmt/vmware/profile-set/port-profile # delete network
server /system/vm-mgmt/vmware/profile-set/port-profile* # commit-buffer
server /system/vm-mgmt/vmware/profile-set/port-profile

Related Commands Command Description


create network

enter network

scope network

show network

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 483
Commands
delete network (/profile-set/port-profile)

delete network (/profile-set/port-profile)


To delete a network, use the delete network command in port-profile mode.

delete network network-name

Syntax Description network-name The name of the network.

Command Default None

Command Modes Profile set (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to delete a client:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope profile-set
switch-A /system/vm-mgmt/vmware/profile-set # scope port-profile pp100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile # delete network n100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile* # commit-buffer
switch-A /system/vm-mgmt/vmware/profile-set/port-profile #

Related Commands Command Description


show client
show port profile

Cisco UCS Manager CLI Command Reference, Release 2.0


484 OL-25718-02
Commands
delete ntp-server

delete ntp-server
To delete a Network Time Protocol (NTP) server hostname, use the delete ntp-server command.

delete ntp-server host-name

Syntax Description host-name NTP server hostname. The name is case sensitive, and can be a maximum of
512 characters.

Command Default None

Command Modes System services (/system/services)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete an NTP server hostname and commit the transaction:
server# scope system
server /system # scope services
server /system/services # delete ntp-server myNTPserver
server /system/services* # commit-buffer
server /system/services

Related Commands Command Description


create ntp-server

enter ntp-server

scope ntp-server

show ntp-server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 485
Commands
delete nw-ctrl-policy

delete nw-ctrl-policy
To delete a network control policy, use the delete nw-ctrl-policy command.

delete nw-ctrl-policy policy-name

Syntax Description policy-name Policy name.

Command Default None

Command Modes Organization (/org)


Ethernet storage (/eth-storage)

Command History Release Modification


1.0(2) This command was introduced.

1.4(1) This command was introduced in the Ethernet storage command mode.

Examples This example shows how to delete a network control policy:


UCS-A # scope org org10
UCS-A /org # delete nw-ctrl-policy netCtrlP10
UCS-A /org* # commit-buffer
UCS-A /org #

Related Commands Command Description


create nw-ctrl-policy

scope nw-ctrl-policy

enter nw-ctrl-policy

show nw-ctrl-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


486 OL-25718-02
Commands
delete occurrence one-time

delete occurrence one-time


To delete a one-time occurrence instance for a schedule, use the delete occurrence one-time command.

delete occurrence one-time name

Syntax Description name The name of the one-time occurrence instance.

Command Default None

Command Modes Schedule (/system/schedule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A schedule policy must be created to use this command.

Examples This example shows how to delete a one-time occurrence instance for a schedule.
Switch-A # scope system
Switch-A /system # scope schedule Sample
Switch-A /system/schedule # delete occurrence one-time Trial
Switch-A /system/schedule* # commit-buffer
Switch-A /system/schedule #

Related Commands Command Description


create occurrence one-time
scope occurrence one-time
enter occurrence one-time
show occurrence one-time

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 487
Commands
delete occurrence recurring

delete occurrence recurring


To delete a recurring occurrence instance of a schedule, use the delete occurrence recurring command.

delete occurrence recurring name

Syntax Description name The name of the recurring occurrence instance.

Command Default None

Command Modes Schedule (/system/schedule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A schedule and a recurring occurrence instance for the schedule must be created to use this command.

Examples This example shows how to delete a recurring occurrence instance for a schedule.
Switch-A # scope system
Switch-A /system # scope schedule Default
Switch-A /system/schedule # delete occurrence recurring Trial
Switch-A /system/schedule* # commit-buffer
Switch-A /system/schedule #

Related Commands Command Description


create occurrence recurring
scope occurrence recurring
enter occurrence recurring
show occurrence recurring

Cisco UCS Manager CLI Command Reference, Release 2.0


488 OL-25718-02
Commands
delete org

delete org
To delete an organization, use the delete org command.

delete org org-name

Syntax Description org-name Organization name. The name is case sensitive, and can be a maximum of 120
characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete an organization and commit the transaction:
server# scope org
server /org # delete org
server /org* # commit-buffer
server /org

Related Commands Command Description


create org

enter org

scope org

show org

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 489
Commands
delete org-ref

delete org-ref
To delete an organization reference, use the delete org-ref command.

delete org-ref name

Syntax Description name Organization reference name.

Command Default None

Command Modes Locale (/security/locale)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete an organization reference:

switch-A#scope security

switch-A /security # scope locale

switch-A /security/locale # delete org-ref marketing

switch-A /security/locale* # commit-buffer

switch-A /security/locale #

Related Commands Command Description


show locale
show org

Cisco UCS Manager CLI Command Reference, Release 2.0


490 OL-25718-02
Commands
delete pack-image

delete pack-image
To delete a firmware host package image, use the delete pack-image command.

delete pack-image hw-vendor-name hw-model {adapter | board-controller | host-hba | host-hba-optionrom


| host-nic | raid-controller | server-bios} version-num

Syntax Description hw-vendor-name Hardware vendor name. The name is case sensitive, and can be a
maximum of 512 characters.

hw-model Hardware model. The name is case sensitive, and can be a maximum
of 512 characters.

adapter Specifies the adapter firmware package.

board-controller Specifies the mother board controller firmware package.

host-hba Specifies the host HBA.

host-hba-optionrom Specifies the host HBA option ROM package.

host-nic Specifies the host NIC.

raid-controller Specifies the RAID controller firmware package.

server-bios Specifies the server BIOS firmware package.

version-num Version number of the firmware being used for the package image.

Command Default None

Command Modes Host firmware package (/org/fw-host-pack)


Management firmware package (/org/fw-mgmt-pack)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines The hw-vendor-name and hw-model values are labels that help you easily identify the package image. You
can view the hardware vendor and model by using the show image detail command.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 491
Commands
delete pack-image

The firmware version must match the model numbers (PID) on the servers that are associated with this firmware
pack.

Examples This example shows how to delete a RAID controller firmware package and commit the transaction:
server# scope org
server /org # scope fw-host-pack fhp1
server /org/fw-host-pack # delete pack-image Cisco UCS raid-controller 2009.02.09
server /org/fw-host-pack* # commit-buffer
server /org/fw-host-pack

Related Commands Command Description


create pack-image

enter pack-image

scope pack-image

show image detail

show pack-image

Cisco UCS Manager CLI Command Reference, Release 2.0


492 OL-25718-02
Commands
delete path

delete path
To delete the path, use the delete path command.

delete path {primary| secondary}

Syntax Description primary Specifies the primary path.

secondary Specifies the secondary path.

Command Default None

Command Modes SAN image (/org/boot-policy/storage/san-image)


LAN (/org/boot-policy/lan)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the path:

switch-A# scope org org3

switch-A /org # scope boot-policy bp10

switch-A /org/boot-policy/lan # delete path primary

switch-A /org/boot-policy/lan* # commit-buffer

switch-A /org/boot-policy/lan #

Related Commands Command Description


show lan
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 493
Commands
delete path (iscsi)

delete path (iscsi)


To delete an iSCSI image path, use the delete path command.

delete path {primary| secondary}

Syntax Description primary Specifies the primary path of the iSCSI image.

secondary Specifies the secondary path of the iSCSI image.

Command Default None

Command Modes iSCSI policy (/org/boot-policy/iscsi)


iSCSI within a boot definition (/org/service-profile/boot-definition/iscsi)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI image path before you use this command.

Examples This example shows how to delete a secondary path to the iSCSI image:
UCS-A # scope org test
UCS-A /org # scope boot-policy sample
UCS-A /org/boot-policy # scope iscsi
UCS-A /org/boot-policy/iscsi # delete path secondary
UCS-A /org/boot-policy/iscsi* # commit-buffer
UCS-A /org/boot-policy/iscsi #

Related Commands Command Description


create path (iscsi)

enter path (iscsi)

scope path (iscsi)

show path (iscsi)

Cisco UCS Manager CLI Command Reference, Release 2.0


494 OL-25718-02
Commands
delete pending-deletion

delete pending-deletion
To delete a virtual machine task that is pending deletion, use the delete pending-deletion command.

delete pending-deletion {task-ID | none}

Syntax Description task-ID Task ID of the task pending deletion. The range is from 0 to 4294967294.

none Specifies that pending tasks should not be deleted.

Command Default None

Command Modes Virtual machine management (/system/vm-mgmt/vmware)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a pending task and commit the transaction:
server# scope system
server /system # scope vm-mgmt
server /system/vm-mgmt # scope vmware
server /system/vm-mgm/vmware # delete pending-deletion 120
server /system/vm-mgm/vmware* # commit-buffer
server /system/vm-mgm/vmware

Related Commands Command Description


create pending-deletion

enter pending-deletion

scope pending-deletion

show pending-deletion

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 495
Commands
delete physical-qual

delete physical-qual
To delete a physical qualifier for a server pool policy, use the delete physical-qual command.

delete physical-qual

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to delete a physical qualifier for a server pool policy.

Examples This example shows how to delete a physical qualifier:


switch-A# scope org org3
switch-A /org # scope server-qual squal10
switch-A /org/server-qual # delete physical-qual
switch-A /org/server-qual* # commit-buffer
switch-A /org/server-qual #

Related Commands Command Description


show physical-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


496 OL-25718-02
Commands
delete pin-group

delete pin-group
To delete the pin group, use the delete pin-group command.

delete pin-group name

Syntax Description name Pin group name.

Command Default None

Command Modes Fibre Channel uplink (/fc-uplink)


Ethernet uplink (/eth-uplink)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete the pin group:

switch-A# scope eth-uplink

switch-A /eth-uplink # delete pin-group pg10

switch-A /eth-uplink* # commit-buffer

switch-A /eth-uplink #

Related Commands Command Description


show pin-group
show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 497
Commands
delete policy

delete policy
To delete a policy, use the delete policy command.

callhome mode
delete policy {equipment-degraded| equipment-inoperable| fru-problem| identity-unestablishable|
thermal-problem| voltage-problem}

flow control mode


delete policy name

Syntax Description equipment-degraded Specifies an equipment degraded policy.

equipment-inoperable Specifies an equipment inoperable policy.

fru-problem Specifies a field replaceable unit policy.

identity-unestablishable Specifies an identity unestablishable policy.

power-problem Specifies a power problem policy.

thermal-problem Specifies a thermal problem policy.

voltage-problem Specifies a voltage problem policy.

name Policy name.

Command Default None

Command Modes Callhome (/monitoring/callhome)


Flow control (/eth-uplink/flow-control)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a policy:

switch-A# scope eth-uplink

switch-A /eth-uplink # scope flow-control

Cisco UCS Manager CLI Command Reference, Release 2.0


498 OL-25718-02
Commands
delete policy

switch-A /eth-uplink/flow-control # delete policy policy1

switch-A /eth-uplink/flow-control* # commit-buffer

switch-A /eth-uplink/flow-control #

Related Commands Command Description


show policy
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 499
Commands
delete pooled-ip-params

delete pooled-ip-params
To delete a configured pool of initiator IP parameters, use the delete pooled-ip-params command.

delete pooled-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface within the iSCSI VNIC mode (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a pool of initiator IP parameters before you use this command.

Examples This example shows how to delete a pool of initiator IP parameters:


UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # delete pooled-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if #

Related Commands Command Description


create pooled-ip-params

enter pooled-ip-params

scope pooled-ip-params

show pooled-ip-params

Cisco UCS Manager CLI Command Reference, Release 2.0


500 OL-25718-02
Commands
delete pooling-policy

delete pooling-policy
To delete a pooling policy, use the delete pooling-policy command.

delete pooling-policy name

Syntax Description name Pooling policy name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a pooling policy:

switch-A# scope org org3

switch-A /org # delete pooling-policy pp110

switch-A /org/pooling-policy* # commit-buffer

switch-A /org/pooling-policy #

Related Commands Command Description


show mac-pool
show pooling-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 501
Commands
delete port-channel

delete port-channel
To delete a port channel, use the delete port-channel command.

delete port-channel port-channel-id

Syntax Description port-channel-id Port channel identification number. It is the ID specified while creating
the port channel.

Command Default None

Command Modes Fabric within Ethernet uplink mode (/eth-uplink/fabric)


Fabric within Ethernet storage mode (/eth-storage/fabric)
Fabric within Fibre Channel uplink mode (/fc-uplink/fabric)

Command History Release Modification


1.0(1) This command was introduced in the Fabric mode within Ethernet Uplink mode
(/eth-uplink/fabric).

1.4(1) This command was introduced in the Fabric mode within Fibre Channel mode
(/fc-uplink/fabric) and Ethernet storage mode (/eth-storage/fabric).

Examples This example shows how to delete a port channel:


UCS-A # scope eth-uplink
UCS-A /eth-uplink # scope fabric b
UCS-A /eth-uplink/fabric # delete port-channel 10
UCS-A /eth-uplink/fabric* # commit-buffer
UCS-A /eth-uplink/fabric #

Related Commands Command Description


show fabric
show port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


502 OL-25718-02
Commands
delete port-profile (profile-set)

delete port-profile (profile-set)


To delete a port profile, use the delete port-profile command in profile-set mode.

delete port-profile profile-name

Syntax Description profile-name The name of the profile.

Command Default None

Command Modes Profile set (/system/vm-mgmt/vmware/profile-set)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Port profiles

Examples This example shows how to create a port profile:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # delete port-profile pp100
switch-A /system/vm-mgmt/vmware* # commit-buffer
switch-A /system/vm-mgmt/vmware #

Related Commands Command Description


show
show port profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 503
Commands
delete power-control-policy

delete power-control-policy
To delete a power policy, use the delete power-control-policy command.

delete power-control-policy name

Syntax Description name The name of the power policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A power control policy must be created to use this command.

Examples This example shows how to delete a power control policy.


Switch-A # scope org
Switch-A /org # delete power-control-policy Sample
Switch-A /org* # commit-buffer
Switch-A /org #

Related Commands Command Description


create power-control-policy
scope power-control-policy
enter power-control-policy
set power-control-policy
show power-control-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


504 OL-25718-02
Commands
delete power-group

delete power-group
To delete a power group, use the delete power-group command.

delete power-group name

Syntax Description name The name of the power group.

Command Default None

Command Modes Power capacity management (/power-cap-mgmt)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A power group must be created to use this command.

Examples This example shows how to delete a power group.


Switch-A # scope power-cap-mgmt
Switch-A /power-cap-mgmt # delete power-group Testing
Switch-A /power-cap-mgmt* # commit-buffer
Switch-A /power-cap-mgmt #

Related Commands Command Description


create power-group
scope power-group
enter power-group
show power-group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 505
Commands
delete processor

delete processor
To delete a processor qualifier for a server pool policy, use the delete processor command.

delete processor

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

1.3(1) This command was removed.

Usage Guidelines Use this command to delete a processor qualifier for a server pool policy.

Note In later releases, this command is replaced by the delete cpu command.

Examples This example shows how to delete a processor qualifier:


switch-A# scope org org3
switch-A /org # scope server-qual squal10
switch-A /org/server-qual # delete processor
switch-A /org/server-qual* # commit-buffer
switch-A /org/server-qual #

Related Commands Command Description


show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


506 OL-25718-02
Commands
delete profile

delete profile
To delete a Cisco Call Home profile, use the delete profile command.

delete profile profile-name

Syntax Description profile-name Cisco Call Home profile name. The name is case sensitive, and can be a
maximum of 16 characters.

Command Default None

Command Modes Call Home monitoring (/monitoring/callhome)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a Cisco Call Home profile, named myCHprofile, and commit the transaction:
server# scope monitoring
server /monitoring # scope callhome
server /monitoring/callhome # delete profile myCHprofile
server /monitoring/callhome* # commit-buffer
server /monitoring/callhome

Related Commands Command Description


create profile

enter profile

scope profile

show profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 507
Commands
delete qos-policy

delete qos-policy
To delete a QoS policy, use the delete qos-policy command in org mode.

delete qos-policy policy-name

Syntax Description name The name of the QoS policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a QoS policy:

switch-A# scope org org3

switch-A /org # delete qp10

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


show egress-policy
show qos-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


508 OL-25718-02
Commands
delete rack

delete rack
To delete a rack qualifier, use the delete rack command.

deleterackminimum-slot-idmaximum-slot-id

Syntax Description minimum-slot-id The minimum slot ID specified when you created the rack qualifier.

maximum-slot-id The maximum slot ID specified when you created the rack qualifier.

Command Default None

Command Modes Server pool policy qualification (/org/server-qual)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A server pool policy qualification and a rack qualifier within it must be created to use this command.

Examples This example shows how to delete a rack for a server pool policy qualification.
UCS-A # scope org test
UCS-A /org # scope server-qual sample_policy
UCS-A /org/server-qual # delete rack 1 25
UCS-A /org/server-qual* # commit-buffer
UCS-A /org/server-qual #

Related Commands Command Description


create rack

enter rack

scope rack

show rack

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 509
Commands
delete remote-user

delete remote-user
To delete an authentication, authorization, and accounting (AAA) remote user, use the delete remote-user
command.

delete remote-user user-name

Syntax Description user-name Remote user name. The name is case sensitive, and can be a maximum of 16
characters.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete an AAA remote user named RUser1 and commit the transaction:
server# scope security
server /security # delete remote-user RUser1
server /security* # commit-buffer
server /security

Related Commands Command Description


create remote-user

enter remote-user

scope remote-user

show remote-user

Cisco UCS Manager CLI Command Reference, Release 2.0


510 OL-25718-02
Commands
delete role

delete role
To delete a role, use the delete role command.

delete role name

Syntax Description name Role name.

Command Default None

Command Modes Security (/security)


Local user (/security/local-user)
LDAP Group (/security/ldap/ldap-group)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was introduced in the LDAP Group mode


(/security/ldap/ldap-group).

Examples This example shows how to delete a role:

switch-A#scope security

switch-A /security # scope local-user appsUser

switch-A /security/local-user # delete role appsUser

switch-A /security/local-user* # commit-buffer

switch-A /security/local-user #

Related Commands Command Description


show local-user
show role

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 511
Commands
delete san-image

delete san-image
To delete a SAN boot image, use the delete san-image command.

delete san-image {primary | secondary}

Syntax Description primary Specifies the primary SAN boot image.

secondary Specifies the secondary SAN boot image.

Command Default None

Command Modes Storage under boot policy (/org/boot-policy/storage)


Storage under service profile boot definition (/org/service-profile/boot-def/storage)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a secondary SAN boot image from the boot policy storage area, and commit
the transaction:
server# scope org
server /org # scope boot-policy default
server /org/boot-policy # scope storage
server /org/boot-policy/storage # delete san-image secondary
server /org/boot-policy/storage* # commit-buffer
server /org/boot-policy/storage

Related Commands Command Description


create san-image

enter san-image

scope san-image

show san-image

Cisco UCS Manager CLI Command Reference, Release 2.0


512 OL-25718-02
Commands
delete scheduler

delete scheduler
To delete a scheduler, use the delete scheduler command.

delete scheduler name

Syntax Description name The name of the scheduler.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A scheduler must be created to use this command.

Examples This example shows how to delete a scheduler.


Switch-A # scope system
Switch-A /system # delete scheduler Default
Switch-A /system* # commit-buffer
Switch-A /system #

Related Commands Command Description


create scheduler
scope scheduler
enter scheduler
set scheduler
show scheduler

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 513
Commands
delete scrub-policy

delete scrub-policy
To delete a scrub policy, use the delete scrub-policy command.

delete scrub-policy name

Syntax Description name Scrub policy name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a scrub policy:

switch-A# scope org org10

switch-A /org # delete scrub-policy scrub101

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


show qos-policy
show scrub-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


514 OL-25718-02
Commands
delete server

delete server
To delete a server, use the delete server command.

delete server {Rack ID | chassis ID / blade ID}

Syntax Description Rack ID The identification number of the


rack in which the server is present.
The value must be an integer
between 1 and 255.

chassis-id / blade-id The identification numbers of the


chassis and the blade of the server.
The values must be entered in the
n/n format.

Command Default None

Command Modes Server pool (/org/server-pool)


VMware management (/system/vm-mgmt)

Command History Release Modification


1.0(1) This command was introduced in the following modes:
Server pool (/org/server-pool)
RADIUS (/security/radius)
TACACS (/security/tacacs)
LDAP (/security/ldap)
VMware management (/system/vm-mgmt)
The options for this command were only chassis -d and blade-id.

1.4(1) The command options were modified.

Examples This example shows how to delete a server:

switch-A# scope org org10

switch-A /org # scope server-pool spGroup10

switch-A /org/server-pool # delete server 1/1

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 515
Commands
delete server

switch-A /org/server-pool* # commit-buffer

switch-A /org/server-pool #

Related Commands Command Description


delete server (/security)

show server
show server-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


516 OL-25718-02
Commands
delete server (/security)

delete server (/security)


To delete a server for the security mode, use the delete server command.

delete server Host name or IP address

Syntax Description Host name or IP address The name of the server, or the IP address.

Command Default None

Command Modes RADIUS (/security/radius)


TACACS (/security/tacacs)
LDAP (/security/ldap)

Command History Release Modification


1.4(1) The command options were modified.

Usage Guidelines None

Examples This example shows how to delete a server using the server host name:
Switch-A # scope security
Switch-A /security # scope radius
Switch-A /security/radius # delete server Test
Switch-A /security/radius* # commit-buffer
Switch-A /security/radius #

Related Commands Command Description


delete server

show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 517
Commands
delete server-autoconfig-policy

delete server-autoconfig-policy
To delete a server autoconfig policy, use the delete server-autoconfig-policy command.

delete server-autoconfig-policy policy-name

Syntax Description policy-name Policy name. The name is case sensitive, and can be a maximum of 16
characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines The server autoconfig policy applies only to the organization root.

Examples This example shows how to delete a server autoconfig policy and commit the transaction:
server# scope org
server /org # delete server-autoconfig-policy autopolicy1
server /org* # commit-buffer
server /org

Related Commands Command Description


create server-autoconfig-policy

enter server-autoconfig-policy

scope server-autoconfig-policy

show server-autoconfig-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


518 OL-25718-02
Commands
delete server-disc-policy

delete server-disc-policy
To delete a server discovery policy, use the delete server-disc-policy command.

delete server-disc-policy name

Syntax Description name Server discovery policy name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a server discovery policy:

switch-A# scope org org100

switch-A /org # delete server-disc-policy sdp100

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


show chassis-disc-policy
show server-disc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 519
Commands
delete server-inherit-policy

delete server-inherit-policy
To delete a blade server inherit policy, use the delete server-inherit-policy command.

delete server-inherit-policy policy-name

Syntax Description policy-name Name of server inherit policy. The name is case sensitive, and can be a
maximum of 16 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines The blade server inherit policy applies only to the organization root.

Examples This example shows how to delete a server inherit policy named ServPolicy1, and commit the transaction:
server# scope org
server /org # delete server-inherit-policy ServPolicy1
server /org* # commit-buffer
server /org

Related Commands Command Description


create server-inherit-policy

enter server-inherit-policy

scope server-inherit-policy

show server-inherit-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


520 OL-25718-02
Commands
delete server-pool

delete server-pool
To delete a server pool, use the delete server-pool command.

delete server-pool name

Syntax Description name Server pool name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a server pool:

switch-A# scope org org100

switch-A /org # delete server-pool serverpool101

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


show mac-pool
show server-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 521
Commands
delete server-qual

delete server-qual
To delete a server qualifier, use the delete server-qual command.

delete server-qual name

Syntax Description name Server qualifier name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a server qualifier:

switch-A#scope org org3

switch-A /org # delete server-qual sql10

switch-A /org/server-qual* # commit-buffer

switch-A /org/server-qual #

Related Commands Command Description


show server-pool
show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


522 OL-25718-02
Commands
delete server-ref

delete server-ref
To delete a server reference for an authentication server group, use the delete server-ref command.

delete server-ref name

Syntax Description name The name of the server. You can enter either the name or the IP address of the
server.

Command Default None

Command Modes Authentication server group within LDAP (/security/ldap/auth-server-group)


Authentication server group within RADIUS (/security/radius/auth-server-group)
Authentication server group within TACACS (/security/tacacs/auth-server-group)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication server group and a server reference must be configured to use this command.

Examples This example shows how to delete a server reference for an authentication server group within LDAP.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope auth-server-group Sample
Switch-A /security/ldap/auth-server-group # delete server-group Test
Switch-A /security/ldap/auth-server-group* # commit-buffer
Switch-A /security/ldap/auth-server-group #

Related Commands Command Description


create server-ref
enter server-ref
scope server-ref
show server-ref

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 523
Commands
delete service-profile

delete service-profile
To delete a service profile name, use the delete service-profile command.

delete service-profile service-profile-name

Syntax Description service-profile-name Service profile name. The name is case sensitive, and can be a maximum
of 32 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to delete a service profile named ServiceTest, and commit the transaction:
server# scope org
server /org # delete service-profile ServiceTest
server /org* # commit-buffer
server /org

Related Commands Command Description


create service-profile

enter service-profile

scope service-profile

show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


524 OL-25718-02
Commands
delete slot

delete slot
To delete a chassis slot qualification, use the delete slot command.

delete slot min-id max-id

Syntax Description min-id Minimum slot ID. The range is from 1 to 8.

max-id Maximum slot ID. The range is from 1 to 8.

Command Default None

Command Modes Chassis under server qualification (/org/server-qual/chassis)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to delete a chassis slot qualification and commit the transaction:
server# scope org
server /org # scope server-qual all-chassis
server /org/server-qual # scope chassis 1 40
server /org/server-qual/chassis # delete slot 1 4
server /org/server-qual/chassis* # commit-buffer
server /org/server-qual/chassis

Related Commands Command Description


create slot

enter slot

scope slot

show slot

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 525
Commands
delete snmp-trap

delete snmp-trap
To delete a Simple Network Management Protocol (SNMP) trap host, use the delete snmp-trap command.

delete snmp-trap hostname

Syntax Description hostname SNMP trap hostname or IP address. The hostname is case sensitive, and can be
a maximum of 512 characters.

Command Default None

Command Modes SNMP trap host monitoring (/monitoring)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete an SNMP trap host and commit the transaction:
server# scope monitoring
server /monitoring # delete snmp-trap 10.10.10.10
server /monitoring* # commit-buffer
server /monitoring

Related Commands Command Description


create snmp-trap

enter snmp-trap

scope snmp-trap

show snmp-trap

Cisco UCS Manager CLI Command Reference, Release 2.0


526 OL-25718-02
Commands
delete snmp-user

delete snmp-user
To delete a Simple Network Management Protocol (SNMP) user, use the delete snmp-user command.

delete snmp-user name

Syntax Description name Name of SNMPv3 user. The name is case sensitive, and can be a maximum of 512
characters.

Command Default None

Command Modes SNMP monitoring (/monitoring)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete an SNMP user and commit the transaction:
server# scope monitoring
server /monitoring # delete snmp-user snmpuser1
server /monitoring* # commit-buffer
server /monitoring

Related Commands Command Description


create snmp-user

enter snmp-user

scope snmp-user

show snmp-user

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 527
Commands
delete sol-config

delete sol-config
To delete a Serial over LAN (SoL) configuration, use the delete sol-config command.

delete sol-config

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a SoL configuration and commit the transaction:
server# scope org
server /org # scope service-profile CE-B440-M1-SP
server /org/service-profile # delete sol-config
server /org/service-profile* # commit-buffer
server /org/service-profile

Related Commands Command Description


create sol-config

enter sol-config

scope sol-config

show sol-config

Cisco UCS Manager CLI Command Reference, Release 2.0


528 OL-25718-02
Commands
delete sol-policy

delete sol-policy
To delete a Serial over LAN (SoL) policy, use the delete sol-config command.

delete sol-policy policy-name

Syntax Description policy-name SoL policy name. The name is case sensitive, and can be a maximum of 16
characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a SoL policy named Sol9600, and commit the transaction:
server# scope org
server /org # delete sol-policy Sol9600
server /org* # commit-buffer
server /org

Related Commands Command Description


create sol-policy

enter sol-policy

scope sol-policy

show sol-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 529
Commands
delete static-ip-params

delete static-ip-params
To delete configured static initiator IP parameters, use the delete static-ip-params command.

delete static-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface of the iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a static initiator of IP parameters before you use this command.

Examples This example shows how to delete the static initiator of IP parameters:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # delete static-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if #

Related Commands Command Description


create static-ip-params

enter static-ip-params

scope static-ip-params

show static-ip-params

Cisco UCS Manager CLI Command Reference, Release 2.0


530 OL-25718-02
Commands
delete static-target-if

delete static-target-if
To delete a configured static target interface for an iSCSI VNIC, use the delete static-target-if command.

delete static-target-if static target priority

Syntax Description static target priority Static target priority that you had specified when you created the static
target interface.

Command Default None

Command Modes Ethernet interface of an iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a static target interface for an iSCSI VNIC before you use this command.

Examples This example shows how to delete a configured static target interface for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # delete static-target-if 1
UCS-A /org/service-profile/vnic-iscsi/eth-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if #

Related Commands Command Description


create static-target-if

enter static-target-if

scope static-target-if

show static-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 531
Commands
delete stats-threshold-policy

delete stats-threshold-policy
To delete a statistics threshold policy, use the delete stats-threshold-policy command.

delete stats-threshold-policy policy-name

Syntax Description policy-name Statistics threshold policy name. The name can be a maximum of 16
characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines You cannot delete a statistics threshold policy for Ethernet server ports, uplink Ethernet ports, or uplink Fibre
Channel ports. You can only configure the existing default policy.

Examples This example shows how to delete a statistics threshold policy named stp10, and commit the transaction:
server# scope org
server /org # delete stats-threshold-policy stp10
server /org* # commit-buffer
server /org

Related Commands Command Description


create stats-threshold-policy

enter stats-threshold-policy

scope stats-threshold-policy

show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


532 OL-25718-02
Commands
delete storage

delete storage
To delete storage, use the delete storage command.

delete storage

Command Default None

Command Modes Server qualification (/org/server-qual)


Boot policy (/org/boot-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete storage:

switch-A# scope org org200

switch-A /org # scope server-qual sQual220

switch-A /org/server-qual # delete storage

switch-A /org/server-qual* # commit-buffer

switch-A /org/server-qual #

Related Commands Command Description


show memory
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 533
Commands
delete target

delete target
To delete a target, use the delete target command.

delete target {a| b| dual}

Syntax Description a Specifies switch A.

b Specifies switch B.

dual Specifies both switch A and B.

Command Default None

Command Modes Pin group under Fibre Channel uplink (/fc-uplink/pin-group)


Pin group under Ethernet uplink (/eth-uplink/pin-group)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a target:

switch-A# scope fc-uplink

switch-A /fc-uplink # scope pin-group pGroup10

switch-A /fc-uplink/pin-group # delete target a

switch-A /fc-uplink/pin-group* # commit-buffer

switch-A /fc-uplink/pin-group #

Related Commands Command Description


show pin-group
show target

Cisco UCS Manager CLI Command Reference, Release 2.0


534 OL-25718-02
Commands
delete threshold-value

delete threshold-value
To delete a threshold value for a property, use the delete threshold-value command.

delete threshold-value {above-normal | below-normal} {cleared | condition | critical | info | major |


minor | warning}

Syntax Description above-normal Sets the value to above normal.

below-normal Sets the value to below normal.

cleared Sets the threshold value to cleared.

condition Sets the threshold value to condition.

critical Sets the threshold value to critical.

info Sets the threshold value to info.

major Sets the threshold value to major.

minor Sets the threshold value to minor.

warning Sets the threshold value to warning.

Command Default None

Command Modes Ethernet uplink (/eth-uplink/stats-threshold-policy/class/property)


Fibre channel (/fc-uplink/stats-threshold-policy/class/property)
Ethernet server (/eth-server/stats-threshold-policy/class/property)
Organization (/org/stats-threshold-policy/class/property)

Command History Release Modification


1.0.1 This command was introduced.

Examples The following example shows how to delete the threshold value for the bytes-rx-delta property in vnic-stats
class:
switch-A#scope org org100
switch-A /org # scope stats-threshold-policy stp100

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 535
Commands
delete threshold-value

switch-A /org/stats-threshold-policy # scope class vnic-stats


switch-A /org/stats-threshold-policy/class # scope property bytes-rx-delta
switch-A /org/stats-threshold-policy/class/property # delete threshold-value above-normal
critical
switch-A /org/stats-threshold-policy/class/property* # commit-buffer
switch-A /org/stats-threshold-policy/class/property #

Related Commands Command Description


show property
show threshold-value

Cisco UCS Manager CLI Command Reference, Release 2.0


536 OL-25718-02
Commands
delete trustpoint

delete trustpoint
To delete a trustpoint, use the delete trustpoint command.

delete trustpoint name

Syntax Description name Trustpoint name.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a trustpoint:

switch# scope security

switch /security # delete trustpoint tp10

switch /security* # commit-buffer

switch /security #

Related Commands Command Description


show authentication
show trustpoint

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 537
Commands
delete user-sessions

delete user-sessions
To delete a user session, use the delete user-sessions command.

delete user-sessions session-id

Syntax Description session-id User session ID. The ID can be a maximum of 32


alphanumeric characters and cannot includes white
spaces.

Command Default None

Command Modes Security (/security/local-user)


Security (/security/remote-user)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines Use this command to delete both local and remote user sessions.

Examples This example shows how to delete a local user session and commit the transaction:
server# scope security
server /security # scope local-user Escalation
server /security/local-user # delete user-sessions pts_25_1_31264
server /security/local-user* # commit-buffer
server /security/local-user

Related Commands Command Description


create user-sessions

enter user-sessions

scope user-sessions

show user-sessions

show user-sessions

Cisco UCS Manager CLI Command Reference, Release 2.0


538 OL-25718-02
Commands
delete user-sessions local

delete user-sessions local


To delete a local user session, use the delete user-sessions local command.

delete user-sessions local user-name session-id

Syntax Description user-name User name. The name is case sensitive, and can be a
maximum of 512 characters.

session-id User session ID. The ID can be a maximum of 32


alphanumeric characters and cannot includes spaces.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a local user session named pts_25_1_31264 for the user Steve, and commit
the transaction:
server# scope security
server /security # delete user-sessions local steve pts_25_1_31264
server /security* # commit-buffer
server /security

Related Commands Command Description


create user-sessions local

enter user-sessions local

scope user-sessions local

show user-sessions local

show user-sessions

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 539
Commands
delete user-sessions remote

delete user-sessions remote


To delete a local user session, use the delete user-sessions remote command.

delete user-sessions remote user-name session-id

Syntax Description user-name User name. The name is case sensitive, and can be a
maximum of 512 characters.

session-id User session ID. The ID can be a maximum of 32


alphanumeric characters and cannot includes spaces.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a remote user session and commit the transaction:
server# scope security
server /security # delete user-sessions remote admin3 tty_1_28064
server /security* # commit-buffer
server /security

Related Commands Command Description


create user-sessions remote

enter user-sessions remote

scope user-sessions remote

show user-sessions remote

Cisco UCS Manager CLI Command Reference, Release 2.0


540 OL-25718-02
Commands
delete uuid-suffix-pool

delete uuid-suffix-pool
To delete a UUID suffix pool, use the delete uuid-suffix-pool command.

delete uuid-suffix-pool name

Syntax Description name UUID suffix pool name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a UUID suffix pool:

switch-A# scope org org100

switch-A /org # delete uuid-suffix-pool pool101

switch-A /org* # commit-buffer

switch-A /org #

Related Commands Command Description


show mac-pool
show uuid-suffix-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 541
Commands
delete vcenter

delete vcenter
To delete a VCenter, use the delete vcenter command in vmware mode.

delete vcenter vcenter-name

Syntax Description vcenter-name The name of the VCenter.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to delete a VCenter:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system # scope vmware
switch-A /system/vm-mgmt/vmware # delete vcenter VC10
switch-A /system/vm-mgmt/vmware* # commit-buffer
switch-A /system/vm-mgmt/vmware #

Related Commands Command Description


show vcenter
show virtual-machine

Cisco UCS Manager CLI Command Reference, Release 2.0


542 OL-25718-02
Commands
delete vcon

delete vcon
To delete a vCon (virtual network interface connection), use the delete vcon command.

delete vcon {1 | 2}

Syntax Description 1 Specifies virtual network interface connection 1.

2 Specifies virtual network interface connection 2.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to delete a vCon:


switch-A# scope org org100
switch-A /org # scope service-profile sp100
switch-A /org/service-profile # delete vcon vc100
switch-A /org/service-profile* # commit-buffer
switch-A /org/service-profile #

Related Commands Command Description


show service-profile
show vcon

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 543
Commands
delete vcon-policy

delete vcon-policy
To delete a vCon policy (vNIC/vHBA placement profile), use the delete vcon-policy command.

delete vcon-policy policy-name

Syntax Description policy-name The name of the policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to delete a vCon policy:


switch-A# scope org /
switch-A /org # delete vcon-policy vcp100
switch-A /org* # commit-buffer
switch-A /org #

Related Commands Command Description


show vcon
show vcon-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


544 OL-25718-02
Commands
delete vhba

delete vhba
To delete a virtual HBA, use the delete vhba command.

delete vhba name

Syntax Description name Virtual HBA name.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a virtual HBA:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # delete vhba vHBA10

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show vhba
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 545
Commands
delete vhba-templ

delete vhba-templ
To delete a virtualized host bus adapter (vHBA) template, use the delete vhba-templ command.

delete vhba-templ template-name

Syntax Description template-name vHBA template name. The name is case sensitive, and
can be a maximum of 16 alphanumeric characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a vHBA template and commit the transaction:
server# scope org
server /org # delete vhba-templ VhbaTempFoo
server /org* # commit-buffer
server /org

Related Commands Command Description


create vhba-templ

enter vhba-templ

scope vhba-templ

show vhba-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


546 OL-25718-02
Commands
delete virtual-media

delete virtual-media
To delete a virtual media boot for a boot policy or a service profile boot definition, use the delete virtual-media
command.

delete virtual-media {read-only | read-write}

Syntax Description read-only Specifies a physical CD-ROM disk (read-only) virtual


media.

read-write Specifies a floppy disk (read-write) virtual media.

Command Default None

Command Modes Boot policy (/org/boot-policy)


Service profile boot definition (/org/service-profile/boot-def)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a read-only virtual media for the default boot policy, and commit the
transaction:
server# scope org
server /org # scope boot-policy default
server /org/boot-policy # delete virtual-media read-only
server /org/boot-policy* # commit-buffer
server /org/boot-policy

Related Commands Command Description


create virtual-media

enter virtual-media

scope virtual-media

show virtual-media

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 547
Commands
delete vlan

delete vlan
To delete a VLAN, use the delete vlan command.

delete vlan name

Syntax Description name VLAN name.

Command Default None

Command Modes Ethernet uplink (/eth-uplink)


Fabric within Ethernet Uplink (/eth-uplink/fabric)
Fabric within Ethernet Storage (/eth-storage/fabric)
Port profile (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.0(1) This command was introduced.

1.1(1) Added port profile mode.

1.4(1) This command was introduced in the Fabric mode within Ethernet Storage
(/eth-storage/fabric).

Examples This example shows how to delete a VLAN:


switch-A# scope eth-uplink
switch-A /eth-uplink # delete vlan vlan1
switch-A /eth-uplink* # commit-buffer
switch-A /eth-uplink #

Related Commands Command Description


show interface
show vlan

Cisco UCS Manager CLI Command Reference, Release 2.0


548 OL-25718-02
Commands
delete vlan-group-permit

delete vlan-group-permit
To delete a VLAN group permit, use the delete vlan-group-permit command.

delete vlan-group-permit name

Syntax Description name The name of the VLAN group permit.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.1(1) This command was introduced.

Usage Guidelines A VLAN group permit must be created to use this command.

Examples This example shows how to delete a VLAN group permit.


UCS-A # scope org
UCS-A /org # delete vlan-group-permit Sample1
UCS-A /org* # commit-buffer
UCS-A /org #

Related Commands Command Description


create vlan-group-permit

enter vlan-group-permit

show vlan-group-permit

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 549
Commands
delete vlan-permit

delete vlan-permit
To delete a VLAN permit, use the delete vlan-permit command.

delete vlan-permit name

Syntax Description name The name of the VLAN permit.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.1(1) This command was introduced.

Usage Guidelines A VLAN permit must be created to use this command.

Examples This example shows how to delete a VLAN permit.


UCS-A # scope org
UCS-A /org # delete vlan-permit sample1
UCS-A /org* # commit-buffer
UCS-A /org #

Related Commands Command Description


create vlan-permit

enter vlan-permit

show vlan-permit

Cisco UCS Manager CLI Command Reference, Release 2.0


550 OL-25718-02
Commands
delete vnic

delete vnic
To delete a virtual NIC, use the delete vnic command.

delete vnic name

Syntax Description name Virtual NIC name.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a virtual NIC:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # delete vnic vNIC10

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show vhba
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 551
Commands
delete vnic-iscsi

delete vnic-iscsi
To delete an iSCSI VNIC of a service profile, use the delete vnic-iscsi command.

delete vnic-iscsi name

Syntax Description name Name of the iSCSI VNIC.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI VNIC for a service profile before you use this command.

Examples This example shows how to delete an iSCSI VNIC for a service profile:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # delete vnic-iscsi trial
UCS-A /org/service-profile* # commit-buffer
UCS-A /org/service-profile #

Related Commands Command Description


create vnic-iscsi

scope vnic-iscsi

enter vnic-iscsi

show vnic-iscsi

Cisco UCS Manager CLI Command Reference, Release 2.0


552 OL-25718-02
Commands
delete vnic-templ

delete vnic-templ
To delete a virtual NIC template, use the delete vnic-templ command.

delete vnic-templ name

Syntax Description name Virtual NIC template name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a virtual NIC template:

switch-A# scope org org10

switch-A /org # delete vnic-templ vnicT10

switch-A /org* # commit-buffer

switch-A /org/wwn-pool #

Related Commands Command Description


show vhba-templ
show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 553
Commands
delete vsan

delete vsan
To delete a VSAN, use the delete vsan command.

delete vsan name

Syntax Description name VSAN name.

Command Default None

Command Modes Fibre Channel uplink (/fc-uplink)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a VSAN:

switch-A# scope fc-uplink

switch-A /fc-uplink # delete vsan vs110

switch-A /fc-uplink* # commit-buffer

switch-A /fc-uplink #

Related Commands Command Description


show pin-group
show vsan

Cisco UCS Manager CLI Command Reference, Release 2.0


554 OL-25718-02
Commands
delete wwn-pool

delete wwn-pool
To delete a WWN pool, use the delete wwn-pool command.

delete wwn-pool name

Syntax Description name WWN pool name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to delete a WWN pool:

switch-A# scope org org10

switch-A /org # delete wwn-pool wwnP10

switch-A /org* # commit-buffer

switch-A /org/wwn-pool #

Related Commands Command Description


show org
show wwn-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 555
Commands
diagnostic-interrupt

diagnostic-interrupt
To use Non Maskable Interrupt (NMI) to generate a stack trace or a core dump of a system that is unresponsive,
use the diagnostic-interrupt command.

diagnostic-interrupt

This command has no arguments or keywords.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to interrupt the diagnostics running on the server.
UCS-A # scope server 1/7
UCS-A /chassis/server # diagnostic-interrupt
UCS-A /chassis/server* # commit-buffer
UCS-A /chassis/server #

Related Commands Command Description


disable locator-led
enable locator-led

Cisco UCS Manager CLI Command Reference, Release 2.0


556 OL-25718-02
Commands
dir

dir
To list the contents of a directory, use the dir command in local management command mode.

dir [ path ]

Syntax Description path Absolute or relative path of the directory.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to list the contents of a directory in local management command mode. If no path is
specified, the current working directory is listed.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.
This command operates on either the workspace (FLASH) or volatile (RAM) file system. To specify the file
system, include the workspace: or volatile: keyword in the path. If the file system is not specified, the
current working file system is assumed.
You can use the ls command as an alias for this command.

Examples This example shows how to list the contents of a directory named temp in the volatile file system:
switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# dir volatile:/temp


40 Dec 29 15:28:58 2009 src/

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 557
Commands
dir

Usage for volatile://sup-local


0 bytes used
62914560 bytes free
62914560 bytes total

switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


558 OL-25718-02
Commands
disable (distributed-virtual-switch)

disable (distributed-virtual-switch)
To disable the DVS (Distributed Virtual Switch) administrative state, use the disable command, in
distributed-virtual-switch mode.

disable

This command has no arguments or keywords.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware/vcenter/data-center/folder/distributed-virtual-switch)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Distributed Virtual Switch administrative state

Examples This example shows how to disable the DVS administrative state:
switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc10
switch-A /system/vm-mgmt/vmware/vcenter # scope data-center dc10
switch-A /system/vm-mgmt/vmware/vcenter/data-center # scope folder f10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder # scope distributed-virtual-switch
dvs10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder/distributed-virtual-switch #
disable
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder* # commit-buffer
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder #

Related Commands Command Description


show distributed-virtual-switch
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 559
Commands
disable cdp

disable cdp
To disable Cisco Discovery Protocol (CDP), use the disable cdp command.

disable cdp

This command has no arguments or keywords.

Command Default None

Command Modes Network control policy (/org/nw-ctrl-policy)

Command History Release Modification


1.0(2) This command was introduced.

Examples This example shows how to disable CDP:

switch-A# scope org org10

switch-A /org # scope nw-ctrl-policy nCP10

switch-A /org/nw-ctrl-policy # disable cdp

switch-A /org/nw-ctrl-policy* # commit-buffer

switch-A /org/nw-ctrl-policy #

Related Commands Command Description


show nw-ctrl-policy
show org

Cisco UCS Manager CLI Command Reference, Release 2.0


560 OL-25718-02
Commands
disable cimxml

disable cimxml
To disable CIM XML services, use the disable cimxml command.

disable cimxml

This command has no arguments or keywords.

Command Default CIM XML services are enabled.

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to disable CIM XML services:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # disable cimxml

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show cimxml
show dns

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 561
Commands
disable core-export-target

disable core-export-target
To disable a core export target, use the disable core-export-target command.

disable core-export-target

This command has no arguments or keywords.

Command Default None

Command Modes System debug (/monitoring/sysdebug)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to disable a core export target.

Examples This example shows how to disable a core export target:


switch-A /monitoring # scope sysdebug
switch-A /monitoring/sysdebug # disable core-export-target
switch-A /monitoring/sysdebug* # commit-buffer
switch-A /monitoring/sysdebug #

Related Commands Command Description


show core-export-target

Cisco UCS Manager CLI Command Reference, Release 2.0


562 OL-25718-02
Commands
disable http

disable http
To disable HTTP services, use the disable http command.

disable http

This command has no arguments or keywords.

Command Default HTTP services are enabled.

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to disable HTTP services:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # disable http

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show http
show https

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 563
Commands
disable http-redirect

disable http-redirect
To disable directing HTTP connections as HTTPS connections, use the disable http-redirect command.

disable http-redirect

This command has no arguments or keywords.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to disable HTTP connections from being directions as HTTPS connections.
UCS-A # scope system
UCS-A /system # scope services
UCS-A /system/services # disable http-redirect
UCS-A /system/services* # commit-buffer
UCS-A /system/services #

Related Commands Command Description


enable http-redirect

disable cimxml

disable http

disable https

disable telnet-server

disable xmlclconnpolicy

Cisco UCS Manager CLI Command Reference, Release 2.0


564 OL-25718-02
Commands
disable https

disable https
To disable HTTPS services, use the disable https command.

disable https

This command has no arguments or keywords.

Command Default HTTPS services are enabled.

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to disable HTTPS services:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # disable https

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show https
show ntp

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 565
Commands
disable locator-led

disable locator-led
To deactivate a chassis or server locator LED, use the disable locator-led command.

disable locator-led

This command has no arguments or keywords.

Command Default None

Command Modes Chassis (/chassis)


Server (/chassis/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to deactivate a chassis or server locator LED.
To activate a chassis or server locator LED, use the enable locator-led command.

Examples This example shows how to deactivate the locator LED for server 4 in chassis 2:
switch-A# scope server 2/4
switch-A /chassis/server # disable locator-led
switch-A /chassis/server* # commit-buffer
switch-A /chassis/server #

Related Commands Command Description


enable locator-led

Cisco UCS Manager CLI Command Reference, Release 2.0


566 OL-25718-02
Commands
disable (port-channel)

disable (port-channel)
To disable a port channel, use the disable command.

disable

This command has no arguments or keywords.

Command Default None

Command Modes Port channel within a fabric in the Ethernet storage mode (/eth-storage/fabric/port-channel)
Member port within a fabric in the Ethernet storage mode (/eth-storage/fabric/port-channel/member-port)
Member port within a port channel in the Ethernet uplink mode (/eth-uplink/fabric/port-channel/member-port)
Member port within a port channel in the Fibre Channel uplink mode
(/fc-uplink/fabric/port-channel/member-port)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines Port channels must be available in the fabric to use this command.

Examples This example shows how to disable a port channel within fabric A within the Ethernet storage mode:
UCS-A # scope eth-storage
UCS-A /eth-storage # scope fabric a
UCS-A /eth-storage/fabric # scope port-channel 223
UCS-A /eth-storage/fabric/port-channel # disable
UCS-A /eth-storage/fabric/port-channel* # commit-buffer
UCS-A /eth-storage/fabric/port-channel #

Related Commands Command Description


enable (port-channel)

show port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 567
Commands
disable snmp

disable snmp
To disable SNMP services, use the disable snmp command.

disable snmp

This command has no arguments or keywords.

Command Default SNMP services are enabled.

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to disable SNMP services:

switch-A#scope monitoring

switch-A /monitoring # disable snmp

switch-A /monitoring* # commit-buffer

switch-A /monitoring #

Related Commands Command Description


show snmp-trap
show stats-collection-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


568 OL-25718-02
Commands
disable syslog

disable syslog
To disable syslog services, use the disable syslog command.

disable syslog {console| file| monitor| remote-destination {server-1| server-2| server-3}}

Syntax Description console Disables the sending of syslog messages to the console.

file Disables the writing of syslog messages to a file.

monitor Disables the monitoring of syslog messages by the operating system.

remote-destination Disables the sending of syslog messages to a remote server.

server- n Specifies one of three remote servers.

Command Default Syslog services are disabled.

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to disable monitoring of system log (syslog) messages by the operating system, or to disable
the sending of syslog messages to the console, to a file, or to a remote syslog server.

Examples This example shows how to disable the sending of syslog messages to a syslog remote destination:
switch-A# scope monitoring
switch-A /monitoring # disable syslog remote-destination server-1
switch-A /monitoring* # commit-buffer

switch-A /monitoring #

Related Commands Command Description


enable syslog
show syslog

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 569
Commands
disable telnet-server

disable telnet-server
To disable TELNET server services, use the disable telnet-server command.

disable telnet-server

This command has no arguments or keywords.

Command Default TELNET server services are enabled.

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to disable TELNET server services:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # disable telnet-server

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show ssh-server
show telnet-server

Cisco UCS Manager CLI Command Reference, Release 2.0


570 OL-25718-02
Commands
disassociate

disassociate
To disassociate servers, use the disassociate command.

disassociate

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to disassociate servers:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # disassociate

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show server
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 571
Commands
discard-buffer

discard-buffer
To cancel pending configuration changes, use the discard-buffer command.

discard-buffer

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to cancel and discard all uncommitted configuration changes. While any configuration
commands are pending, an asterisk (*) appears before the command prompt. When you enter the discard-buffer
command, the commands are discarded and the asterisk disappears.

Examples This example shows how to discard pending configuration changes:


switch-1# scope chassis 1
switch-1 /chassis # enable locator-led
switch-1 /chassis* # show configuration pending
scope chassis 1
+ enable locator-led
exit
switch-1 /chassis* # discard-buffer
switch-1 /chassis #

Related Commands Command Description


commit-buffer
show configuration pending

Cisco UCS Manager CLI Command Reference, Release 2.0


572 OL-25718-02
Commands
download image

download image
To download an image, use the download image command.

download image {ftp:| scp:| sftp:| tftp:}

Syntax Description ftp: Specifies FTP.

scp: Specifies SCP.

sftp: Specifies SFTP.

tftp: Specifies TFTP.

Command Default None

Command Modes Firmware (/firmware)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to download an image:

switch-A# scope firmware

switch-A /firmware # download image

scp://user1@192.168.10.10/images/ucs-k9-bundle.1.0.0.988.gbin

switch-A /firmware* # commit-buffer

switch-A /firmware #

Related Commands Command Description


show image
show package

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 573
Commands
download license

download license
To download a license, use the download license command.

download license licfileuri

Syntax Description licfileuri The location of the license file. You can use either ftp, scp, sftp or tftp to download
the license file.

Command Default None

Command Modes License (/license)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must determine the location of the license file to use this command.

Examples This example shows how to download a license file using FTP.
Switch-A # scope license
Switch-A /license # download license ftp://www.sampleurl.com
password: *********
Switch-A /license #

Related Commands Command Description


install file
clear file

Cisco UCS Manager CLI Command Reference, Release 2.0


574 OL-25718-02
Commands
enable (distributed-virtual-switch)

enable (distributed-virtual-switch)
To enable the DVS (Distributed Virtual Switch) administrative state, use the enable command, in
distributed-virtual-switch mode.

enable

This command has no arguments or keywords.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware/vcenter/data-center/folder/distributed-virtual-switch)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Distributed Virtual Switch administrative state

Examples This example shows how to enable the DVS administrative state:
switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc10
switch-A /system/vm-mgmt/vmware/vcenter # scope data-center dc10
switch-A /system/vm-mgmt/vmware/vcenter/data-center # scope folder f10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder # scope distributed-virtual-switch
dvs10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder/distributed-virtual-switch #
enable
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder* # commit-buffer
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder #

Related Commands Command Description


show distributed-virtual-switch
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 575
Commands
enable cdp

enable cdp
To enable Cisco Discovery Protocol (CDP) for a network control policy, use the enable cdp command.

enable cdp

This command has no arguments or keywords.

Command Default None

Command Modes Network control policy (/org/nw-ctrl-policy)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines When you enable CDP, you can use it to obtain addresses of other devices in your network. You can also use
it to discover the platforms of those devices.

Examples This example shows how to enable CDP:

switch-A# scope org org10

switch-A /org # scope nw-ctrl-policy nCP10

switch-A /org/nw-ctrl-policy # enable cdp

switch-A /org/nw-ctrl-policy* # commit-buffer

switch-A /org/nw-ctrl-policy #

Related Commands Command Description


show nw-ctrl-policy
show snmp

Cisco UCS Manager CLI Command Reference, Release 2.0


576 OL-25718-02
Commands
enable cimxml

enable cimxml
To CIM (Common Information Model) XML services, use the enable cimxml command.

enable cimxml

This command has no arguments or keywords.

Command Default CIM XML services are disabled.

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Cisco recommends that you enable only the communication services that are required to interface with other
network applications.

Examples This example shows how to enable CIM XML services:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # enable cimxml

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show cimxml
show dns

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 577
Commands
enable cluster

enable cluster
To enable a standalone fabric interconnect for cluster operation, use the enable cluster command.

enable cluster clusterip

Syntax Description clusterip Specifies the IP address of the standalone fabric interconnect.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enable a standalone fabric interconnect for cluster operation. After enabling cluster
operation, you can add a second fabric interconnect to the cluster.

Examples This example enables a standalone fabric interconnect for cluster operation:
switch-A# connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html
switch-A(local-mgmt)# enable cluster 192.168.1.101
This command will enable cluster mode on this setup. You cannot change it
back to stand-alone. Are you sure you want to continue? (yes/no): yes
switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


578 OL-25718-02
Commands
enable core-export-target

enable core-export-target
To enable a core export target, use the enable core-export-target command.

enable core-export-target

This command has no arguments or keywords.

Command Default Core export target services are disabled.

Command Modes System debug (/monitoring/sysdebug)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enable a core export target:

switch-A# scope monitoring

switch-A /monitoring # scope sysdebug

switch-A /monitoring/sysdebug # enable core-export-target

switch-A /monitoring/sysdebug* # commit-buffer

switch-A /monitoring/sysdebug #

Related Commands Command Description


show cores
show core-export-target

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 579
Commands
enable http

enable http
To enable HTTP services, use the enable http command.

enable http

This command has no arguments or keywords.

Command Default HTTP services are disabled.

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Cisco recommends that you enable only the communication services that are required to interface with other
network applications.

Examples This example shows how to enable HTTP services:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # enable http

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show cimxml
show http

Cisco UCS Manager CLI Command Reference, Release 2.0


580 OL-25718-02
Commands
enable http-redirect

enable http-redirect
To redirect HTTP connections as HTTPS connections, use the enable http-redirect command.

enable http-redirect

This command has no arguments or keywords.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to redirect HTTP connections as HTTPS connections.
UCS-A # scope system
UCS-A /system # scope services
UCS-A /system/services # enable http-redirect
UCS-A /system/services* # commit-buffer
UCS-A /system/services #

Related Commands Command Description


enable cimxml

enable http

enable https

enable telnet-server

enable xmlclconnpolicy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 581
Commands
enable https

enable https
To enable HTTPS services, use the enable https command.

enable https

This command has no arguments or keywords.

Command Default HTTPS services are disabled.

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Cisco recommends that you enable only the communication services that are required to interface with other
network applications.

Examples This example shows how to enable HTTPS services:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # enable https

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show cimxml
show https

Cisco UCS Manager CLI Command Reference, Release 2.0


582 OL-25718-02
Commands
enable locator-led

enable locator-led
To activate a chassis or server locator LED, use the enable locator-led command.

enable locator-led

This command has no arguments or keywords.

Command Default None

Command Modes Chassis (/chassis)


Server (/chassis/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to activate a chassis or server locator LED.
To deactivate a chassis or server locator LED, use the disable locator-led command.

Examples This example shows how to activate the locator LED for server 4 in chassis 2:
switch-A# scope server 2/4
switch-A /chassis/server # enable locator-led
switch-A /chassis/server* # commit-buffer
switch-A /chassis/server #

Related Commands Command Description


disable locator-led

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 583
Commands
enable (port-channel)

enable (port-channel)
To enable a port channel, use the enable command.

enable

This command has no arguments or keywords.

Command Default None

Command Modes Port channel within a fabric in the Ethernet storage mode (/eth-storage/fabric/port-channel)
Member port within a fabric in the Ethernet storage mode (/eth-storage/fabric/port-channel/member-port)
Member port within a port channel in the Ethernet uplink mode (/eth-uplink/fabric/port-channel/member-port)
Member port within a port channel in the Fibre Channel uplink mode
(/fc-uplink/fabric/port-channel/member-port)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines Port channels must be available in the fabric to use this command.

Examples This example shows how to enable the port channel available for fabric A within the Ethernet storage mode:
UCS-A # scope eth-storage
UCS-A /eth-storage # scope fabric a
UCS-A /eth-storage/fabric # scope port-channel 223
UCS-A /eth-storage/fabric/port-channel # enable
UCS-A /eth-storage/fabric/port-channel* # commit-buffer
UCS-A /eth-storage/fabric/port-channel #

Related Commands Command Description


disable (port-channel)

show port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


584 OL-25718-02
Commands
enable snmp

enable snmp
To enable SNMP services, use the enable snmp command.

enable snmp

This command has no arguments or keywords.

Command Default SNMP services are disabled.

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Cisco recommends that you enable only the communication services that are required to interface with other
network applications.

Examples This example shows how to enable SNMP services:

switch-A#scope monitoring

switch-A /monitoring # enable snmp

switch-A /monitoring* # commit-buffer

switch-A /monitoring #

Related Commands Command Description


show cimxml
show snmp-trap

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 585
Commands
enable syslog

enable syslog
To enable syslog services, use the enable syslog command.

enable syslog {console| file| monitor| remote-destination {server-1| server-2| server-3}}

Syntax Description console Enables the sending of syslog messages to the console.

file Enables the writing of syslog messages to a file.

monitor Enables the monitoring of syslog messages by the operating system.

remote-destination Enables the sending of syslog messages to a remote server.

server- n Specifies one of three remote syslog servers.

Command Default Syslog services are disabled.

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to enable monitoring of system log (syslog) messages by the operating system, or to enable
the sending of syslog messages to the console, to a file, or to a remote syslog server.
To send syslog messages to a file or a remote syslog server, you must configure additional parameters using
the set syslog file or the set syslog remote-destination command.

Examples This example shows how to enable and configure a syslog remote destination:
switch-A# scope monitoring
switch-A /monitoring # enable syslog remote-destination server-1
switch-A /monitoring* # set syslog remote-destination server-1 hostname ITEast1 level alerts
switch-A /monitoring* # commit-buffer

switch-A /monitoring #

Related Commands Command Description


disable syslog

Cisco UCS Manager CLI Command Reference, Release 2.0


586 OL-25718-02
Commands
enable syslog

Command Description
set syslog file
set syslog remote-destination
show syslog

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 587
Commands
enable telnet-server

enable telnet-server
To enable TELNET server services, use the enable telnet-server command.

enable telnet-server

This command has no arguments or keywords.

Command Default TELNET server services are disabled.

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Cisco recommends that you enable only the communication services that are required to interface with other
network applications.

Examples This example shows how to enable TELNET server services:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # enable telnet-server

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show ssh-server
show telnet-server

Cisco UCS Manager CLI Command Reference, Release 2.0


588 OL-25718-02
Commands
end

end
To return to the highest-level mode of the CLI, use the end command.

end

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode.

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to return to the highest-level mode of the CLI from the service-profile mode.
Switch-A # scope org Test
Switch-A /org # scope service-profile Sample
Switch-A /org/service-profile # end
Switch-A #

Related Commands Command Description

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 589
Commands
enter adapter

enter adapter
To enter the adapter, use the enter adapter command.

enter adapter

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter adapter capacity qualification. In this qualification, you can create and delete
capacity qualifications. Use the exit command to exit adapter.
If you are entering an adapter for the first time, once you have entered you will need to execute the
commit-buffer command.

Examples This example shows how to enter the adapter:

switch-A# scope org org10

switch-A /org # scope server-qual sq10

switch-A /org/server-qual # enter adapter

switch-A /org/server-qual/adapter* # commit-buffer

switch-A /org/server-qual/adapter #

Related Commands Command Description


show adapter
show cap-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


590 OL-25718-02
Commands
enter auth-domain

enter auth-domain
To create, if necessary, or to enter the authentication domain mode, use the enter auth-domain command.

enter auth-domain name

Syntax Description name The name of the authentication domain.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.4(1) This command is introduced.

Usage Guidelines An authentication domain must be created to use this command.

Examples This example shows how to enter the authentication domain mode.
Switch-A # scope security
Switch-A /security # enter auth-domain Testing
Switch-A /security/auth-domain #

Related Commands Command Description


create auth-domain
scope auth-domain
create default-auth
show auth-domain
delete auth-domain

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 591
Commands
enter auth-profile

enter auth-profile
To enter the iSCSI authorization profile mode, use the enter auth-profile command.

enter auth-profile iscsi-auth-profile-name

Syntax Description iscsi-auth-profile-name The name of the iSCSI authorization profile.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines An iSCSI authorization profile must be created to use this command. The profile name can include a maximum
of 16 characters.

Examples This example shows how to enter the iSCSI authorization profile mode in the organization command mode.
UCS-A # scope org test
UCS-A /org # enter auth-profile sample
UCS-A /org/auth-profile #

Related Commands Command Description


create auth-profile

delete auth-profile

scope auth-profile

show auth-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


592 OL-25718-02
Commands
enter auth-server-group

enter auth-server-group
To create, if necessary, and to enter the authentication server group, use the enter auth-server-group command.

enter auth-server-group authentication server group

Syntax Description authentication server group The name of the authentication server group.

Command Default None

Command Modes LDAP (/security/ldap)


RADIUS (/security/radius)
TACACS (/security/tacacs)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the authentication server group for LDAP:
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # enter auth-server-group Default
Switch-A /security/ldap/auth-server-group #

Related Commands Command Description


scope auth-server-group
create auth-server-group
delete auth-server-group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 593
Commands
enter auto-target-if

enter auto-target-if
To enter the configured automatic target interface for an iSCSI VNIC, use the enter auto-target-if command.

enter auto-target-if

This command has no arguments or keywords.

Command Default None

Command Modes Ethernet interface within the iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI VNIC, an Ethernet interface for the iSCSI VNIC, and an automatic target interface
before you use this command.

Examples This example shows how to enter the configured automatic target interface of the iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # enter auto-target-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/auto-target-if #

Related Commands Command Description


set dhcp-vendor-id
create auto-target-if
scope auto-target-if

delete auto-target-if

show auto-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


594 OL-25718-02
Commands
enter backup

enter backup
To enter the management plane backup operation, use the enter backup command.

enter backup URL {all-configuration | full-state | logical-configuration | system-configuration} {disabled


| enabled}

Syntax Description URL Specify the URL for the backup file using one of the
following syntax:
• ftp:// hostname / path
• scp:// username @ hostname hostname / path
• sftp:// username @ hostname / path
• tftp:// hostname : port-num / path

all-configuration Specifies all backups of the server, fabric, and system


related configuration.

full-state Specifies a backup of the full state for disaster recovery.

logical-configuration Specifies a backup of the fabric and service profile


related configuration.

system-configuration Specifies a backup of the system related configuration.

disabled Specifies that the backup operation will not run until it
is enabled.

enabled Specifies that the backup operation automatically runs


as soon as you enter the commit-buffer command.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.3.1 This command was introduced.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 595
Commands
enter backup

Usage Guidelines

Examples This example shows how to enter the backup operation:


server# scope system
server /system # enter backup scp://user@host35/backups/all-config9.bak all-configuration
disabled
server /system/backup #

Related Commands Command Description


create backup

delete backup

scope backup

show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


596 OL-25718-02
Commands
enter bladeserver-disc-policy

enter bladeserver-disc-policy
To create, if necessary, and to enter the blade server discovery policy mode, use the enter
bladeserver-disc-policy command.

enter bladeserver-disc-policy name

Syntax Description name The name of the compute blade server discovery policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A compute blade server discovery policy must be created to use this policy.

Examples This example shows how to enter the blade server discovery policy.
Switch-A # scope org
Switch-A /org # enter bladeserver-disc-policy Default
Switch-A /org/bladeserver-disc-policy #

Related Commands Command Description


create bladeserver-disc-policy
scope bladeserver-disc-policy
show bladeserver-disc-policy
delete bladeserver-disc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 597
Commands
enter block

enter block
To enter an UUID address block, a WWN initiator block, or a MAC address block, use the enter block
command.

enter block from to

Syntax Description from From address, identifier, or world-wide name. Specify


a MAC address in the format NN:NN:NN:NN:NN:NN.
Specify a UUID in the format
NNNN-NNNNNNNNNNNN. Specify a WWN in the
format HH:HH:HH:HH:HH:HH:HH:HH. Specify an IP
address in the format A.B.C.D.

to To address, identifier, or world-wide name. Specify a


MAC address in the format NN:NN:NN:NN:NN:NN.
Specify a UUID in the format
NNNN-NNNNNNNNNNNN. Specify a WWN in the
format HH:HH:HH:HH:HH:HH:HH:HH. Specify an IP
address in the format A.B.C.D.

Command Default None

Command Modes UUID suffix pool (/org/uuid-suffix-pool)


WWW pool (/org/wwn-pool)
MAC pool (/org/mac-pool)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter an UUID address block:


server# scope org
server /org # scope uuid-suffix-pool default
server /org/uuid-suffix-pool # enter block 8133-1A84A44B11DE 8133-1A84A44B1241
server /org/uuid-suffix-pool/block #

Examples This example shows how to enter the MAC pool block:
server# scope org
server /org # scope mac-pool mp1

Cisco UCS Manager CLI Command Reference, Release 2.0


598 OL-25718-02
Commands
enter block

server /org/mac-pool # enter block 1a:2b:3c:4d:21:31 1b:2a:3c:4d:21:34


server /org/mac-pool/block #

Examples This example shows how to enter a WWN pool block:


server# scope org
server /org # scope wwn-pool default
server /org/wwn-pool # enter block 20:00:00:25:B5:00:00:00 20:00:00:25:B5:00:00:631
server /org/wwn-pool/block #

Related Commands Command Description


create block

delete block

scope block

show block

show mac-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 599
Commands
enter boot-definition

enter boot-definition
To enter a boot definition for the service profile, use the enter boot-definition command.

enter boot-definition

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a boot definition for a service profile named CE-B440-M1-SP:
server# scope org
server /org # scope service-profile CE-B440-M1-SP
server /org/service-profile # enter boot-definition
server /org/service-profile/boot-definition #

Related Commands Command Description


create boot-definition

delete boot-definition

scope boot-definition

show boot-definition

Cisco UCS Manager CLI Command Reference, Release 2.0


600 OL-25718-02
Commands
enter boot-policy

enter boot-policy
To enter a boot policy, use the enter boot-policy command.

enter boot-policy name [purpose {operational | utility}*]

Syntax Description name Policy name. The name can be a maximum of 16


alphanumeric characters.

purpose (Optional) Specifies the purpose of the policy.

operational Specifies an operational policy.

utility Specifies a utility policy.

Command Default None

Command Modes Boot policy (/org/boot-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a boot policy called utility:
server# scope org
server /org/ # enter boot-policy utility
server /org/boot-policy #

Related Commands Command Description


create boot-policy

delete boot-policy

scope boot-policy

show boot-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 601
Commands
enter boot-target

enter boot-target
To enter the boot target, use the enter boot-target command.

enter boot-target {primary| secondary}

Syntax Description primary Specifies the primary boot target.

secondary Specifies the secondary boot target.

Command Default None

Command Modes WWN initiator (/org/wwn-pool/initiator)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines Use this command to enter the boot target. You can assign the logical unit number (LUN) and world wide
name (WWN) to the primary or secondary boot target. Use the exit command to exit boot-target.

Examples The following example shows how to enter the secondary boot target:
server# scope org
server /org # scope wwn-pool default
server /org/wwn-pool # scope initiator 20:00:00:25:B5:00:00:00
server /org/wwn-pool/initiator # enter boot-target secondary
server /org/wwn-pool/initiator/boot-target #

Related Commands Command Description


set lun
set wwn
show boot-target

Cisco UCS Manager CLI Command Reference, Release 2.0


602 OL-25718-02
Commands
enter cap-qual

enter cap-qual
To enter a capacity qualification for a specified adapter type, use the enter cap-qual command.

enter cap-qual {fcoe | non-virtualized-eth-if | non-virtualized-fc-if | path-encap-consolidated |


path-encap-virtual | protected-eth-if | protected-fc-if | protected-fcoe| virtualized-eth-if | virtualized-fc-if
| virtualized-scsi-if}

Syntax Description fcoe Specifies Fibre Channel over Ethernet.

non-virtualized-eth-if Specifies non-virtualized Ethernet interface.

non-virtualized-fc-if Specifies non-virtualized Fibre Channel interface.

path-encap-consolidated Specifies path encapsulation consolidated.

path-encap-virtual Specifies path encapsulation virtual.

protected-eth-if Specifies protected Ethernet interface.

protected-fc-if Specifies protected Fibre Channel interface.

protected-fcoe Specifies protected Fibre Channel over Ethernet.

virtualized-eth-if Specifies virtualized Ethernet interface.

virtualized-fc-if Specifies virtualized Fibre Channel interface.

virtualized-scsi-if Specifies virtualized SCSI interface.

Command Default None

Command Modes Adapter (/org/server-qual/adapter)

Command History Release Modification


1.3.1 This command was introduced.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 603
Commands
enter cap-qual

Usage Guidelines

Examples This example shows how to enter the FCoE capacity qualification:
server# scope org
server /org # scope server-qual all-chassis
server /org/server-qual # scope adapter
server /org/server-qual/adapter # enter cap-qual fcoe
server /org/server-qual/adapter/cap-qual #

Related Commands Command Description


create cap-qual

delete cap-qual

scope cap-qual

show cap-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


604 OL-25718-02
Commands
enter chassis

enter chassis
To enter a chassis, use the enter chassis command.

enter chassis min-chassis-id max-chassis-id

Syntax Description min-chassis-id Minimum chassis identification number. The range of valid values is 1 to
255.

max-chassis-id Maximum chassis identification number. The range of valid values is 1


to 255.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter slot capacity qualification. In this qualification, you can create and delete capacity
qualifications. Use the exit command to exit the chassis.
If you are entering a chassis for the first time, once you have entered you will need to execute the
commit-buffer command.

Examples This example shows how to enter a chassis:

switch-A# scope org org10

switch-A /org # scope server-qual sq10

switch-A /org/server-qual # enter chassis 1 1

switch-A /org/server-qual/chassis* # commit-buffer

switch-A /org/server-qual/chassis #

Related Commands Command Description


show cap-qual
show chassis

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 605
Commands
enter class chassis-stats

enter class chassis-stats


To enter a chassis statistics class, use the enter class chassis-stats command.

enter class chassis-stats

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter the chassis statistics class mode:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter class chassis-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class chassis-stats

delete class chassis-stats

scope class chassis-stats

show class chassis-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


606 OL-25718-02
Commands
enter class cpu-env-stats

enter class cpu-env-stats


To enter the CPU environment statistics class, use the enter class cpu-env-stats command.

enter class cpu-env-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter the CPU environment statistics class:
switch-A# scope org org100
switch-A /org # scope stats-threshold-policy stp100
switch-A /org/stats-threshold-policy # enter class cpu-env-stats
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 607
Commands
enter class dimm-env-stats

enter class dimm-env-stats


To enter the dual in-line memory module (DIMM) environment statistics class, use the enter class
dimm-env-stats command.

enter class dimm-env-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter the DIMM environment statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # enter class dimm-env-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class dimm-env-stats

delete class dimm-env-stats

scope class dimm-env-stats

show class dimm-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


608 OL-25718-02
Commands
enter class env-stats

enter class env-stats


To enter the environment statistics class, use the enter class env-stats command.

enter class env-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet server statistics threshold policy(eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter the environment statistics class:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter class env-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class env-stats

delete class env-stats

scope class env-stats

show class env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 609
Commands
enter class ether-error-stats

enter class ether-error-stats


To enter an Ethernet error statistics class, use the enter class ether-error-stats command.

enter class ether-error-stats

Command Default None

Command Modes Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)


Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter an Ethernet error statistics class for an Ethernet server:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter class ether-error-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class ether-error-stats

delete class ether-error-stats

scope class ether-error-stats

show class ether-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


610 OL-25718-02
Commands
enter class ether-loss-stats

enter class ether-loss-stats


To enter an Ethernet loss statistics class, use the enter class ether-loss-stats command.

enter class ether-loss-stats

Command Default None

Command Modes Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)


Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter an Ethernet loss statistics class for an Ethernet server:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter class ether-loss-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class ether-loss-stats

delete class ether-loss-stats

scope class ether-loss-stats

show class ether-loss-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 611
Commands
enter class ethernet-port-err-stats

enter class ethernet-port-err-stats


To create, if necessary, and enter an Ethernet port error statistics class, use the enter class
ethernet-port-err-stats command.

enter class ethernet-port-err-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create, if necessary, and enter an Ethernet port error statistics class.

Examples This example shows how to create and enter an Ethernet port error statistics class that does not already exist:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # enter class ethernet-port-err-stats
switch-A /org/stats-threshold-policy/class * # commit-buffer
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


612 OL-25718-02
Commands
enter class ethernet-port-multicast-stats

enter class ethernet-port-multicast-stats


To create, if necessary, and enter an Ethernet port multicast statistics class, use the enter class
ethernet-port-multicast-stats command.

enter class ethernet-port-multicast-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create, if necessary, and enter an Ethernet port multicast statistics class.

Examples This example shows how to enter an Ethernet port multicast statistics class that already exists:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # enter class ethernet-port-multicast-stats
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


create class ethernet-port-multicast-stats
show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 613
Commands
enter class ethernet-port-over-under-sized-stats

enter class ethernet-port-over-under-sized-stats


To create, if necessary, and enter an Ethernet port over-under-sized statistics class, use the enter class
ethernet-port-over-under-sized-stats command.

enter class ethernet-port-over-under-sized-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create, if necessary, and enter an Ethernet port over-under-sized statistics class.

Examples This example shows how to create and enter an Ethernet port over-under-sized statistics class that does not
already exist:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # enter class ethernet-port-over-under-sized-stats
switch-A /org/stats-threshold-policy/class * # commit-buffer
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


create class ethernet-port-over-under-sized-stats
show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


614 OL-25718-02
Commands
enter class ethernet-port-stats

enter class ethernet-port-stats


To create, if necessary, and enter an Ethernet port statistics class, use the enter class ethernet-port-stats
command.

enter class ethernet-port-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create, if necessary, and enter an Ethernet port statistics class.

Examples This example shows how to create and enter an Ethernet port statistics class that does not already exist:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # enter class ethernet-port-stats
switch-A /org/stats-threshold-policy/class * # commit-buffer
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 615
Commands
enter class ethernet-port-stats-by-size-large-packets

enter class ethernet-port-stats-by-size-large-packets


To create, if necessary, and enter an Ethernet port large packet statistics class, use the enter class
ethernet-port-stats-by-size-large-packets command.

enter class ethernet-port-stats-by-size-large-packets

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create, if necessary, and enter an Ethernet port large packet statistics class.

Examples This example shows how to create and enter an Ethernet port large packet statistics class that does not already
exist:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # enter class ethernet-port-stats-by-size-large-packets
switch-A /org/stats-threshold-policy/class * # commit-buffer
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


616 OL-25718-02
Commands
enter class ethernet-port-stats-by-size-small-packets

enter class ethernet-port-stats-by-size-small-packets


To create, if necessary, and enter an Ethernet port small packet statistics class, use the enter class
ethernet-port-stats-by-size-small-packets command.

enter class ethernet-port-stats-by-size-small-packets

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create, if necessary, and enter an Ethernet port small packet statistics class.

Examples This example shows how to create and enter an Ethernet port small packet statistics class that does not already
exist:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # enter class ethernet-port-stats-by-size-small-packets
switch-A /org/stats-threshold-policy/class * # commit-buffer
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 617
Commands
enter class ether-pause-stats

enter class ether-pause-stats


To enter the Ethernet pause statistics class, use the enter class ether-pause-stats command.

enter class ether-pause-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter the Ethernet pause statistics class:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter class ether-pause-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class ether-pause-stats

delete class ether-pause-stats

scope class ether-pause-stats

show class ether-pause-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


618 OL-25718-02
Commands
enter class ether-rx-stats

enter class ether-rx-stats


To enter an Ethernet recieve statistics class, use the enter class ether-rx-stats command.

enter class ether-rx-stats

Command Default None

Command Modes Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)


Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter an Ethernet recieve statistics class for the Ethernet server:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter class ether-rx-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class ether-rx-stats

delete class ether-rx-stats

scope class ether-rx-stats

show class ether-rx-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 619
Commands
enter class ether-tx-stats

enter class ether-tx-stats


To enter an Ethernet transmission statistics class, use the enter class ether-tx-stats command.

enter class ether-tx-stats

Command Default None

Command Modes Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)


Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter an Ethernet transmission statistics class for an Ethernet server:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter class ether-tx-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class ether-tx-stats

delete class ether-tx-stats

scope class ether-tx-stats

show class ether-tx-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


620 OL-25718-02
Commands
enter class fan-module-stats

enter class fan-module-stats


To enter a fan module statistics class, use the enter class fan-module-stats command.

enter class fan-module-stats

Command Default None

Command Modes Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a fan module statistics class in the Ethernet server:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter class fan-module-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class fan-module-stats

delete class fan-module-stats

scope class fan-module-stats

show class fan-module-stats

show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 621
Commands
enter class fan-stats

enter class fan-stats


To enter a fan statistics class, use the enter class fan-stats command.

enter class fan-stats

Command Default None

Command Modes Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a fan statistics class for an Ethernet server:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter class fan-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class fan-stats

delete class fan-stats

scope class fan-stats

show class fan-stats

show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


622 OL-25718-02
Commands
enter class fc-error-stats

enter class fc-error-stats


To enter a Fibre Channel error statistics class, use the enter class fc-error-stats command.

enter class fc-error-stats

Command Default None

Command Modes Statistics threshold policy under Fibre Channel uplink (/fc-uplink/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a Fibre Channel error statistics class:
server# scope fc-uplink
server /fc-uplink # scope stats-threshold-policy default
server /fc-uplink/stats-threshold-policy # enter class fc-error-stats
server /fc-uplink/stats-threshold-policy/class #

Related Commands Command Description


create class fc-error-stats

delete class fc-error-stats

scope class fc-error-stats

show class fc-error-stats

show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 623
Commands
enter class fc-port-stats

enter class fc-port-stats


To enter a Fibre Channel port statistics class, use the enter class fc-port-stats command.

enter class fc-port-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a Fibre Channel port statistics class:
server# scope org TestyOrg
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # enter class fc-port-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class fc-port-stats

delete class fc-port-stats

scope class fc-port-stats

show class fc-port-stats

show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


624 OL-25718-02
Commands
enter class fc-stats

enter class fc-stats


To enter a Fibre Channel statistics class, use the enter class fc-stats command.

enter class fc-stats

Command Default None

Command Modes Statistics threshold policy under Fibre Channel uplink (/fc-uplink/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a Fibre Channel statistics class:
server# scope fc-uplink
server /fc-uplink # scope stats-threshold-policy default
server /fc-uplink/stats-threshold-policy # enter class fc-stats
server /fc-uplink/stats-threshold-policy/class #

Related Commands Command Description


create class fc-stats

delete class fc-stats

scope class fc-stats

show class fc-stats

show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 625
Commands
enter class fex-env-stats

enter class fex-env-stats


To create, if necessary, and to enter the Fabric extender statistics class, use the enter class fex-env-stats
command.

enter class fex-env-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics Threshold Policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to enter the fabric extender environment statistics mode for a class.
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy sample
Switch-A /eth-server/stats-threshold-policy # enter class fex-env-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


enter class fex-power-summary
enter class fex-psu-input-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


626 OL-25718-02
Commands
enter class fex-power-summary

enter class fex-power-summary


To create, if necessary, and to enter the Fabric extender power summary mode for a class, use the enter class
fex-power-summary command.

enter class fex-power-summary

This command has no arguments or keywords.

Command Default None

Command Modes Statistics Threshold Policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to enter the Fabric extender power summary mode for a class.
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy sample
Switch-A /eth-server/stats-threshold-policy # enter class fex-power-summary
Switch-A /eth-server/stats-threshold-policy/class* # commit-buffer
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


enter class fex-env-stats
enter class fex-psu-input-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 627
Commands
enter class fex-psu-input-stats

enter class fex-psu-input-stats


To create, if necessary, and to enter the Fabric extender power supply unit statistics mode for a class, use the
enter class fex-psu-input-stats command.

enter class fex-psu-input-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics Threshold Policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to enter the Fabric extender power supply unit statistics mode for a class.
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy sample
Switch-A /eth-server/stats-threshold-policy # enter class fex-psu-input-stats
Switch-A /eth-server/stats-threshold-policy/class* # commit-buffer
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


enter class fex-env-stats
enter class fex-power-summary

Cisco UCS Manager CLI Command Reference, Release 2.0


628 OL-25718-02
Commands
enter class io-card-stats

enter class io-card-stats


To enter the IO card statistics class, use the enter class io-card-stats command.

enter class io-card-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter the IO card statistics class:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter class io-card-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class io-card-stats

delete class io-card-stats

scope class io-card-stats

show class io-card-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 629
Commands
enter class mb-power-stats

enter class mb-power-stats


To enter a mother board power statistics class, use the enter class mb-power-stats command.

enter class mb-power-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a mother board power statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # enter class mb-power-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class mb-power-stats

delete class mb-power-stats

scope class mb-power-stats

show class mb-power-stats

show stats history mb-power-stats

show stats mb-power-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


630 OL-25718-02
Commands
enter class mb-temp-stats

enter class mb-temp-stats


To enter a temporary mother board statistics class, use the enter class mb-temp-stats command.

enter class mb-temp-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a temporary mother board statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # enter class mb-temp-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class mb-temp-stats

delete class mb-temp-stats

scope class mb-temp-stats

show class mb-temp-stats

show stats history mb-temp-stats

show stats mb-temp-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 631
Commands
enter class memory-array-env-stats

enter class memory-array-env-stats


To enter the memory array environment statistics class, use the enter class memory-array-env-stats
command.

enter class memory-array-env-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistcis threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter the memory array environment statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # enter class memory-array-env-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class memory-array-env-stats

delete class memory-array-env-stats

scope class memory-array-env-stats

show class memory-array-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


632 OL-25718-02
Commands
enter class motherboard-temp-stats

enter class motherboard-temp-stats


To enter the motherboard temperature statistics class, use the enter class motherboard-temp-stats command.

enter class motherboard-temp-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy and a motherboard temperature statistics class must be created to use this command.

Examples This example shows how to enter the motherboard temperature statistics class mode.
UCS-A # scope org test
UCS-A /org # scope stats-threshold-policy sample
UCS-A /org/stats-threshold-policy # enter class motherboard-temp-stats
UCS-A /org/stats-threshold-policy/class #

Related Commands Command Description


create motherboard-temp-stats

scope motherboard-temp-stats

show motherboard-temp-stats

delete motherboard-temp-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 633
Commands
enter class pcie-fatal-completion-error-stats

enter class pcie-fatal-completion-error-stats


To enter the Peripheral Component Interconnect (PCI) Express (PCIe) fatal completion error statistics class,
use the enter class pcie-fatal-completion-error-stats command.

enter class pcie-fatal-completion-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter the PCIe fatal completion error statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # enter class pcie-fatal-completion-error-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class pcie-fatal-completion-error-stats

delete class pcie-fatal-completion-error-stats

scope class pcie-fatal-completion-error-statss

show class pcie-fatal-completion-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


634 OL-25718-02
Commands
enter class pcie-fatal-error-stats

enter class pcie-fatal-error-stats


To enter the Peripheral Component Interconnect (PCI) Express (PCIe) fatal error statistics class, use the enter
class pcie-fatal-error-stats command.

enter class pcie-fatal-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter the PCIe fatal error statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # enter class pcie-fatal-error-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class pcie-fatal-error-stats

delete class pcie-fatal-error-stats

scope class pcie-fatal-error-stats

show class pcie-fatal-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 635
Commands
enter class pcie-fatal-protocol-error-stats

enter class pcie-fatal-protocol-error-stats


To enter the Peripheral Component Interconnect (PCI) Express (PCIe) fatal protocol error statistics class, use
the enter class pcie-fatal-protocol-error-stats command.

enter class pcie-fatal-protocol-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a PCIe fatal protocol error statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # enter class pcie-fatal-protocol-error-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class pcie-fatal-protocol-error-stats

delete class pcie-fatal-protocol-error-stats

scope class pcie-fatal-protocol-error-stats

show class pcie-fatal-protocol-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


636 OL-25718-02
Commands
enter class pcie-fatal-receiving-error-stats

enter class pcie-fatal-receiving-error-stats


To enter the Peripheral Component Interconnect (PCI) Express (PCIe) fatal receive error statistics class, use
the enter class pcie-fatal-receiving-error-stats command.

enter class pcie-fatal-receiving-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter the PCIe fatal receive error statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # enter class pcie-fatal-receiving-error-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class pcie-fatal-receiving-error-stats

delete class pcie-fatal-receiving-error-stats

scope class pcie-fatal-receiving-error-stats

show class pcie-fatal-receiving-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 637
Commands
enter class psu-input-stats

enter class psu-input-stats


To enter a power supply input statistics class, use the enter class psu-input-stats command.

enter class psu-input-stats

Command Default None

Command Modes Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a power supply input statistics class:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter class psu-input-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class psu-input-stats

delete class psu-input-stats

scope class psu-input-stats

show class psu-input-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


638 OL-25718-02
Commands
enter class rack-unit-fan-stats

enter class rack-unit-fan-stats


To create, if necessary, and to enter the rack unit fan statistics mode for a class, use the enter class
rack-unit-fan-stats command.

enter class rack-unit-fan-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must created to use this command.

Examples This example shows how to enter the rack unit fan statistics mode for a class.
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy Sample
Switch-A /eth-server/stats-threshold-policy # enter class rack-unit-fan-stats
Switch-A /eth-server/stats-threshold-policy/class* # commit-buffer
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


enter class rack-unit-psu-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 639
Commands
enter class rack-unit-psu-stats

enter class rack-unit-psu-stats


To create, if necessary, and to enter the rack unit power supply unit statistics mode for a class, use the enter
class rack-unit-psu-stats command.

enter class rack-unit-psu-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to enter the rack unit power supply unit statistics mode for a class.
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy sample
Switch-A /eth-server/stats-threshold-policy # enter class rack-unit-psu-stats
Switch-A /eth-server/stats-threshold-policy/class* # commit-buffer
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


enter class rack-unit-fan-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


640 OL-25718-02
Commands
enter class system-stats

enter class system-stats


To enter a system statistics class, use the enter class system-stats command.

enter class system-stats

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.31. This command was introduced.

Usage Guidelines

Examples This example shows how to enter the system statistics class:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # enter system-stats
server /eth-server/stats-threshold-policy #

Related Commands Command Description


create class system-stats

delete class system-stats

scope class system-stats

show class system-stats

show stats system-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 641
Commands
enter class vnic-stats

enter class vnic-stats


To enter a virtual NIC statistics class, use the enter class vnic-stats command.

enter class vnic-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a virtual NIC statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # enter class vnic-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class vnic-stats

delete class vnic-stats

scope class vnic-stats

show class vnic-stats

show stats vnic-stats

show stats vnic-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


642 OL-25718-02
Commands
enter client

enter client
To enter a specific client mode, use the enter client command in port-profile mode.

enter client client-name

Syntax Description client-name The name of the client.

Command Default None

Command Modes Profile set (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to enter a specific client mode:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope profile-set
switch-A /system/vm-mgmt/vmware/profile-set # scope port-profile pp100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile # enter client c100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile #

Related Commands Command Description


show port profile
show profile-set

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 643
Commands
enter cluster

enter cluster
To enter a distributed virtual switch, use the enter cluster command.

enter cluster name

Syntax Description name The name of the distributed virtual switch. It is the name you provided while creating
the switch.

Command Default None

Command Modes Cluster set (/system/vm-mgmt/cluster-set)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines A distributed virtual switch must be created to use this command.

Examples This example shows how to enter a distributed virtual switch.


UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope cluster-set
UCS-A /system/vm-mgmt/cluster-set # enter cluster sample
UCS-A /system/vm-mgmt/cluster-set/cluster #

Related Commands Command Description


create cluster

scope cluster

show cluster

delete cluster

Cisco UCS Manager CLI Command Reference, Release 2.0


644 OL-25718-02
Commands
enter cpu

enter cpu
To enter a CPU qualifier for a server pool policy, use the enter cpu command.

enter cpu

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a CPU qualifier:


server# scope org
server /org # scope server-qual all-chassis
server /org/server-qual # enter cpu
server /org/server-qual/cpu #

Related Commands Command Description


create cpu

delete cpu

scope cpu

show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 645
Commands
enter data-center

enter data-center
To enter a data center, use the enter data command in vcenter mode.

enter data-center datacenter-name

Syntax Description datacenter-name The name of the data center.

Command Default None

Command Modes VCenter (/system/vm-mgmt/vmware/vcenter)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use data-center mode to perform the following tasks:


• Create and delete folders
• Show folder information

Examples This example shows how to enter a data center:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc10
switch-A /system/vm-mgmt/vmware/vcenter # enter data-center dc10
switch-A /system/vm-mgmt/vmware/vcenter/data-center #

Related Commands Command Description


show data-center
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


646 OL-25718-02
Commands
enter default-auth

enter default-auth
To create, if necessary, or to enter the default authentication mode, use the enter default-auth command.

enter default-auth

Command Default None

Command Modes Authentication Domain (/security/auth-domain)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication domain must be created to use this command.

Examples This example shows how to enter the default authentication mode for an authentication domain.
Switch-A # scope security
Switch-A /security # scope auth-domain Testing
Switch-A /security/auth-domain # enter default-auth
Switch-A /security/auth-domain/default-auth #

Related Commands Command Description


create auth-domain
create default-auth
scope default-auth

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 647
Commands
enter default-behavior

enter default-behavior
To enter default-behavior mode, use the enter default-behavior command.

enter default-behavior {vhba | vnic}

Syntax Description vhba Specifies vHBA default behavior mode.

vnic Specifies vNIC default behavior mode.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to create a default behavior, and enter organization default-behavior mode.

Examples This example shows how to enter vNIC default behavior mode:
switch-A# scope org org100
switch-A /org # scope service-profile sp100
switch-A /org/service-profile # enter default-behavior vnic
switch-A /org/service-profile/default-behavior* # commit-buffer
switch-A /org/service-profile/default-behavior #

Related Commands Command Description


show default-behavior
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


648 OL-25718-02
Commands
enter destination

enter destination
To enter an email address to which Call Home alerts should be sent, use the enter destination command.

enter destination email-addr

Syntax Description email-addr E-mail address in email address format. The address can
be a maximum of 512 alphanumeric characters, and
cannot contain white spaces. Example,
personname@companyname.com.

Command Default None

Command Modes Profile (/monitoring/callhome/profile)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter an email destination:


server# scope monitoring
server /monitoring # scope callhome
server /monitoring/callhome # scope profile full_txt
server /monitoring/callhome/profile # enter destination home@test.com
server /monitoring/callhome/profile/destination #

Related Commands Command Description


create destination

delete destination

scope destination

show destination

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 649
Commands
enter dest-interface

enter dest-interface
To create, if necessary, and to enter the destination interface of the Fibre Channel traffic monitoring session
or the Ethernet traffic monitoring session, use the enter dest-interface command.

enter dest-interface slotid portid

Syntax Description slotid The slot ID of the destination interface.

portid The port ID of the destination interface.

Command Default None

Command Modes Fibre Channel traffic monitoring session (/fc-traffic-mon/fabric/fc-mon-session)


Ethernet traffic monitoring session (/eth-traffic-mon/fabric/eth-mon-session)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The Fibre Channel traffic monitoring session or an Ethernet traffic monitoring session must be created to use
this command.

Examples This example shows how to enter the destination interface of the Fibre Channel traffic monitoring session
To enter the destination interface of an Ethernet traffic monitoring session, replace fc-traffic-mon with
eth-traffic-mon , and fc-mon-session with eth-mon-session .
Switch-A # scope fc-traffic-mon
Switch-A /fc-traffic-mon # scope fabric a
Switch-A /fc-traffic-mon/fabric # scope fc-mon-session Default
Switch-A /fc-traffic-mon/fabric/fc-mon-session # enter dest-interface 1 1
Switch-A /fc-traffic-mon/fabric/fc-mon-session/dest-interface* # commit-buffer

Related Commands Command Description


create dest-interface
delete dest-interface

Cisco UCS Manager CLI Command Reference, Release 2.0


650 OL-25718-02
Commands
enter dhcp-ip-params

enter dhcp-ip-params
To enter the configured DHCP for initiator IP parameters, use the enter dhcp-ip-params command.

enter dhcp-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface of the iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a DHCP initiator for IP parameters before you use this command.

Examples This example shows how to enter the configured DHCP for initiator IP parameters:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # enter dhcp-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/dhcp-ip-params #

Related Commands Command Description


create dhcp-ip-params

scope dhcp-ip-params

delete dhcp-ip-params

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 651
Commands
enter distributed-virtual-switch

enter distributed-virtual-switch
To enter a distributed virtual switch, use the enter distributed-virtual-switch command in folder mode.

enter distributed-virtual-switch dvs-name

Syntax Description dvs-name The name of the switch.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware/vcenter/data-center/folder)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use distributed-virtual-switch mode to perform the following tasks:


• Enable and disable DVS administrative state
• Scope to port-profile mode
• Show port profile information

Examples This example shows how to enter a distributed virtual switch:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc10
switch-A /system/vm-mgmt/vmware/vcenter # scope data-center dc10
switch-A /system/vm-mgmt/vmware/vcenter/data-center # scope folder f10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder # enter distributed-virtual-switch
dvs10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder/distributed-virtual-switch #

Related Commands Command Description


show distributed-virtual-switch
show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


652 OL-25718-02
Commands
enter dynamic-vnic-conn

enter dynamic-vnic-conn
To enter dynamic-vnic-conn mode, use the enter dynamic-vnic-conn command.

create dynamic-vnic-conn

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use dynamic-vnic-conn mode to perform the following tasks:


• Set adapter policies
• Show the dynamic vNIC connection

Examples This example shows how to enter dynamic-vnic-conn mode:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # enter dynamic-vnic-conn

switch-A /org/service-profile #

Related Commands Command Description


show dynamic-vnic-con
show dynamic-vnic-con-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 653
Commands
enter dynamic-vnic-conn-policy

enter dynamic-vnic-conn-policy
To enter dynamic-vnic-conn-policy mode, use the enter dynamic-vnic-conn-policy command.

enter dynamic-vnic-conn-policy policy-name

Syntax Description policy-name The name of the vNIC connection policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use dynamic-vnic-conn-policy mode to perform the following tasks:


• Set adapter policies
• Show dynamic vNIC connection policies

Examples The following example shows how to enter dynamic-vnic-conn-policy mode:


switch-A# scope org org100
switch-A /org # enter dynamic-vnic-conn-policy dvcp100
switch-A /org/dynamic-vnic-conn-policy #

Related Commands Command Description


show dynamic-vnic-connection-policy
show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


654 OL-25718-02
Commands
enter egress-policy

enter egress-policy
To enter an egress policy (for both vNICs and vHBAs) to be used by a QoS policy, use the enter egress-policy
command.

enter egress-policy

Command Default None

Command Modes QoS policy (/org/qos-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter an egress policy for vNIC traffic:
server# scope org
server /org # scope qos-policy VnicPolicy34
server /org/qos-policy # enter egress-policy
server /org/qos-policy/egress-policy #

Related Commands Command Description


create egress-policy

delete egress-policy

scope egress-policy

show egress-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 655
Commands
enter eth-if

enter eth-if
To enter an Ethernet interface, use the enter eth-if command.

enter eth-if intf-name

Syntax Description intf-name Interface name. The name can be 32 characters.

Command Default None

Command Modes Virtual NIC (/org/service-profile/vnic)


Virtual NIC template (/org/vnic-templ)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter an Ethernet interface in virtual NIC:
server# scope org
server /org # scope service-profile CE-B440-M1-SP
server /org/service-profile # scope vnic vnic-emulex-a
server /org/service-profile/vnic # enter eth-if vlan150
server /org/service-profile/vnic/eth-if #

Related Commands Command Description


create eth-if

delete eth-if

scope eth-if

show eth-if

show service-profile

show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


656 OL-25718-02
Commands
enter eth-if (vnic-iscsi)

enter eth-if (vnic-iscsi)


To enter the Ethernet interface for an iSCSI VNIC, use the enter eth-if command.

enter eth-if

This command has no arguments or keywords.

Command Default None

Command Modes iSCSI VNIC (/org/service-profile/vnic-iscsi)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a service profile and an iSCSI VNIC for the service profile before you use this command.

Examples This example shows how to enter the Ethernet interface of the iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-isci testing
UCS-A /org/service-profile/vnic-iscsi # enter eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if #

Related Commands Command Description


create ip-if

create eth-if

scope eth-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 657
Commands
enter eth-mon-session

enter eth-mon-session
To enter an Ethernet traffic monitoring session, use the enter eth-mon-session command.

enter eth-mon-session name

Syntax Description name The name of the Ethernet traffic monitoring session.

Command Default None

Command Modes Fabric (/eth-traffic-mon/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An Ethernet traffic monitoring session must be created to use this command.

Examples This example shows how to enter the Ethernet traffic monitoring session:
Switch-A # scope eth-traffic-mon
Switch-A /eth-traffic-mon # scope fabric a
Switch-A /eth-traffic-mon/fabric # enter eth-mon-session Default
Switch-A /eth-traffic-mon/fabric/eth-mon-session* # commit-buffer
Switch-A /eth-traffic-mon/fabric/eth-mon-session #

Related Commands Command Description


scope eth-mon-session
create eth-mon-session
delete eth-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


658 OL-25718-02
Commands
enter eth-policy

enter eth-policy
To enter eth-policy mode, use the enter eth-policy command.

enter eth-policy policy-name

Syntax Description policy-name The name of the Ethernet policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0 This command was introduced.

Examples This example shows how to enter eth-policy mode using Ethernet policy ep100:

switch-A# scope org org100

switch-A /org # enter eth-policy ep100

switch-A /org/eth-policy #

Related Commands Command Description


show eth-policy
show trans-queue

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 659
Commands
enter eth-target

enter eth-target
To create, if necessary, and to enter the Ethernet target endpoint mode for a fabric, use the enter eth-target
command.

enter eth-target name

Syntax Description name Name of the Ethernet target endpoint of the fabric.

Command Default None

Command Modes Interface (/eth-storage/fabric/interface)


Port channel (/eth-storage/fabric/port-channel)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create an interface for a fabric, and an Ethernet target endpoint for that interface before you use
this command.
You must create a port channel for a fabric, and an Ethernet target endpoint for that port channel before you
use this command.

Examples This example shows how to enter the Ethernet target endpoint mode for a fabric interface:
Switch-A # scope eth-storage
Switch-A /eth-storage # scope fabric a
Switch-A /eth-storage/fabric # scope interface 2 33
Switch-A /eth-storage/fabric/interface # enter eth-target Testing
Switch-A /eth-storage/fabric/interface/eth-target #

Related Commands Command Description


create eth-target
scope eth-target
set macaddress
show eth-target
delete eth-target

Cisco UCS Manager CLI Command Reference, Release 2.0


660 OL-25718-02
Commands
enter ext-static-ip

enter ext-static-ip
To create, if necessary, and to enter the external static management IP address mode, use the enter ext-static-ip
command.

enter ext-static-ip

This command has no arguments or keywords.

Command Default None

Command Modes CIMC (/chassis/server/cimc)


Service profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the external static management IP address mode for the CIMC.
Switch-A # scope server 1/7
Switch-A /chassis/server # scope cimc
Switch-A /chassis/server/cimc # enter ext-static-ip
Switch-A /chassis/server/cimc/ext-static-ip #

Related Commands Command Description


set addr
set default-gw
set subnet
create ext-static-ip
scope ext-static-ip
show ext-static-ip
delete ext-static-ip

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 661
Commands
enter fc-mon-session

enter fc-mon-session
To enter the Fibre Channel trafffic monitoring session, use the enter fc-mon-session command.

enter fc-mon-session name

Syntax Description name The name of the Fibre Channel traffic monitoring session. The name can include a
maximum of 16 characters.

Command Default None

Command Modes Fabric (/fc-traffic-mon/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A Fibre Channel traffic monitoring session must be created to use this command.

Examples This example shows how to enter the Fibre Channel traffic monitoring session:
Switch-A # scope fc-traffic-mon
Switch-A /fc-traffic-mon # scope fabric a
Switch-A /fc-traffic-mon/fabric # enter fc-mon-session Default
Switch-A /fc-traffic-mon/fabric/fc-mon-session #

Related Commands Command Description


scope fc-mon-session
create fc-mon-session
delete fc-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


662 OL-25718-02
Commands
enter fc-policy

enter fc-policy
To enter fc-policy mode, use the enter fc-policy command.

enter fc-policy policy-name

Syntax Description policy-name The name of the Fibre Channel policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use fc-policy mode to perform the following tasks:


• Create and delete Fibre Channel policies
• Show Fibre Channel policies

Examples The following example shows how to enter fc-policy mode:


switch-A# scope org org100
switch-A /org # scope fc-policy fp100
switch-A /org # scope fc-policy fcp100
switch-A /org/fc-policy #

Related Commands Command Description


show fc-policy
show trans-queue

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 663
Commands
enter folder

enter folder
To enter a folder, use the enter folder command in vcenter mode.

enter folder folder-name

Syntax Description folder-name The name of the folder.

Command Default None

Command Modes VCenter (/system/vm-mgmt/vmware/vcenter)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use data-center mode to perform the following tasks:


• Create and delete data-centers
• Show data-center information

Examples This example shows how to enter a folder:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc10
switch-A /system/vm-mgmt/vmware/vcenter # enter folder f10
switch-A /system/vm-mgmt/vmware/vcenter/folder #

Related Commands Command Description


show data-center
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


664 OL-25718-02
Commands
enter fw-host-pack

enter fw-host-pack
To enter a host firmware package, use the enter fw-host-pack command.

enter fw-host-pack host-pack-name

Syntax Description host-pack-name Name of the server host firmware package image. The
name can be a maximum of 16 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a host firrmware package:


server# scope org
server /org # enter fw-host-pack app1
server /org/fw-host-pack #

Related Commands Command Description


create fw-host-pack

delete fw-host-pack

scope fw-host-pack

show fw-host-pack

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 665
Commands
enter fw-mgmt-pack

enter fw-mgmt-pack
To enter a management firmware package, use the enter fw-mgmt-pack command.

enter fw-mgmt-pack mgmt-pack-name

Syntax Description mgmt-pack-name Name of the management firmware package. The name can be a maximum
of 16 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to delete a management firmware package:


server# scope org
server /org # enter fw-mgmt-pack cimc1
server /org/fw-mgmt-pack #

Related Commands Command Description


create fw-mgmt-pack

delete fw-mgmt-pack

scope fw-mgmt-pack

show fw-mgmt-pack

Cisco UCS Manager CLI Command Reference, Release 2.0


666 OL-25718-02
Commands
enter import-config

enter import-config
To enter an import configuration, use the enter import-config command.

enter import-config URL {disabled| enabled} {merge| replace}

Syntax Description URL URL for the file being imported using one of the
following syntax:
• ftp://hostname/path
scp://username@hostname/path
sftp://username@hostname/path
tftp://hostname:port-num/path

disabled Specifies that the import operation will not run until it
is enabled.

enabled Specifies that the import operation automatically runs


as soon as you enter the commit-buffer command.

merge Specifies that the configuration information is merged


with the existing information.

replace Specifies that the system takes each object in the import
configuration file and overwrites the corresponding
object in the current configuration.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter an import configuration:


server# scope system
server /system # enter import-config scp://user@host35/backups/all-config9.bak disabled
replace
server /system/import-config #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 667
Commands
enter import-config

Related Commands Command Description


create import-config

delete import-config

scope import-config

show import-config

Cisco UCS Manager CLI Command Reference, Release 2.0


668 OL-25718-02
Commands
enter initiator

enter initiator
To enter the organization WWN pool initiator mode, use the enter initiator command.

enter initiator ID

Syntax Description ID Initiator ID in the format nn:nn:nn:nn:nn:nn:nn:nn.

Command Default None

Command Modes WWN pool (/org/wwn-pool)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter an initiator named 20:00:00:25:B5:00:00:00 for the default WWN pool:
server# scope org
server /org # scope wwn-pool default
server /org/wwn-pool # enter initiator 20:00:00:25:B5:00:00:00
server /org/wwn-pool/initiator #

Related Commands Command Description


create initiator

delete initiator

scope initiator

show initiator

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 669
Commands
enter interface

enter interface
To enter an interface for the specified Ethernet server port, use the enter interface command.

enter interface slot-id port-id

Syntax Description slot-id Ethernet interface slot number. The range is from 1 to
5 for a fabric interconnect under Ethernet server and
under Ethernet uplink, 2 to 5 for a fabric interconnect
under Fibre Channel uplink.

port-id Ethernet interface port number. The range is from 1 to


40.

Command Default None

Command Modes Fabric interconnect under Fibre Channel uplink (/fc-uplink/fabric)


Fabric interconnect under Ethernet server (/eth-server/fabric)
Fabric interconnect under Ethernet uplink (/eth-uplink/fabric)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter an interface for Ethernet server port 14 on slot 3 of fabric B:
server# scope eth-server
server /eth-server # scope fabric b
server /eth-server/fabric # enter interface 1 2
server /eth-server/fabric/interface #

Related Commands Command Description


create interface

delete interface

scope interface

show interface

Cisco UCS Manager CLI Command Reference, Release 2.0


670 OL-25718-02
Commands
enter interface fc

enter interface fc
To create, if necessary, and to enter the fibre channel interface of the fabric, use the enter interface fc command.

enter interface fc slot id port id

Syntax Description slot id The slot identification number. The range of valid values is 2 to 5.

port id The port identification number. The range of valid values is 1 to 40.

Command Default None

Command Modes Fabric (/fc-storage/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A fibre channel interface for a fabric must be created to use this command.

Examples This example shows how to enter the fibre channel interface for a fabric.
Switch-A # scope fc-storage
Switch-A /fc-storage # scope fabric a
Switch-A /fc-storage/fabric # enter interface fc 2 33
Switch-A /fc-storage/fabric/fc #

Related Commands Command Description


create interface fc
scope interface fc
show interface fc
delete interface fc

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 671
Commands
enter interface fcoe

enter interface fcoe


To create, if necessary, and to enter the Fibre Channel over Ethernet interface for a fabric, use the enter
interface fcoe command.

enter interface fcoe slot id port id

Syntax Description slot id The slot identification number.

port id The port identification number.

Command Default None

Command Modes Fabric (/fc-storage/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A Fibre Channel over Ethernet interface for a fabric must be created to use this command.

Examples This example shows how to enter the Fibre Channel over Ethernet interface for a fabric.
Switch-A # scope fc-storage
Switch-A /fc-storage # scope fabric a
Switch-A /fc-storage/fabric # enter interface fcoe 2 33
Switch-A /fc-storage/fabric/fcoe #

Related Commands Command Description


create interface fcoe
scope interface fcoe
show interface fcoe
delete interface fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


672 OL-25718-02
Commands
enter ip-if

enter ip-if
To enter the IPv4 interface of an iSCSI VNIC, use the enter ip-if command.

enter ip-if

This command has no arguments or keywords.

Command Default None

Command Modes Ethernet interface within the iSCSI VNIC mode (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an IPv4 interface for an iSCSI VNIC before you use this command.

Examples This example shows how to enter the IPv4 interface of the iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi example
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # enter ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if #

Related Commands Command Description


create dhcp-ip-params

create pooled-ip-params

create static-ip-params

create ip-if

scope ip-if

delete ip-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 673
Commands
enter ipmi-access-profile

enter ipmi-access-profile
To enter an Intelligent Platform Management Interface (IPIMI) access profile, use the enter ipmi-access-profile
command.

enter ipmi-access-profile profile-name

Syntax Description profile-name IPMI access profile name. The name is case sensitive,
and can be a maximum of 16 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter an IPMI access profile named ipmiProf1:
server# scope org
server /org # enter ipmi-access-profile ipmiProf1
server /org/ipmi-access-profile #

Related Commands Command Description


create ipmi-access-profile

delete ipmi-access-profile

scope ipmi-access-profile

show ipmi-access-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


674 OL-25718-02
Commands
enter ipmi-user

enter ipmi-user
To enter an end-point user for IPMI access, use the enter ipmi-user command.

enter ipmi-user name

Syntax Description name End-point IPMI user name. The name is case insensitive,
and can be a maximum of 16 alphanumeric characters.
The name can also contain a hyphen (-) or underscore
(_) character, but cannot contain white spaces.

Command Default None

Command Modes IPMI access profile (/org/ipmi-access-profile)

Command History Release Modification


1.3.1 This command was introduced as enter epuser.

1.4(1) This command was renamed as enter ipmi-user.

Usage Guidelines None

Examples This example shows how to enter an IPMI user:


server# scope org
server /org # scope ipmi-access-profile IPMI-1
server /org/ipmi-access-profile # enter ipmi-user user1
server /org/ipmi-access-profile/ipmi-user #

Related Commands Command Description


create ipmi-user

delete ipmi-user

scope ipmi-user

show ipmi-user

set descr

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 675
Commands
enter ipmi-user

Command Description
set password

set privilege

Cisco UCS Manager CLI Command Reference, Release 2.0


676 OL-25718-02
Commands
enter iqn-pool

enter iqn-pool
To enter the IQN Pool command mode, use the enter iqn-pool command.

enter iqn-pool name

Syntax Description name Name of the IQN pool.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines An IQN pool must be created to use this command.

Examples This example shows how to enter the IQN pool command mode.
UCS-A # scope org
UCS-A /org # enter iqn-pool Sample1
UCS-A /org/iqn-pool #

Related Commands Command Description


create iqn-pool

scope iqn-pool

show iqn-pool

delete iqn-pool

set iqn-prefix

set descr

create block

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 677
Commands
enter iscsi-policy

enter iscsi-policy
To enter, and create if necessary, an iSCSI adapter policy, use the enter iscsi-policy command.

enter iscsi-policy name

Syntax Description name Name of the iSCSI adapter policy. Provide the name that you had specified when
you created this policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI adapter policy before you use this command.

Examples This example shows how to enter the iSCSI adapter policy in the organization mode:
UCS-A # scope org test
UCS-A /org # enter iscsi-policy sample
UCS-A /org/iscsi-policy #

Related Commands Command Description


create iscsi-policy

scope iscsi-policy

show iscsi-policy

delete iscsi-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


678 OL-25718-02
Commands
enter iscsi

enter iscsi
To enter and create a boot iSCSI mode for an organization, use the enter iscsi command.

enter iscsi

This command has no arguments or keywords.

Command Default None

Command Modes Boot definition of a service profile (/org/service-profile/boot-definition)


Boot policy (/org/boot-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a boot iSCSI policy before you use this command.

Examples This example shows how to enter the boot iSCSI mode for a service profile:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope boot-definition
UCS-A /org/service-profile/boot-definition # enter iscsi
UCS-A /org/service-profile/boot-definition/iscsi #

Related Commands Command Description


create iscsi

delete iscsi

scope iscsi

show iscsi

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 679
Commands
enter keyring

enter keyring
To enter an RSA keyring, use the enter keyring command.

enter keyring name

Syntax Description name Keyring name. The name can be a maximum of 16


characters.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter a keyring named 210:


server# scope security
server /security # enter keyring kr210
server /security/keyring #

Related Commands Command Description


create keyring

delete keyring

scope keyring

show keyring

Cisco UCS Manager CLI Command Reference, Release 2.0


680 OL-25718-02
Commands
enter lan

enter lan
To enter a LAN boot configuration, use the enter lan command.

enter lan

Command Default None

Command Modes Boot policy under organization (/org/boot-policy)


Boot definition under service-profile (/org/service-profile/boot-def)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter a LAN boot configuration for a boot policy:
server# scope org
server /org # scope boot-policy bp6
server /org/boot-policy # enter lan
server /org/boot-policy/lan #

Related Commands Command Description


create lan

delete lan

scope lan

show lan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 681
Commands
enter ldap-group

enter ldap-group
To create, if necessary, and to enter the LDAP group mode, use the enter ldap-group command.

enter ldap-group Group DN

Syntax Description Group DN The name of the LDAP group.

Command Default None

Command Modes LDAP (/security/ldap)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An LDAP group must be created to use this command.

Examples This example shows how to enter the LDAP group:


Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # enter ldap-group Default
Switch-A /security/ldap/ldap-group #

Related Commands Command Description


scope ldap-group
create ldap-group
delete ldap-group

Cisco UCS Manager CLI Command Reference, Release 2.0


682 OL-25718-02
Commands
enter ldap-group-rule

enter ldap-group-rule
To create, if necessary, and to enter the LDAP group-rule mode, use the enter ldap-group-rule command.

enter ldap-group-rule

Command Default None

Command Modes LDAP (/security/ldap)


Server (/security/ldap/server)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines To use this command in the server mode, an LDAP server must be created.

Examples This example shows how to enter the LDAP group rule mode for an LDAP server.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope server Sample
Switch-A /security/ldap/server # enter ldap-group-rule
Switch-A /security/ldap/server/ldap-group-rule #

Related Commands Command Description


scope ldap-group-rule
create ldap-group-rule
show ldap-group-rule
delete ldap-group-rule

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 683
Commands
enter local

enter local
To enter a local storage, use the enter local command.

enter local

Command Default None

Command Modes Storage under boot policy (/org/boot-policy/storage)


Storage under boot definition (/org/service-profile/boot-def/storage)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter a local storage configuration for a boot policy:
server# scope org
server /org # scope boot-policy bp6
server /org/boot-policy # scope storage
server /org/boot-policy/storage # enter local
server /org/boot-policy/storage #

Related Commands Command Description


create local

delete local

scope local

show local

Cisco UCS Manager CLI Command Reference, Release 2.0


684 OL-25718-02
Commands
enter local-disk-config

enter local-disk-config
To enter a local disk configuration for a service profile, use the enter local-disk-config command.

enter local-disk-config

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter a local disk configuration for a service profile:
server# scope org
server /org # scope service-profile CE-B440-M1-SP
server /org/service-profile # enter local-disk-config
server /org/service-profile/local-disk-config #

Related Commands Command Description


create local-disk-config

delete local-disk-config

scope local-disk-config

show local-disk-config

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 685
Commands
enter local-disk-config-policy

enter local-disk-config-policy
To enter a local disk configuration policy, use the enter local-disk-config-policy command.

enter local-disk-config-policy policy-name

Syntax Description policy-name Policy name. The name is case sensitive, and can be a
maximum of 16 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter a local disk configuration policy named ldcp1:
server# scope org
server /org # enter local-disk-config-policy ldcp1
server /org/local-disk-config-policy #

Related Commands Command Description


create local-disk-config-policy

delete local-disk-config-policy

scope local-disk-config-policy

show local-disk-config-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


686 OL-25718-02
Commands
enter locale

enter locale
To enter a locale, use the enter locale command.

enter locale locale-name

Syntax Description locale-name Locale name. The name is case sensitive, and can be a
maximum of 16 characters.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter the western locale:


server# scope security
server /security # enter locale western
server /security/locale #

Related Commands Command Description


create locale

delete locale

scope locale

show locale

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 687
Commands
enter local-user

enter local-user
To enter an user account for a specified local user, use the enter local-user command.

enter local-user user-name

Syntax Description user-name User name. The name is case sensitive, and can be a
maximum of 16 characters.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter a local user named Escalation:
server# scope security
server /security # enter local-user Escalation
server /security/local-user #

Related Commands Command Description


create local-user

delete local-user

scope local-user

show local-user

Cisco UCS Manager CLI Command Reference, Release 2.0


688 OL-25718-02
Commands
enter lun

enter lun
To enter a target LUN for a static target interface of the iSCSI VNIC, use the enter lun command.

enter lun

This command has no arguments or keywords.

Command Default None

Command Modes Static target interface priority (/org/service-profile/vnic-iscsi/eth-if/static-target-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a static target interface priority for an iSCSI VNIC before you use this command.

Examples This example shows how to enter a target LUN for the static target interface priority for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-target
UCS-A /org/service-profile/vnic-iscsi/eth-target # scope static-target-if 1
UCS-A /org/service-profile/vnic/iscsi/eth-target/static-target-if # enter lun
UCS-A /org/service-profile/vnic/iscsi/eth-target/static-target-if/lun #

Related Commands Command Description


set auth-name

set ipaddress

set name

set port

create lun

scope lun

show lun

delete lun

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 689
Commands
enter mac-pool

enter mac-pool
To enter a MAC pool, use the enter mac-pool command.

enter mac-pool name

Syntax Description name MAC pool name. The name is case sensitive, and can
be a maximum of 32 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter a MAC pool named mpool37:
server# scope org
server /org # enter mac-pool mpool37
server /org/mac-pool #

Related Commands Command Description


create mac-pool

delete mac-pool

scope mac-pool

show mac-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


690 OL-25718-02
Commands
enter mac-security

enter mac-security
To enter a MAC security, use the enter mac-security command.

enter mac-security

This command has no arguments or keywords.

Command Default None

Command Modes Organization network control policy (/org/nw-ctrl-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter a MAC security mode for a network control policy:
server# scope org
server /org # scope nw-ctrl-policy ncp5
server /org/nw-ctrl-policy # enter mac-security
server /org/nw-ctrl-policy/mac-security #

Related Commands Command Description


create mac-security

delete mac-security

scope mac-security

show mac-security

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 691
Commands
enter maint-policy

enter maint-policy
To create, if necessary, and to enter the maintenance policy mode, use the enter maint-policy command.

enter maint-policy name

Syntax Description name Name of the maintenance policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A maintenance policy must be created to use this command.

Examples This example shows how to enter the maintenance policy.


Switch-A # scope org
Switch-A /org # enter maint-policy Default
Switch-A /org/maint-policy #

Related Commands Command Description


create maint-policy
scope maint-policy
show maint-policy
delete maint-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


692 OL-25718-02
Commands
enter member-port

enter member-port
To enter a member port, use the enter member-port command.

enter member-port {a | b} slot-id port-id

Syntax Description a Specifies fabric A.


Note This keyword does not apply to an Ethernet
uplink fabric port channel.
b Specifies fabric B.
Note This keyword does not apply to an Ethernet
uplink fabric port channel.
slot-id Slot number. The range is from 1 to 5.

port-id Port number. The range is from 1 to 256 for VSAN under
Fibre Channel uplink and VSAN under fabric
interconnect.

Command Default None

Command Modes VLAN under Ethernet Storage (/eth-storage/vlan)


VLAN within a Fabric under Ethernet Storage (/eth-storage/fabric/vlan)
VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within a Fabric in the Ethernet uplink mode (/eth-uplink/fabric/vlan)
VSAN under Fibre Channel uplink (/fc-uplink/vsan)
VSAN under fabric interconnect (/fc-uplink/fabric/vsan)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter a member port on slot 1, port 2 for the VLAN:
server# scope eth-storage
server /eth-storage # scope vlan sample
server /eth-storage/vlan # enter member-port a 1 2
server /eth-storage/vlan/member-port #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 693
Commands
enter member-port

Examples This example shows how to enter a member port on slot 1, port 2 for the VSAN named 300 under the fabric
named a:
server# scope fc-uplink
server /fc-uplink # scope fabric a
server /fc-uplink/fabric # scope vsan 300
server /fc-uplink/fabric/vsan # enter member-port a 1 2
server /fc-uplink/fabric/vsan/member-port #

Related Commands Command Description


enter member-port (/fc-storage/vsan)

enter member-port (/port-channel)

create member-port

delete member-port

scope member-port

show member-port

Cisco UCS Manager CLI Command Reference, Release 2.0


694 OL-25718-02
Commands
enter member-port fc

enter member-port fc
To enter the Fibre Channel member port mode, use the enter member-port fc command.

enter member-port fc {a| b} slot-id port-id

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number.

port-id Port identification number.

Command Default None

Command Modes VSAN within the Fibre Channel storage mode (/fc-storage/vsan)
VSAN within a fabric in the Fibre Channel storage mode (/fc-storage/fabric/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create Fibre Channel member ports before you use this command.

Examples This example shows how to enter a Fibre Channel member port in the Fibre Channel storage mode:
UCS-A # scope fc-storage
UCS-A /fc-storage # scope vsan sample
UCS-A /fc-storage/vsan # enter member-port fc a 1 22
UCS-A /fc-storage/vsan/member-port #

Related Commands Command Description


create member-port fc

scope member-port fc

show member-port fc

delete member-port fc

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 695
Commands
enter member-port fcoe

enter member-port fcoe


To enter the Fibre Channel over Ethernet member ports command mode, use the enter member-port fcoe
command.

enter member-port fcoe {a| b} slot-id port-id

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number.

port-id Port identification number.

Command Default None

Command Modes VSAN within the Fibre Channel storage command mode (/fc-storage/vsan)
VSAN within a fabric in the Fibre Channel storage command mode (/fc-storage/fabric/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create Fibre Channel over Ethernet member ports before you use this command.

Examples This example shows how to enter the Fibre Channel over Ethernet member port command mode:
UCS-A # scope fc-storage
UCS-A /fc-storage # scope vsan sample
UCS-A /fc-storage/vsan # enter member-port fcoe a 1 223
UCS-A /fc-storage/vsan/member-port #

Related Commands Command Description


create member-port fcoe

scope member-port fcoe

show member-port fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


696 OL-25718-02
Commands
enter member-port fcoe

Command Description
delete member-port fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 697
Commands
enter member-port (/fc-storage/vsan)

enter member-port (/fc-storage/vsan)


To enter the member port mode for a VSAN for a fibre channel storage device, use the enter member-port
command.

enter member-port {fc| fcoe}{a| b} slot-id port-id

Syntax Description fc Use this option to enter the member-port mode for a Fibre Channel.

fcoe Use this option to enter the member-port mode for a Fibre Channel over Ethernet
interface.

a Specifies fabric A.

b Specifies fabric B.

slot \-id Specifies the slot ID. The value must be an integer between 1 and 5.

port-id Specifies port ID. The value must be an integer between 1 and 256.

Command Default None

Command Modes VSAN within Fibre Channel Storage (/fc-storage/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The VSAN and a member-port for the VSAN must be created to use this command.

Examples This example shows how to enter the member port mode for a fibre channel within the VSAN of a fibre
channel storage device.
Switch-A # scope fc-storage
Switch-A /fc-storage # scope vsan v300
Switch-A /fc-storage/vsan # enter member-port fc a 1 233
Switch-A /fc-storage/vsan/member-port #

Related Commands Command Description


enter member-port

Cisco UCS Manager CLI Command Reference, Release 2.0


698 OL-25718-02
Commands
enter member-port (/fc-storage/vsan)

Command Description
enter member-port (/port-channel)

show member-port

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 699
Commands
enter member-port (/port-channel)

enter member-port (/port-channel)


To enter the member-port within the port channel mode, use the enter member-port command.

enter member-port slot-id port-id

Syntax Description slot ID Slot identification number. The value must be an integer between 1 and 5.

port ID Port identification number. The value must be an integer between 1 and 40.

Command Default None

Command Modes Port channel within a fabric under Ethernet uplink (eth-uplink/fabric/port-channel)
Port channel within a fabric in the Ethernet storage mode (/eth-storage/fabric/port-channel)
Port channel within a fabric under Fibre Channel uplink (fc-uplink/fabric/port-channel)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create member ports within a port channel before you use this command.

Examples This example shows how to enter the member port for a port channel in the Fibre Channel uplink command
mode:
UCS-A # scope fc-uplink
UCS-A /fc-uplink # scope fabric a
UCS-A /fc-uplink/fabric # scope port-channel 2
UCS-A /fc-uplink/fabric/port-channel # enter member-port 1 22
UCS-A /fc-uplink/fabric/port-channel/member-port #

Related Commands Command Description


enter member-port

enter member-port (/fc-storage/vsan)

show member-port

Cisco UCS Manager CLI Command Reference, Release 2.0


700 OL-25718-02
Commands
enter member-port-channel

enter member-port-channel
To create, if necessary, and to enter the member port channel mode, use the enter member-port-channel
command.

enter member-port-channel {a| b} port channel id

Syntax Description a Specifies port A.

b Specifies port B.

port channel id Port channel ID.

Command Default None

Command Modes VSAN (/fc-uplink/vsan)


VSAN under fabric (/fc-uplink/fabric/vsan)
VLAN within Ethernet storage (/eth-storage/vlan)
VLAN within a fabric in the Ethernet storage (/eth-storage/fabric/vlan)
VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within a fabric in Ethernet uplink (/eth-uplink/fabric/vlan)

Command History Release Modification


1.4(1) This command was introduced.

2.0(1) This command was introduced in Ethernet uplink mode (/eth-uplink/vlan and
/eth-uplink/fabric/vlan).

Usage Guidelines You must create a VSAN or a VLAN and a member port channel before you use this command.

Examples This example shows how to enter the member port channel mode for a VSAN in a fabric:
Switch-A # scope fc-uplink
Switch-A /fc-uplink # scope fabric a
Switch-A /fc-uplink/fabric # scope vsan default
Switch-A /fc-uplink/fabric/vsan # enter member-port-channel a 22
Switch-A /fc-uplink/fabric/vsan/member-port-channel #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 701
Commands
enter member-port-channel

Related Commands Command Description


create member-port-channel
scope member-port-channel
show member-port-channel
delete member-port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


702 OL-25718-02
Commands
enter memory

enter memory
To enter memory, use the enter memory command.

enter memory

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter memory and set memory property values. Use the exit command to exit memory.
If you are entering memory for the first time, once you have entered you will need to execute the commit-buffer
command.

Examples This example shows how to enter memory:

switch-A# scope org org10

switch-A /org # scope server-qual sq10

switch-A /org/server-qual # enter memory

switch-A /org/server-qual/memory* # commit-buffer

switch-A /org/server-qual/memory #

Related Commands Command Description


show detail
show memory

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 703
Commands
enter mon-src

enter mon-src
To create, if necessary, and to enter the monitor source session, use the enter mon-src command.

enter mon-src session name

Syntax Description session name The name of the monitor source session.

Command Default None

Command Modes External Ethernet Interface (/chassis/server/adapter/ext-eth-if)


Fibre Channel interface within Fibre Channel storage (/fc-storage/fabric/fc)
Fibre Channel over Ethernet interface within fabric (/fc-storage/fabric/fcoe)
Interface within Ethernet uplink (/eth-uplink/fabric/interface)
Interface within Fibre Channel uplink (/fc-uplink/fabric/interface)
Port channel within Ethernet uplink (/eth-uplink/fabric/port-channel)
Port channel within Fibre Channel uplink (/fc-uplink/fabric/port-channel)
VHBA within service profile (/org/service-profile/vhba)
VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within Ethernet uplink (/eth-uplink/fabric/vlan)
VNIC within service profile (/org/service-profile/vnic)
VSAN within Fibre Channel Uplink (/fc-uplink/fabric/vsan)
VSAN within Fibre Channel uplink (/fc-uplink/vsan)
VSAN within Fibre Channel Storage (/fc-storage/fabric/vsan)
VSAN within Fibre Channel storage (/fc-storage/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the monitor source session for a VNIC within a service profile.
Switch-A # scope org
Switch-A /org # scope service-profile sample

Cisco UCS Manager CLI Command Reference, Release 2.0


704 OL-25718-02
Commands
enter mon-src

Switch-A /org/service-profile # scope vnic example


Switch-A /org/service-profile/vnic # enter mon-src testing
Switch-A /org/service-profile/vnic/mon-src #

Related Commands Command Description


set direction
create mon-src
scope mon-src
show mon-src
delete mon-src

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 705
Commands
enter network

enter network
To enter an Ethernet interface for a virtual machine NIC port profile, use the enter network command.

enter network port-profile-name

Syntax Description port-profile-name Port profile name. The name is case sensitive, and can be a maximum of
32 characters.

Command Default None

Command Modes VM management VMware profile set port profile (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter an Ethernet interface for a virtual machine port profile:
server# scope system
server /system # scope vm-mgmt
server /system/vm-mgmt # scope vmware
server /system/vm-mgmt/vmware # scope profile-set
server /system/vm-mgmt/vmware/profile-set # scope port-profile mprofile1
server /system/vm-mgmt/vmware/profile-set/port-profile # enter network
server /system/vm-mgmt/vmware/profile-set/port-profile

Related Commands Command Description


create network

delete network

scope network

show network

Cisco UCS Manager CLI Command Reference, Release 2.0


706 OL-25718-02
Commands
enter nw-ctrl-policy

enter nw-ctrl-policy
To enter a network control policy, use the enter nw-ctrl-policy command.

enter nw-ctrl-policy policy-name

Syntax Description policy-name Policy name.

Command Default None

Command Modes Organization (/org)


Ethernet storage (/eth-storage)

Command History Release Modification


1.0(2) This command was introduced.

1.4(1) This command was introduced in the Ethernet storage command mode.

Usage Guidelines You must create a network control policy before you use this command.
When you enter a network control policy, you can perform the following tasks:
• Enable CDP
• Set up an uplink fail action

Examples This example shows how to enter a network control policy:


UCS-A# scope org org10
UCS-A /org # enter nw-ctrl-policy nCP10
UCS-A /org/nw-ctrl-policy #

Related Commands Command Description


show nw-ctrl-policy

create nw-ctrl-policy

scope nw-ctrl-policy

delete nw-ctrl-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 707
Commands
enter occurrence one-time

enter occurrence one-time


To create, if necessary, and to enter the one-time occurrence mode for a schedule, use the enter occurrence
one-time command.

enter occurrence one-time name

Syntax Description name The name of the one-time occurrence instance for a schedule.

Command Default None

Command Modes Schedule (/system/schedule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A schedule and a one-time occurrence instance must be created to use this command.

Examples This example shows how to enter the one-time occurrence instance for a schedule.
Switch-A # scope system
Switch-A /system # scope schedule Sample
Switch-A /system/schedule # enter occurrence one-time Trial
Switch-A /system/schedule/one-time #

Related Commands Command Description


scope occurrence one-time
create occurrence one-time
show occurrence one-time
delete occurrence one-time

Cisco UCS Manager CLI Command Reference, Release 2.0


708 OL-25718-02
Commands
enter occurrence recurring

enter occurrence recurring


To create, if necessary, and to enter the recurring occurrence instance for a schedule, use the enter occurrence
recurring command.

enter occurrence recurring name

Syntax Description name The name of the recurring occurrence instance for the schedule.

Command Default None

Command Modes Schedule (/system/schedule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A schedule policy and a recurring occurrence instance for the schedule must be created to use this command.

Examples This example shows how to enter the recurring occurrence instance for a schedule.
Switch-A # scope system
Switch-A /system # scope schedule Sample
Switch-A /system/schedule # enter occurrence recurring Trial
Switch-A /system/schedule/recurring #

Related Commands Command Description


create occurrence recurring
scope occurrence recurring
show occurrence recurring
delete occurrence recurring

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 709
Commands
enter org

enter org
To enter an organization, use the enter org command.

enter org org-name

Syntax Description org-name Organization name. The name is case sensitive, and can be a maximum of 120
characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter an organization:


server# scope org
server /org # enter org /TestyOrg
server /org

Related Commands Command Description


create org

delete org

scope org

show org

Cisco UCS Manager CLI Command Reference, Release 2.0


710 OL-25718-02
Commands
enter pack-image

enter pack-image
To enter a firmware package image, use the enter pack-image command.

enter pack-image hw-vendor-name hw-model {adapter | board-controller | host-hba | host-hba-optionrom


| host-nic | raid-controller | server-bios} version-num

Syntax Description hw-vendor-name Hardware vendor name. The name is case sensitive, and can be a
maximum of 512 characters.

hw-model Hardware model. The name is case sensitive, and can be a maximum
of 512 characters.

adapter Specifies the adapter firmware package.

board-controller Specifies the mother board controller firmware package.

host-hba Specifies the host HBA.

host-hba-optionrom Specifies the host HBA option ROM package.

host-nic Specifies the host NIC.

raid-controller Specifies the RAID controller firmware package.

server-bios Specifies the server BIOS firmware package.

version-num Version number of the firmware being used for the package image.

Command Default None

Command Modes Host firmware package (/org/fw-host-pack)


Management firmware package (/org/fw-mgmt-pack)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines The hw-vendor-name and hw-model values are labels that help you easily identify the package image. You
can view the hardware vendor and model by using the show image detail command.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 711
Commands
enter pack-image

The firmware version must match the model numbers (PID) on the servers that are associated with this firmware
pack.

Examples This example shows how to enter a RAID controller firmware package:
server# scope org
server /org # scope fw-host-pack fhp1
server /org/fw-host-pack # enter pack-image Cisco UCS raid-controller 2009.02.09
server /org/fw-host-pack/pack-image #

Related Commands Command Description


create pack-image

delete pack-image

scope pack-image

show image detail

show pack-image

Cisco UCS Manager CLI Command Reference, Release 2.0


712 OL-25718-02
Commands
enter path

enter path
To enter a primary or secondary SAN or LAN boot image path, use the enter path command.

enter path {primary| secondary}

Syntax Description primary Specifies the primary image path.

secondary Specifies the secondary image path.

Command Default None

Command Modes SAN image under boot-definition/storage (/org/service-profile/boot-def/storage/san-image)


LAN under boot-policy (/org/boot-policy/lan)
LAN under boot-definition (/org/service-profile/boot-def/lan)
SAN image under boot-policy/storage (/org/boot-policy/storage/san-image)

Command History Release Modification


1.3.1 This command was introduced.

Examples The following example shows how to enter a secondary SAN image path for a boot policy:
server# scope org
server /org # scope boot-policy boot-policy-LAN
server /org/boot-policy # scope storage
server /org/boot-policy/storage # scope san-image primary
server /org/boot-policy/storage/san-image # enter path secondary
server /org/boot-policy/storage/san-image/path #

Related Commands Command Description


create path

delete path

set lun

set wwn

show path

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 713
Commands
enter path (iscsi)

enter path (iscsi)


To enter the iSCSI path, use the enter path command.

enter path {primary| secondary}

Syntax Description primary Specifies the primary path.

secondary Specifies the secondary path.

Command Default None

Command Modes ISCSI within a service profile (/org/service-profile/boot-def/iscsi)


ISCSI within a boot policy (/org/boot-policy/iscsi)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI path for the service profile before you use this command in the boot definition
command mode.
You must create an iSCSI path for the boot policy before you use this command in the boot policy command
mode.

Examples This example shows how to enter the iSCSI path for a boot policy:
UCS-A # scope org test
UCS-A /org # scope boot-policy trial
UCS-A /org/boot-policy # scope iscsi
UCS-A /org/boot-policy/iscsi # enter path primary
UCS-A /org/boot-policy/iscsi/path #

Related Commands Command Description


create path

set iscsivnicname

Cisco UCS Manager CLI Command Reference, Release 2.0


714 OL-25718-02
Commands
enter pin-group

enter pin-group
To enter an Ethernet (LAN) or Fibre Channel pin group, use the enter pin-group command.

enter pin-group pin-group-name

Syntax Description pin-group-name Pin group name. The name is case sensitive, and can be a maximum of
16 characters.

Command Default None

Command Modes Ethernet uplink (/eth-uplink)


Fibre Channel uplink (/fc-uplink)

Command History Release Modification


1.3.1 This command was introduced.

Examples The following example shows how to enter an Ethernet pin group named pingroup54:
server# scope eth-uplink
server /eth-uplink # enter pin-group pingroup54
server /eth-uplink/pin-group #

Related Commands Command Description


create pin-group

delete pin-group

scope pin-group

show pin-group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 715
Commands
enter policy

enter policy
To create, if necessary, and enter a policy, use the enter policy command.

callhome mode
enter policy event

flow-control mode
enter policy name

Syntax Description event Select a predefined fault or system event type. See Usage Guidelines for event
options.

name Policy name. The name can be from 1 to 16 characters.

Command Default None

Command Modes Callhome (/monitoring/callhome)


Flow control (/eth-uplink/flow-control)

Command History Release Modification


1.0(1) This command was introduced.

1.1(1) This command was modified to add additional event types for Call Home.

Usage Guidelines Use this command to enter a policy in either organization callhome or organization flow control mode. If the
policy does not exist, it will first be created.
In Call Home configuration, use this command to enter an instance of a policy for a predefined type of fault
or system event. The following list shows the available keywords for Call Home event types:
• association-failed
• chassis-seeprom-error
• configuration-failure
• connectivity-problem
• election-failure
• equipment-inaccessible

Cisco UCS Manager CLI Command Reference, Release 2.0


716 OL-25718-02
Commands
enter policy

• equipment-inoperable
• equipment-problem
• fru-problem
• identity-unestablishable
• link-down
• management-services-failure
• management-services-unresponsive
• power-problem
• thermal-problem
• unspecified
• version-incompatible
• voltage-problem

In Flow Control configuration, use this command to enter a named policy.

Examples This example shows how to enter and enable a Call Home policy instance for link-down events:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # enter policy link-down
switch-A /monitoring/callhome/policy # set admin-state enabled
switch-A /monitoring/callhome/policy* # commit-buffer
switch-A /monitoring/callhome/policy #
This example shows how to enter a named policy for flow control:
switch-A # scope eth-uplink
switch-A /eth-uplink # scope flow-control
switch-A /eth-uplink/flow-control # enter policy policy1
switch-A /eth-uplink/flow-control #

Related Commands Command Description


create policy
show policy
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 717
Commands
enter pooled-ip-params

enter pooled-ip-params
To enter the configured pool of initiator IP parameters, use the enter pooled-ip-params command.

enter pooled-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface within the iSCSI VNIC mode (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must configure a pool of initiator IP parameters before you use this command.

Examples This example shows how to enter the configured pool of initiator IP parameters:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # enter pooled-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/pooled-ip-params #

Related Commands Command Description


create pooled-ip-params

scope pooled-ip-params

show pooled-ip-params

delete pooled-ip-params

create ip-if

Cisco UCS Manager CLI Command Reference, Release 2.0


718 OL-25718-02
Commands
enter pooling-policy

enter pooling-policy
To enter a server pooling policy, use the enter pooling-policy command.

enter pooling-policy policy-name

Syntax Description policy-name Policy name. The name is case sensitive, and can be a maximum of 16
characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3.1 This command was introduced.

Examples The following example shows how to enter a server pooling policy named ServPoolPolicy1:
server# scope org
server /org # enter pooling-policy ServPoolPolicy1
server /org/pooling-policy #

Related Commands Command Description


create pooling-policy

delete pooling-policy

scope pooling-policy

show pooling-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 719
Commands
enter port-channel

enter port-channel
To enter a port channel, use the enter port-channel command.

enter port-channel port-channel-D

Syntax Description port-channel-ID Port channel number. The range is from 1 to 256.

Command Default None

Command Modes Fabric interconnect mode within the Ethernet Uplink mode (/eth-uplink/fabric)
Fabric interconnect mode within the Ethernet storage mode (/eth-storage/fabric)
Fabric interconnect mode within the Fibre Channel Uplink mode (/fc-uplink/fabric)

Command History Release Modification


1.3.1 This command was introduced in the Fabric interconnect mode within the Ethernet
Uplink mode (/eth-uplink/fabric).

1.4(1) This command was introduced in the Fabric interconnect mode within the Fibre
Channel Uplink mode (/fc-uplink/fabric) and the Ethernet storage mode
(/eth-storage/fabric).

Examples This example shows how to enter port channel 20 in the fabric named a:
UCS-A # scope eth-uplink
UCS-A /eth-uplink # scope fabric a
UCS-A /eth-uplink/fabric # enter port-channel 20
UCS-A /eth-uplink/fabric/port-channel #

Related Commands Command Description


create port-channel

delete port-channel

scope port-channel

show port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


720 OL-25718-02
Commands
enter port-profile (profile-set)

enter port-profile (profile-set)


To enter a port profile, use the enter port-profile command in profile-set mode.

enter port-profile profile-name

Syntax Description profile-name The name of the profile.

Command Default None

Command Modes Profile set (/system/vm-mgmt/vmware/profile-set)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Port profiles

Examples This example shows how to create a port profile:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt # scope profile-set
switch-A /system/vm-mgmt/vmware/profile-set # create port-profile pp100
switch-A /system/vm-mgmt/vmware/profile-set* # commit-buffer
switch-A /system/vm-mgmt/vmware/profile-set #

Related Commands Command Description


show port profile
show profile-set

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 721
Commands
enter power-control-policy

enter power-control-policy
To create, if necessary, and to enter the power policy mode, use the enter power-control-policy command.

enter power-control-policy name

Syntax Description name The name of the power control policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A power control policy must be created to use this command.

Examples This example shows how to enter the power control policy mode.
Switch-A # scope org
Switch-A /org # enter power-control-policy Sample
Switch-A /org/power-control-policy #

Related Commands Command Description


create power-control-policy
scope power-control-policy
show power-control-policy
set power-control-policy
set priority

Cisco UCS Manager CLI Command Reference, Release 2.0


722 OL-25718-02
Commands
enter power-group

enter power-group
To create, if necessary, and to enter the power group mode, use the enter power-group command.

enter power-group name

Syntax Description name The name of the power group.

Command Default None

Command Modes Power Capping Management (/power-cap-mgmt)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A power group must be created to use this command.

Examples This example shows how to enter the power group mode.
Switch-A # scope power-cap-mgmt
Switch-A /power-cap-mgmt # enter power-group Sample
Switch-A /power-cap-mgmt/power-group #

Related Commands Command Description


create power-group
scope power-group
show power-group
create chassis

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 723
Commands
enter processor

enter processor
To enter the processor, use the enter processor command.

enter processor

This command has no arguments or keywords.

Command Default None

Command Modes Server qualification (/org/server-qual)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter the processor and set processor property values. Use the exit command to exit the
processor.
If you are entering memory for the first time, once you have entered you will need to execute the commit-buffer
command.

Examples This example shows how to enter the processor:

switch-A# scope org org10

switch-A /org # scope server-qual sq10

switch-A /org/server-qual # enter processor

switch-A /org/server-qual/processor* # commit-buffer

switch-A /org/server-qual/processor #

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


724 OL-25718-02
Commands
enter qos-policy

enter qos-policy
To enter qos-policy mode, use the enter qos-policy command.

enter qos-policy policy-name

Syntax Description policy-name The name of the QoS policy.

Command Default None

Command Modes QoS policy (/org/qos-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use qos-policy mode to perform the following tasks:


• Create and delete an egress QoS policy
• Show the egress policy

Examples This example shows how to enter qos-policy mode:


switch-A# scope org org10
switch-A /org # scope qos-policy qp10
switch-A /org/qos-policy #

Related Commands Command Description


show egress-policy
show qos-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 725
Commands
enter rack

enter rack
To enter the rack qualifier, use the enter rack command.

enter rack minimum-slot-id maximum-slot-id

Syntax Description minimum-slot-id Minimum slot ID of the rack qualifier. It is the same ID you specified when
you created the rack qualifier.

maximum-slot-id Maximum slot ID of the rack qualifier. It is the same ID you specified when
you created the rack qualifier.

Command Default None

Command Modes Server Pool Policy Qualification (/org/server-qual)

Command History Release Modification


1.4(1) This command has been introduced.

Usage Guidelines A server pool policy qualification and a rack qualifier must be created to use this command.

Examples This example shows how to enter the rack qualifier.


UCS-A # scope org test
UCS-A /org # scope server-qual sample_policy
UCS-A /org/server-qual # enter rack 1 25
UCS-A /org/server-qual/rack #

Related Commands Command Description


create rack

scope rack

show rack

delete rack

Cisco UCS Manager CLI Command Reference, Release 2.0


726 OL-25718-02
Commands
enter scheduler

enter scheduler
To create, if necessary, and to enter the scheduler mode, use the enter scheduler command.

enter scheduler name

Syntax Description name The name of the scheduler.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A scheduler must be created to use this command.

Examples This example shows how to enter the scheduler mode.


Switch-A # scope system
Switch-A /system # enter scheduler Default
Switch-A /system/scheduler #

Related Commands Command Description


create scheduler
scope scheduler
set scheduler
show scheduler
delete scheduler
create maint-window

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 727
Commands
enter server

enter server
To enter the RADIUS server, use the enter server command.

enter server name

Syntax Description name The name of the server.

Command Default None

Command Modes RADIUS (/security/radius)

Command History Release Modification


1.0 This command was introduced.

Usage Guidelines The RADIUS server must be created to use this command.

Examples The following example shows how to enter the RADIUS server mode.
Switch-A # scope security
Switch-A /security # scope radius
Switch-A /security/radius # enter server example
Switch-A /security/radius/server #

Related Commands Command Description


set authport
set key
set order
set retries
set timeout

Cisco UCS Manager CLI Command Reference, Release 2.0


728 OL-25718-02
Commands
enter server-ref

enter server-ref
To create, if necessary, and to enter the server reference mode, use the enter server-ref command.

enter server-ref name

Syntax Description name The name of the server. You can enter either the name of the server or the IP address.

Command Default None

Command Modes Authentication server group under LDAP (/security/ldap/auth-server-group)


Authentication server group under RADIUS (/security/radius/auth-server-group)
Authentication server group under TACACS (/security/tacacs/auth-server-group)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication server group must be created, and a server reference must be added to the authentication
server group to use this command.

Examples This example shows how to enter the server reference mode for an authentication server group within LDAP.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope auth-server-group Default
Switch-A /security/ldap/auth-server-group # enter server-ref sample_server
Switch-A /security/ldap/auth-server-group/server-ref #

Related Commands Command Description


create server-ref
scope server-ref
show server-ref
delete server-ref

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 729
Commands
enter static-ip-params

enter static-ip-params
To enter the static initiator of IP parameters, use the enter static-ip-params command.

enter static-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface of the iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a static initiator of IP parameters before you use this command.

Examples This example shows how to enter the static initiator of IP parameters:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # enter static-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/static-ip-params #

Related Commands Command Description


set addr

set default-gw

set primary-dns

set secondary-dns

set subnet

create static-ip-params

scope static-ip-params

show static-ip-params

Cisco UCS Manager CLI Command Reference, Release 2.0


730 OL-25718-02
Commands
enter static-ip-params

Command Description
delete static-ip-params

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 731
Commands
enter static-target-if

enter static-target-if
To enter the configured static target interface for an iSCSI VNIC, use the enter static-target-if command.

enter static-target-if static target priority

Syntax Description static target priority Static target priority that you had specified when you created the static
target interface.

Command Default None

Command Modes Ethernet interface of an iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must configure a static target interface for an iSCSI VNIC before you use this command.

Examples This example shows how to enter the static target interface mode for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # enter static-target-if 1
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if #

Related Commands Command Description


create lun

scope static-target-if

show static-target-if

delete static-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


732 OL-25718-02
Commands
enter storage

enter storage
To enter storage, use the enter storage command.

enter storage

This command has no arguments or keywords.

Command Default None

Command Modes Boot policy (/org/boot-policy)


Server qualification (/org/server-qual)
Boot definition (/org/service-profile/boot-def)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter storage and set storage property values. Use the exit command to exit storage.
If you are entering storage for the first time, once you have entered you will need to execute the commit-buffer
command.

Examples The following example shows how to enter storage:

switch-A# scope org org10

switch-A /org # scope server-qual sq10

switch-A /org/server-qual # enter storage

switch-A /org/server-qual/storage* # commit-buffer

switch-A /org/server-qual/storage #

Related Commands Command Description


show detail
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 733
Commands
enter threshold-value

enter threshold-value
To enter a threshold value for a property, use the enter threshold-value command.

enter threshold-value {above-normal | below-normal} {cleared | condition | critical | info | major | minor
| warning}

Syntax Description above-normal Sets the value to above normal.

below-normal Sets the value to below normal.

cleared Sets the threshold value to cleared.

condition Sets the threshold value to condition.

critical Sets the threshold value to critical.

info Sets the threshold value to info.

major Sets the threshold value to major.

minor Sets the threshold value to minor.

warning Sets the threshold value to warning.

Command Default None

Command Modes Ethernet uplink (/eth-uplink/stats-threshold-policy/class/property)


Fibre channel (/fc-uplink/stats-threshold-policy/class/property)
Ethernet server (/eth-server/stats-threshold-policy/class/property)
Organization (/org/stats-threshold-policy/class/property)

Command History Release Modification


1.0.1 This command was introduced.

Examples The following example shows how to enter the threshold value above-normal critical in property packets-rx-delta
mode:
switch-A#scope org org100
switch-A /org # scope stats-threshold-policy stp100

Cisco UCS Manager CLI Command Reference, Release 2.0


734 OL-25718-02
Commands
enter threshold-value

switch-A /org/stats-threshold-policy # scope class vnic-stats


switch-A /org/stats-threshold-policy/class # scope property packets-rx-delta
switch-A /org/stats-threshold-policy/class/property # enter threshold-value above-normal
critical
switch-A /org/stats-threshold-policy/class/property/threshold-value* # commit-buffer
switch-A /org/stats-threshold-policy/class/property/threshold-value #

Related Commands Command Description


show property
show threshold-value

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 735
Commands
enter vcenter

enter vcenter
To enter a VCenter, use the enter vcenter command in vmware mode.

enter vcenter vcenter-name

Syntax Description vcenter-name The name of the VCenter.

Command Default None

Command Modes VCenter (/system/vm-mgmt/vmware)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use vcenter mode to perform the following tasks:


• Create and delete data centers and folders
• Show data center, event, finite state machine, and folder information

Examples This example shows how to enter a VCenter:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # enter vcenter vc10
switch-A /system/vm-mgmt/vmware/vcenter #

Related Commands Command Description


show data-center
show vcenter

Cisco UCS Manager CLI Command Reference, Release 2.0


736 OL-25718-02
Commands
enter vcon

enter vcon
To enter a vCon (virtual network interface connection), use the enter vcon command.

enter vcon {1 | 2}

Syntax Description 1 Specifies virtual network interface connection 1.

2 Specifies virtual network interface connection 2.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to enter a vCon:


switch-A# scope org org100
switch-A /org # scope service-profile sp100
switch-A /org/service-profile # enter vcon 1
switch-A /org/service-profile* # commit-buffer
switch-A /org/service-profile #

Related Commands Command Description


show service-profile
show vcon

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 737
Commands
enter vcon-policy

enter vcon-policy
To enter vcon-policy mode, use the enter vcon-policy command.

enter vcon-policy policy-name

Syntax Description policy-name The name of the policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use vcon-policy mode to perform the following tasks:


• Set vCons and vCon descriptions
• Show vCon information

Examples This example shows how to enter vcon-policy mode:


switch-A # scope org org100
switch-A /org # enter vcon-policy vcp100
switch-A /org/vcon-policy #

Related Commands Command Description


show vcon
show vcon-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


738 OL-25718-02
Commands
enter vlan

enter vlan
To create a VLAN, if necessary, and enter VLAN configuration mode, use the enter vlan command.

enter vlan name id

Syntax Description name VLAN name. The name can contain up to 32 characters.

id VLAN identification number. The range of valid values is 1 to 3967 and 4049 to
4093.

Command Default None

Command Modes Ethernet uplink (/eth-uplink)


Fabric within the Ethernet Uplink mode (/eth-uplink/fabric)
Fabric within the Ethernet Storage mode (/eth-storage/fabric)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was introduced for a Fabric within the Ethernet Storage mode
(/eth-storage/fabric). In addition, the following changes were introduced:
• Maximum number of characters for the VLAN name has been extended from 16
to 32.
• The range of valid values was modified from 4048 - 4093 to 4049 - 4093.

Usage Guidelines Use this command to enter configuration mode for a VLAN with the specified name and identifier number.
If the VLAN does not exist, it will be created.

Examples This example shows how to enter a VLAN:


switch-A# scope eth-uplink
switch-A /eth-uplink # enter vlan vlan1 10
switch-A /eth-uplink/vlan* # commit-buffer
switch-A /eth-uplink/vlan #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 739
Commands
enter vlan

Related Commands Command Description


enter vlan (port-profile)

show interface
show vlan

Cisco UCS Manager CLI Command Reference, Release 2.0


740 OL-25718-02
Commands
enter vlan (port-profile)

enter vlan (port-profile)


To create a VLAN, if necessary, and enter VLAN configuration mode, use the enter vlan command.

enter vlan name

Syntax Description name VLAN name. The name can contain up to 32 characters.

Command Default None

Command Modes Port profile (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.1(1) This command was introduced.

1.4(1) The maximum number of characters for the VLAN name has been modified
from 16 to 32.

Usage Guidelines Use this command to enter configuration mode for a VLAN with the specified name and identifier number.
If the VLAN does not exist, it will be created.

Examples This example shows how to enter a VLAN for a port profile:
switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope profile-set
switch-A /system/vm-mgmt/vmware/profile-set # scope port-profile pp100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile # enter vlan v100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile/vlan* # commit-buffer
switch-A /system/vm-mgmt/vmware/profile-set/port-profile/vlan #

Related Commands Command Description


enter vlan

show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 741
Commands
enter vnic-iscsi

enter vnic-iscsi
To enter the iSCSI virtual network interface card mode for a service profile, use the enter vnic-iscsi command.

enter vnic-iscsi name

Syntax Description name Name of the iSCSI VNIC. It is the name that you provided when you created the
iSCSI VNIC.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a service profile and an iSCSI VNIC for the service profile before you use this command.

Examples This example shows how to enter the iSCSI VNIC mode for a service profile:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # enter vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi #

Related Commands Command Description


create vnic-iscsi

scope vnic-iscsi

show vnic-iscsi

delete vnic-iscsi

Cisco UCS Manager CLI Command Reference, Release 2.0


742 OL-25718-02
Commands
enter vsan

enter vsan
To create a VSAN, if necessary, and enter the VSAN configuration mode, use the enter vsan command.

enter vsan name id fcoe-vlan

Syntax Description name The name of the VLAN.

Id The VSAN identification number.It must be a value between 1 and 4093.

fcoe-vlan id The Fibre Channel over Ethernet VLAN ID.

Command Default None

Command Modes Fibre Channel Uplink (/fc-uplink)


Fabric within the Fibre Channel Storage (/fc-storage/fabric)

Command History Release Modification


1.0(1) This command was introduced in the following command modes:
Fibre Channel Uplink (/fc-uplink)
Switch within a Fibre Channel Uplink (/fc-uplink/switch)

1.4(1) This command was introduced for a fabric within the Fibre Channel Storage mode
(/fc-storage/fabric). In addition, the switch mode within the Fibre Channel uplink mode
has been obsoleted.

Usage Guidelines While using this command for a fabric within the Fibre Channel Storage command mode, you need to specify
only the name of the VSAN.

Examples This example shows how to enter the VSAN mode in the Fibre Channel Uplink command mode:
Switch-A # scope fc-uplink
Switch-A /fc-uplink # enter vsan VSAN1 1 33
Switch-A /fc-uplink/vsan #

Related Commands Command Description


create vsan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 743
Commands
enter vsan

Command Description
show vsan

scope vsan

delete vsan

Cisco UCS Manager CLI Command Reference, Release 2.0


744 OL-25718-02
Commands
erase configuration

erase configuration
To erase the UCS configuration, use the erase configuration command.

erase configuration

This command has no arguments or keywords.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to erase the UCS configuration.

Examples This example shows how to erase the UCS configuration:


switch-A# connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html
switch-A(local-mgmt)# erase configuration
All UCS configurations will be erased and system will reboot. Are you sure? (yes/no): no
switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 745
Commands
erase-log-config

erase-log-config
To erase the UCS management logging configuration file, use the erase-log-config command.

erase-log-config

This command has no arguments or keywords.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to erase the UCS management logging configuration file.

Examples This example shows how to erase the UCS management logging configuration file:
switch-A# connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html
switch-A(local-mgmt)# erase-log-config
switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


746 OL-25718-02
Commands
install file

install file
To install a license file, use the install file command.

install file name

Syntax Description name The name of the license file.

Command Default None

Command Modes License (/license)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An install file must be created and available to use this command.

Examples This example shows how to install a license file.


Switch-A # scope license
Switch-A /license # install file sample-file
Switch-A /license* # commit-buffer
Switch-A /license #

Related Commands Command Description


scope license
clear file

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 747
Commands
ls

ls
To list the contents of a directory, use the ls command in local management command mode.

ls [ path ]

Syntax Description path Absolute or relative path of the directory.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to list the contents of a directory in local management command mode. If no path is
specified, the current working directory is listed.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.
This command operates on either the workspace (FLASH) or volatile (RAM) file system. To specify the file
system, include the workspace: or volatile: keyword in the path. If the file system is not specified, the
current working file system is assumed.

Examples This example shows how to list the contents of a directory named temp in the volatile file system:
switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# ls volatile:/temp
40 Dec 29 15:28:58 2009 src/

Usage for volatile://sup-local


0 bytes used

Cisco UCS Manager CLI Command Reference, Release 2.0


748 OL-25718-02
Commands
ls

62914560 bytes free


62914560 bytes total

switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 749
Commands
mkdir

mkdir
To create a directory, use the mkdir command in local management command mode.

mkdir path

Syntax Description path Absolute or relative path, including the name of the new directory.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create a directory in local management command mode.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.
This command operates on either the workspace (FLASH) or volatile (RAM) file system. To specify the file
system, include the workspace: or volatile: keyword in the path. If the file system is not specified, the
current working file system is assumed.

Examples This example shows how to create a directory named temp in the volatile file system:
switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# mkdir volatile:/temp


switch-A(local-mgmt)#

Cisco UCS Manager CLI Command Reference, Release 2.0


750 OL-25718-02
Commands
mkdir

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 751
Commands
move

move
To move a file from one directory to another, use the move command in local management command mode.

move [ from-filesystem: ][ from-path ]filename [ to-filesystem: ]to-path[ dest-filename ]

Syntax Description from-filesystem: File system containing the file to be moved. See the Usage
Guidelines for valid values.

from-path Absolute or relative path of the file to be moved.

filename The name of the source file to be moved.

to-filesystem: File system to contain the moved file. See the Usage Guidelines
for valid values.

to-path Absolute or relative path to the moved file.

dest-filename (Optional) The new name for the moved file.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command in local management command mode to copy a file to a new location and to delete the file
in its original location.
If a dest-filename is specified, the moved file is renamed at the destination location.
If no file system is specified, the current working file system is assumed. If no path is specified, the current
working directory is assumed.
To specify the file system location, use the appropriate syntax from the following table:

ftp:[//[username@]server]
scp:[//[username@]server]
sftp:[//[username@]server]
tftp:[//server[:port]]

Cisco UCS Manager CLI Command Reference, Release 2.0


752 OL-25718-02
Commands
move

volatile:[/path]
workspace:

Either the source or destination file system must be local; you cannot move a file from one remote file system
to another.
If a remote protocol is specified with no server name, you are prompted to enter the server name.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.
This command operates on either the workspace (FLASH) or volatile (RAM) file system. To specify the file
system, include the workspace: or volatile: keyword in the path. If the file system is not specified, the
current working file system is assumed.
You can use the mv command as an alias for this command.

Examples This example shows how to move a file from the current working directory to a directory in the volatile file
system:
switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# copy abcdef.bin volatile:/temp


switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 753
Commands
ping

ping
To diagnose basic network connectivity, use the ping command in local management command mode.

ping {host-ip-address| host-name} [count count] [packet-size packet-size] [interval interval] [timeout
timeout]

Syntax Description host-ip-address IP address of the target host.

host-name Name of the target host. The name may include up to


512 characters.

count count Specifies the number of ping packets that will be sent.
The range is 1 to 2147483647 packets.

packet-size packet-size Specifies the number of data bytes to be added to the


ping packet. The range is 1 to 65468 bytes; the default
is 56 bytes, resulting in a 64 byte packet when added
to the 8 byte ICMP header.

interval interval Specifies the time in seconds between sending ping


packets. The range is 1 to 60 seconds; the default is
1 second.

timeout timeout Specifies the maximum time to continue sending


packets when no response packets are received. The
range is 1 to 60 seconds.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to send ICMP echo request packets to a host.
The ping command is on the local management port command line. Use the connect local-mgmt command
to connect to that command line.

Cisco UCS Manager CLI Command Reference, Release 2.0


754 OL-25718-02
Commands
ping

Examples This example shows how to send four ping packets of size 100 bytes at an interval of 10 seconds:
switch-A# connect local-mgmt
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# ping 192.0.20.12 count 4 packet-size 100 interval 10


PING 192.0.20.12 (192.0.20.12) 100(128) bytes of data.
108 bytes from 192.0.20.12: icmp_seq=1 ttl=64 time=0.61 ms
108 bytes from 192.0.20.12: icmp_seq=2 ttl=64 time=0.50 ms
108 bytes from 192.0.20.12: icmp_seq=3 ttl=64 time=0.58 ms
108 bytes from 192.0.20.12: icmp_seq=4 ttl=64 time=0.44 ms

--- 192.0.20.12 ping statistics ---


4 packets transmitted, 4 received, 0% packet loss, time 30000ms
rtt min/avg/max/mdev = 0.44/0.53/0.61/0.08 ms
switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 755
Commands
power

power
To power up or down, use the power command.

power {up| down}

Syntax Description up Specifies power up.

down Specifies power down.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to power up:

switch-A# scope org org10a

switch-A /org # scope service-profile servProf10a

switch-A /org/service-profile # power down

Cisco UCS Manager CLI Command Reference, Release 2.0


756 OL-25718-02
Commands
power down soft-followed-by-hard

power down soft-followed-by-hard


To initiate a soft power shut down followed by a hard shut down for physical managed objects, use the power
down soft-followed-by-hard command.

power down soft-followed-by-hard

This command has no arguments or keywords.

Command Default None

Command Modes Service Profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A service profile for an organization must be created to use this command.

Examples This example shows how to initiate a soft power shut down followed by a hard shut down.
Switch-A # scope org Sample
Switch-A /org # scope service-profile Testing
Switch-A /org/service-profile # power down soft-followed-by-hard
Switch-A /org/service-profile* # commit-buffer
Switch-A /org/service-profile #

Related Commands Command Description


power

power down soft-shut-down

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 757
Commands
power down soft-shut-down

power down soft-shut-down


To initiate a soft power shut down, use the power down soft-shut-down command.

power down soft-shut-down

This command has no arguments of keywords.

Command Default None

Command Modes Service Profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A service profile for an organization must be created to use this command.

Examples This example shows how to initiate a soft shut down for a service profile.
Switch-A # scope org Sample
Switch-A /org # scope service-profile Testing
Switch-A /org/service-profile # power down soft-shut-down
Switch-A /org/service-profile* # commit-buffer
Switch-A /org/service-profile #

Related Commands Command Description


power

power down soft-followed-by-hard

Cisco UCS Manager CLI Command Reference, Release 2.0


758 OL-25718-02
Commands
pwd

pwd
To view the current working directory, use the pwd command in local management command mode.

pwd

This command has no arguments or keywords.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to view the current working directory in local management command mode.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.

Examples This example shows how to view the current working directory:
switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# cd temp
switch-A(local-mgmt)# pwd
workspace:temp
switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 759
Commands
reboot

reboot
To reboot, use the reboot command.

reboot

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to reboot:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # reboot

Cisco UCS Manager CLI Command Reference, Release 2.0


760 OL-25718-02
Commands
recommission chassis

recommission chassis
To recommission a chassis, use the recommission chassis command.

recommission chassis vendor model serial-num optional-chassis-number

Syntax Description vendor Vendor.

model Model.

serial-num Serial number.

optional-chassis-number The number of the chassis. Use this option only if you want to
renumber the chassis.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

1.3(1) In this release, the option optional-chassis-number was introduced that allows
you to provide a new chassis number. If a new number is not provided, then the
old chassis number is used.

Examples This example shows how to recommission a chassis and renumber it:

switch-A# recommission chassis "Cisco Systems Inc" "Cisco UCS 5108" FOX1252GNNN 6

switch-A* # commit-buffer

switch-A #

Related Commands Command Description


show chassis
show slot

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 761
Commands
recommission fex

recommission fex
To recommission a Fabric extender module, use the recommission fex command.

recommission fex vendor model serial-num

Syntax Description vendor The vendor from whom the Fabric extender module has been purchased
from.

model The model number of the Fabric extender module.

serial-num The serial number of the Fabric extender module.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to recommission a Fabric extender module.


Switch-A # scope org
Switch-A /org # recommission Cisco server AGD113921ZR
Switch-A /org* # commit-buffer

Related Commands Command Description


remove fex
decommission fex

Cisco UCS Manager CLI Command Reference, Release 2.0


762 OL-25718-02
Commands
recommission server

recommission server
To recommission a server, use the recommission server command.

recommission server vendor model serial-num

Syntax Description vendor The name of the company that you purchased the server from.

model The model number of the server.

serial-num The serial number of the server.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to recommission a server.


Switch-A # scope org
Switch-A /org # recommission server Cisco 200 ABCD12345
Switch-A /org* # commit-buffer

Related Commands Command Description


decommission server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 763
Commands
recover-bios

recover-bios
To recover a corrupt BIOS, use the recover-bios command.

recover-bios version [ignorecompcheck]

Syntax Description version Specifies the BIOS version. Enter up to 512 characters with no spaces.

ignorecompcheck Specifies that the compatibility check will not be performed.


Note We recommend that you use this option only when explicitly directed
to do so by a technical support representative.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to recover a corrupt BIOS image. This procedure is not part of the normal maintenance of
a server. After you recover the BIOS, the server boots with the running version of the firmware for that server.

Note Remove all attached or mapped USB storage from a server before you attempt to recover the corrupt BIOS
on that server. If an external USB drive is attached or mapped from vMedia to the server, BIOS recovery
fails.

Examples This example shows how to recover a corrupt BIOS image:


switch-A# scope server 1/2
switch-A /chassis/server # recover-bios S5500.86B.01.00.0036-191.061320091126
switch-A /chassis/server* # commit-buffer
switch-A /chassis/server #

Related Commands Command Description


show bios

Cisco UCS Manager CLI Command Reference, Release 2.0


764 OL-25718-02
Commands
remove alertgroups

remove alertgroups
To remove specific alert groups from a Call Home profile, use the remove alertgroups command.

remove alertgroups [ciscotac] [diagnostic] [environmental] [inventory] [license] [lifecycle] [linecard]


[supervisor] [syslogport] [system] [test]+

Syntax Description ciscotac Specifies the Cisco Technical Assistance Center (TAC) alert group.

diagnostic Specifies the diagnostic alert group.

environmental Specifies the environmental alert group.

inventory Specifies the inventory alert group.

license Specifies the license alert group.

lifecycle Specifies the lifecycle alert group.

linecard Specifies the line card alert group.

supervisor Specifies the supervisor alert group.

syslogport Specifies the syslog port alert group.

system Specifies the system alert group.

test Specifies the test alert group.

Command Default None

Command Modes Call Home profile (/monitoring/callhome/profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to remove specific predefined Call Home alert groups from an existing alert group list
within a Call Home profile.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 765
Commands
remove alertgroups

Examples This example shows how to remove diagnostic and license alert groups from an existing Call Home profile:

switch-A# scope monitoring

switch-A /monitoring # scope callhome

switch-A /monitoring/callhome # scope profile profileOne

switch-A /monitoring/callhome/profile # remove alertgroups diagnostic license

switch-A /monitoring/callhome/profile* # commit-buffer

switch-A /monitoring/callhome/profile #

Related Commands Command Description


add alertgroups
set alertgroups

Cisco UCS Manager CLI Command Reference, Release 2.0


766 OL-25718-02
Commands
remove backup action

remove backup action


To remove an action or actions that will trigger a backup of the system event log, use the remove backup
action command.

remove backup action [log-full] [none] [on-change-of-association] [on-clear] [timer]

Syntax Description log-full Specifies that the log is backed up when it is full.

none Specifies no action.

on-change-of-association Specifies that the log is backed up when the server changes associations.

on-clear Specifies that the log is backed up when it is cleared.

timer Specifies that the log is backed up at an interval.

Command Default None

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to remove an action or actions that will trigger a backup of the system event log. Other
previously configured actions are retained.

Examples This example shows how to remove the action to trigger a backup of the system event log when the log is
full:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # remove backup action log-full
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Related Commands Command Description


add backup action
set backup action

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 767
Commands
remove backup action

Command Description
show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


768 OL-25718-02
Commands
remove fex

remove fex
To remove a Fabric extender module from the system, use the remove fex command.

remove fex id

Syntax Description id The ID of the Fabric extender module.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to delete a Fabric extender module from the system.
Switch-A # scope org
Switch-A /org # remove fex 2
Switch-A /org* # commit-buffer
Switch-A /org #

Related Commands Command Description


decommission fex

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 769
Commands
remove privilege

remove privilege
To remove privileges, use the remove privilege command.

remove privilege {aaa| admin| ext-lan-config| ext-lan-policy| ext-lan-qos| ext-lan-security| ext-san-config|


ext-san-policy| ext-san-qos| ext-san-security| fault| service-profile-config| service-profile-config-policy|
service-profile-network| service-profile-network-policy| service-profile-qos| service-profile-qos-policy|
service-profile-security| service-profile-security-policy| service-profile-server| service-profile-server-policy|
service-profile-storage| service-profile-storage-policy| operations| server-equipment| server-maintenance|
server-policy| server-security| pod-config| pod-policy| pod-qos| pod-security| read-only}+

Syntax Description aaa Specifies AAA privileges.

admin Specifies admin privileges.

ext-lan-config Specifies external LAN configuration priveleges.

ext-lan-policy Specifies external LAN policy privileges.

ext-lan-qos Specifies external LAN QoS privileges.

ext-lan-security Specifies external LAN security privileges.

ext-san-config Specifies external SAN configuration privileges.

ext-san-policy Specifies external SAN policy privileges.

ext-san-qos Specifies external SAN QoS privileges.

ext-san-security Specifies external SAN security privileges.

fault Specifies fault privileges.

service-profile-config Specifies service profile configuration privileges.

service-profile-config-policy Specifies service profile configuration policy privileges.

service-profile-network Specifies service profile network privileges.

service-profile-network-policy Specifies service profile network policy privileges.

service-profile-qos Specifies service profile QoS privileges.

service-profile-qos-policy Specifies service profile QoS policy privileges.

service-profile-security Specifies service profile security privileges.

service-profile-security-policy Specifies service profile security policy privileges.

Cisco UCS Manager CLI Command Reference, Release 2.0


770 OL-25718-02
Commands
remove privilege

service-profile-server Specifies service profile server privileges.

service-profile-server-policy Specifies service profile server policy privileges.

service-profile-storage Specifies service profile storage privileges.

service-profile-storage-policy Specifies service profile storage policy privileges.

operations Specifies operations privileges.

server-equipment Specifies server equipment privileges.

server-maintenance Specifies server maintenance privileges.

server-policy Specifies server policy privileges.

server-security Specifies server security privileges.

pod-config Specifies pod configuration privileges.

pod-policy Specifies pod policy privileges.

pod-qos Specifies pod QoS privileges.

pod-security Specifies pod security privileges.

read-only Specifies read-only privileges.

Command Default None

Command Modes Role (/security/role)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to remove privileges:

switch-A#scope security

switch-A /security # scope role serverAdmin

switch-A /security/role # remove privilege server-policy

switch-A /security/role* # commit-buffer

switch-A /security/role #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 771
Commands
remove privilege

Related Commands Command Description


show local-user
show role

Cisco UCS Manager CLI Command Reference, Release 2.0


772 OL-25718-02
Commands
remove server

remove server
To remove a server, use the remove server command.

remove server {ID | chassis -d / blade-id}

Syntax Description ID Slot number. The range of valid values is 1 to 255.

chassis-id / blade-id The identification numbers of the chassis and the blade for the server. It must
entered in the n/n format.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced with only the slot option.

1.4(1) The command options were modified.

Usage Guidelines When using this command in Chassis command mode, you need to specify only the identification number of
the slot.

Examples This example shows how to remove a server:

switch-A# remove server 1/1

switch-A* # commit-buffer

switch-A #

Related Commands Command Description


show iom
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 773
Commands
reset

reset
To reset a managed object, use the reset command.

mgmt-logging, bmc, iom mode


reset

server, service profile mode


reset {hard-reset-immediate | hard-reset-wait}

Syntax Description hard-reset-immediate Specifies that the server be hard reset immediately.

hard-reset-wait Specifies that a hard reset be scheduled after all pending management
operations have completed.

Command Default None

Command Modes Logcontrol (/monitoring/sysdebug/mgmt-logging)


BMC (/chassis/server/cimc)
Server (/chassis/server)
Service profile (/org/service-profile)
IO module (/chassis/iom)

Command History Release Modification


1.0(1) This command was introduced.

Examples The following example shows how to reset an I/O module A in iom mode:

switch-A# scope chassis 1

switch-A /chassis # scope iom a

switch-A /chassis/iom # reset

switch-A /chassis/iom* # commit-buffer

switch-A /chassis/iom #

Cisco UCS Manager CLI Command Reference, Release 2.0


774 OL-25718-02
Commands
reset

Related Commands Command Description


show cimc
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 775
Commands
reset-cmos

reset-cmos
To reset the CMOS, use the reset-cmos command.

reset-cmos

This command has no arguments or keywords.

Command Default None

Command Modes Server (/chassis/server)


Server (/server)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was introduced in the Server mode.

Examples This example shows how to reset CMOS:

switch-A# scope chassis 1

switch-A /chassis # scope server 1

switch-A /chassis/server # reset cmos

switch-A /chassis/server* # commit-buffer

switch-A /chassis/server #

Related Commands Command Description


show cpu
show firmware

Cisco UCS Manager CLI Command Reference, Release 2.0


776 OL-25718-02
Commands
reset-errors

reset-errors
To reset the errors on the DIMM, use the reset-errors command.

reset-errors

This command has no arguments or keywords.

Command Default None

Command Modes DIMM (/chassis/server/memory-array/dimm)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A memory array and a DIMM for the server must be created to use this command.

Examples This example shows how to reset the errors on the DIMM for a server.
UCS-A # scope server 1/1
UCS-A /chassis/server # scope memory-array 1
UCS-A /chassis/server/memory-array # scope dimm 2
UCS-A /chassis/server/memory-array/dimm # reset-errors
UCS-A /chassis/server/memory-array/dimm* # commit-buffer
UCS-A /chassis/server/memory-array/dimm #

Related Commands Command Description


show dimm
acknowledge fault

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 777
Commands
reset-kvm

reset-kvm
To reset or clear all sessions (keyboard, video and mouse) for a server, use the reset-kvm command.

reset-kvm

This command has no arguments or keywords.

Command Default None

Command Modes Server (chassis/server)


Server (/server)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to reset or clear all sessions for a server.
UCS-A # scope server 1/1
UCS-A /chassis/server # reset-kvm
UCS-A /chassis/server* # commit-buffer
UCS-A /chassis/server #

Related Commands Command Description


reset-cmos

reset hard-reset-immediate

reset hard-reset-wait

Cisco UCS Manager CLI Command Reference, Release 2.0


778 OL-25718-02
Commands
reset pers-bind

reset pers-bind
To reset persistent binding, use the reset pers-bind command.

reset pers-bind

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Virtual HBA (/org/service-profile/vhba)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to reset persistent binding of fibre channel targets.

Examples This example shows how to reset persistent binding:


switch-A# scope org org30a
switch-A /org # scope service-profile sp101
switch-A /org/service-profile # scope vhba vhba17
switch-A /org/service-profile/vhba # reset pers-bind
switch-A /org/service-profile/vhba #

Related Commands Command Description


show vhba
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 779
Commands
restart

restart
To restart a firmware download task, use the restart command.

restart

Syntax Description:
This command has no arguments or keywords.

Command Default None

Command Modes Firmware download task (/firmware/download-task)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to restart a firmware download task.

Examples This example shows how to restart a firmware download task:


switch-A# scope firmware
switch-A /firmware # scope download-task ucs-k9-bundle.1.1.0.279.bin
switch-A /firmware/download-task # restart
switch-A /firmware/download-task #

Related Commands Command Description


show download-task

Cisco UCS Manager CLI Command Reference, Release 2.0


780 OL-25718-02
Commands
rmdir

rmdir
To remove a directory, use the rmdir command in local management command mode.

rmdir path

Syntax Description path Absolute or relative path, including the name of the directory to be removed.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to remove a directory in local management command mode.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.
This command operates on either the workspace (FLASH) or volatile (RAM) file system. To specify the file
system, include the workspace: or volatile: keyword in the path. If the file system is not specified, the
current working file system is assumed.

Examples This example shows how to remove a directory named temp from the volatile file system:
switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# rmdir volatile:/temp


switch-A(local-mgmt)#

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 781
Commands
rmdir

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


782 OL-25718-02
Commands
run-script

run-script
To run a script, use the run-script command in local management command mode.

run-script script-name

Syntax Description script-name The path and file name of the script file to be executed.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to run a shell script in the local management command mode. The script file must exist in
the workspace: file system.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.

Examples This example shows how to run a shell script:


switch-A# connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# run-script workspace:///sup-1/scripts/testScript.sh


switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 783
Commands
save

save
To save the management logging files, use the save command.

save

Command Default None

Command Modes Management logging (/monitoring/sysdebug/mgmt-logging)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to save the management logging files.

Examples This example shows how to save the management logging files:
switch-A# scope monitoring
switch-A /monitoring # scope sysdebug
switch-A /monitoring/sysdebug # scope mgmt-logging
switch-A /monitoring/sysdebug/mgmt-logging # save
switch-A /monitoring/sysdebug/mgmt-logging #

Related Commands Command Description


show (mgmt-logging)

Cisco UCS Manager CLI Command Reference, Release 2.0


784 OL-25718-02
Commands
scope adapter

scope adapter
To enter adapter mode, use the scope adapter command.

scope adapter {rack-server/id| chassis/server/id}

Syntax Description rack-server/id Adapter location specified using


the rack-server and adapter ID. The
value must be entered in the n/n
format.

chassis/server/id Adapter location specified using


the chassis, server and adapter ID.
The value must be entered in the
n/n/n format.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced with
the chassis/server/id option

1.4(1) The option rack-server/id was


introduced for this command.

Examples This example shows how to enter adapter mode:


Switch-A # scope org Testing
Switch-A /org # scope adapter 1/1/1
Switch-A /chassis/server/adapter #

Related Commands Command Description


show chassis
show iom

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 785
Commands
scope auth-domain

scope auth-domain
To enter the authentication domain mode, use the scope auth-domain command.

scope auth-domain name

Syntax Description name The name of the authentication domain. This name can include a maximum of 16
characters.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the authentication domain can include alphanumeric characters, but cannot include special
characters.
An authentication domain must be created to use this command.

Examples This example shows how to enter the authentication domain:


Switch-A # scope security
Switch-A /security # scope auth-domain Default
Switch-A /security/auth-domain #

Related Commands Command Description


create auth-domain
delete auth-domain

Cisco UCS Manager CLI Command Reference, Release 2.0


786 OL-25718-02
Commands
scope auth-profile

scope auth-profile
To enter the iSCSI authorization profile mode, use the scope auth-profile command.

scope auth-profile iscsi-auth-profile-name

Syntax Description iscsi-auth-profile-name The name of the iSCSI authorization profile. It is the name that you
provided when you created the profile.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines An iSCSI authorization profile must be created to use this command.

Examples This example shows how to enter the iSCSI authorization profile mode for an organization.
UCS-A # scope org test
UCS-A /org # scope auth-profile sample
UCS-A /org/auth-profile #

Related Commands Command Description


create auth-profile

enter auth-profile

show auth-profile

delete auth-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 787
Commands
scope auth-server-group

scope auth-server-group
To enter the authentication server group mode, use the scope auth-server-group command.

scope auth-server-group authentication server group

Syntax Description authentication server group The name of the authentication server group. This name can include
a maximum of 127 characters.

Command Default None

Command Modes LDAP (security/ldap)


RADIUS (/security/radius)
TACACS (/security/tacacs)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication server group must be created to use this command.

Examples This example shows how to enter the authentication server group for LDAP:
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope auth-server-group Default
Switch-A /security/ldap/auth-server-group #

Related Commands Command Description


create auth-server-group
delete auth-server-group

Cisco UCS Manager CLI Command Reference, Release 2.0


788 OL-25718-02
Commands
scope auto-target-if

scope auto-target-if
To enter the configured automatic target interface of an Ethernet interface of an iSCSI VNIC, use the scope
auto-target-if command.

scope auto-target-if

This command has no arguments or keywords.

Command Default None

Command Modes Ethernet interface within the iSCSI VNIC mode (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI VNIC, an Ethernet interface for the iSCSI VNIC, and an automatic target interface
before you use this command.

Examples This example shows how to enter the automatic target interface mode of the Ethernet interface for an iSCSI
VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope auto-target-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/auto-target-if #

Related Commands Command Description


set dhcp-vendor-id

create auto-target-if

enter auto-target-if

delete auto-target-if

show auto-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 789
Commands
scope backup

scope backup
To enter backup mode, use the scope backup command.

scope backup name

Syntax Description name Host name.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter backup mode:

switch-A# scope system

switch-A /system # scope backup backUpFDrive

switch-A /system #* commit-buffer

switch-A /system #

Related Commands Command Description


show backup
show import-config

Cisco UCS Manager CLI Command Reference, Release 2.0


790 OL-25718-02
Commands
scope banner

scope banner
To enter the banner mode, use the scope banner command.

scope banner

This command has no arguments or keywords.

Command Default None

Command Modes Security (/security)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the banner mode.


UCS-A # scope security
UCS-A /security # scope banner
UCS-A /security/banner #

Related Commands Command Description


scope pre-login-banner

show pre-login-banner

set message

clear message

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 791
Commands
scope beacon-led

scope beacon-led
To enter the beacon LED mode, use the scope beacon-led command.

scope beacon-led

This command has no arguments or keywords.

Command Default None

Command Modes Card (/fabric-interconnect/card)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the beacon LED mode:
UCS-A # scope fabric-interconnect A
UCS-A /fabric-interconnect # scope card 1
UCS-A /fabric-interconnect/card # scope beacon-led
UCS-A /fabric-interconnect/card/beacon-led #

Related Commands Command Description


set admin-state (beacon-led)

show beacon-led

Cisco UCS Manager CLI Command Reference, Release 2.0


792 OL-25718-02
Commands
scope bios-settings

scope bios-settings
To enter the BIOS settings mode, use the scope bios-settings command.

scope bios-settings

This command has no arguments or keywords.

Command Default None

Command Modes BIOS (/server/bios)


Platform (/system/server-defaults/platform)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples The following example shows how to enter the BIOS settings mode for a server:
Switch-A # scope server 1/1
Switch-A /chassis/server # scope bios
Switch-A /chassis/server/bios # scope bios-settings
Switch-A /chassis/server/bios/bios-settings #
The following example shows how to change the NUMA default BIOS setting for a platform and commit the
transaction:
UCS-A# scope system
UCS-A /system # scope server-defaults
UCS-A /system/server-defaults # show platform

Platform:
Product Name Vendor Model Revision
------------ ---------- ---------- --------
Cisco B200-M1
Cisco Systems, Inc.
N20-B6620-1
0

UCS-A /system/server-defaults # scope platform "Cisco Systems, Inc." N20-B6620-1 0


UCS-A /system/server-defaults/platform # scope bios-settings
UCS-A /system/server-defaults/platform/bios-settings # set numa-config numa-optimization
disabled
UCS-A /system/server-defaults/platform/bios-settings* # commit-buffer
UCS-A /system/server-defaults/platform/bios-settings #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 793
Commands
scope bios-settings

Related Commands Command Description


show bios-settings

Cisco UCS Manager CLI Command Reference, Release 2.0


794 OL-25718-02
Commands
scope bios

scope bios
To enter the BIOS mode for a server, use the scope bios command.

scope bios

This command has no arguments or keywords.

Command Default None

Command Modes Server (/server)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the BIOS mode for a server.
Switch-A # scope server 1/1
Switch-A /server # scope bios
Switch-A /server/bios #

Related Commands Command Description


scope bios-settings

show bios-settings

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 795
Commands
scope bladeserver-disc-policy

scope bladeserver-disc-policy
To enter the blade server discovery policy mode, use the scope bladeserver-disc-policy command.

scope bladeserver-disc-policy name

Syntax Description name The name of the compute blade server discovery policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A blade server discovery policy must be created to use this command.

Examples This example shows how to enter the blade server discovery policy mode.
Switch-A # scope org
Switch-A /org # scope bladeserver-disc-policy Default
Switch-A /org/bladeserver-disc-policy #

Related Commands Command Description


create bladeserver-disc-policy
enter bladeserver-disc-policy
show bladeserver-disc-policy
delete bladeserver-disc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


796 OL-25718-02
Commands
scope block

scope block
To enter block mode, use the scope block command.

scope block from to

Syntax Description from From value.

to To value.

Command Default None

Command Modes IP pool (/org/ip-pool)


WWN pool (/org/wwn-pool)
UUID suffix pool (/org/uuid-suffix-pool)
MAC pool (/org/mac-pool)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter block mode:

switch-A# scope org org10

switch-A /org # scope ip-pool ipp10

switch-A /org/ip-pool # scope block 209.165.200.225


209.165.200.235

switch-A /org/ip-pool #

Related Commands Command Description


show ip-pool
show mac-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 797
Commands
scope boardcontroller

scope boardcontroller
To enter board controller mode, use the scope boardcontroller command.

scope boardcontroller

This command has no arguments or keywords.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Only certain servers, such as the Cisco UCS B440 High Performance blade server and the Cisco UCS B230
blade server, have board controller firmware. The board controller firmware controls many of the server
functions, including eUSBs, LEDs, and I/O connectors.

Examples This example shows how to enter board controller mode:

switch-A# scope chassis 1

switch-A /chassis # scope server 1/1

switch-A /chassis/server # scope boardcontroller

switch-A /chassis/server/boardcontroller #

Related Commands Command Description


show boardcontroller

Cisco UCS Manager CLI Command Reference, Release 2.0


798 OL-25718-02
Commands
scope boot-definition

scope boot-definition
To enter boot definition mode, use the scope boot-definition command.

scope boot-definition

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter boot definition mode:

switch-A# scope org org3

switch-A /org # scope service-profile sp3a

switch-A /org/service-profile # scope boot-definition

switch-A /org/service-profile/boot-definition #

Related Commands Command Description


show boot-definition
show lan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 799
Commands
scope boot-policy

scope boot-policy
To enter boot-policy mode, use the scope boot-policy command.

scope boot-policy name

Syntax Description name Boot policy name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter boot-policy mode:

switch-A# scope org org10

switch-A /org # scope boot-policy

switch-A /org/boot-policy #

Related Commands Command Description


show boot-policy
show qos-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


800 OL-25718-02
Commands
scope boot-target

scope boot-target
To enter the boot target mode, use the scope boot-target command.

scope boot-target {primary| secondary}

Syntax Description primary Specifies the primary boot target.

secondary Specifies the secondary boot target.

Command Default None

Command Modes WWN initiator (/org/wwn-pool/initiator)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines Use this command to enter the boot target. You can configure the logical unit number (LUN) and world wide
name (WWN) for the primary or secondary boot target. Use the exit command to exit boot-target.

Examples The following example shows how to enter the secondary boot target mode:
server# scope org
server /org # scope wwn-pool default
server /org/wwn-pool # scope initiator 20:00:00:25:B5:00:00:00
server /org/wwn-pool/initiator # scope boot-target secondary
server /org/wwn-pool/initiator/boot-target #

Related Commands Command Description


set lun
set wwn
show boot-target

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 801
Commands
scope callhome

scope callhome
To view the callhome details, use the scope callhome command.

scope callhome

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to view the callhome policy details.

Examples This example shows how to use this command to view the callhome details:
switch-A # scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome #

Related Commands Command Description


scope inventory

scope policy

Cisco UCS Manager CLI Command Reference, Release 2.0


802 OL-25718-02
Commands
scope capability

scope capability
To enter capability mode, use the scope capability command.

scope capability

This command has no arguments or keywords.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter capability mode:

switch-A# scope system

switch-A /system # scope capability

switch-A /system/capability #

Related Commands Command Description


show memory
show version

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 803
Commands
scope cap-qual

scope cap-qual
To enter capacity qualification mode, use the scope cap-qual command.

scope cap-qual {fcoe| non-virtualized-eth-if| non-virtualized-fc-if| path-encap-consolidated|


path-encap-virtual| protected-eth-if| protected-fc-if| protected-fcoe| virtualized-eth-if| virtualized-fc-if|
virtualized-scsi-if}

Syntax Description fcoe Specifies Fibre Channel over Ethernet.

non-virtualized-eth-if Specifies a non-virtualized Ethernet interface.

non-virtualized-fc-if Specifies a non-virtualized Fibre Channel interface.

path-encap-consolidated Specifies a consolidated encapsulated path.

path-encap-virtual Specifies a virtual encapsulated path.

protected-eth-if Specifies a protected Ethernet interface.

protected-fc-if Specifies a protected Fibre Channel interface.

protected-fcoe Specifies a protected Fibre Channel over Ethernet interface.

virtualized-eth-if Specifies a virtualized Ethernet interface.

virtualized-fc-if Specifies a virtualized Fibre Channel interface.

virtualized-scsi-if Specifies a virtualized SCSI interface.

Command Default None

Command Modes Adapter (/org/server-qual/adapter)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter capacity qualification mode:

switch-A# scope org org10

switch-A /org # scope server-qual sq10

Cisco UCS Manager CLI Command Reference, Release 2.0


804 OL-25718-02
Commands
scope cap-qual

switch-A /org/server-qual # scope adapter

switch-A /org/server-qual/adapter # scope cap-qual fcoe

Related Commands Command Description


show adapter
show cap-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 805
Commands
scope card

scope card
To enter the fabric card mode for a fabric-interconnect, use the scope card command.

scope card id

Syntax Description id The ID of the fabric card. It must be a value between 0 and 4294967295.

Command Default None

Command Modes Fabric Inter-connect (/fabric-interconnect)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the switch mode for a fabric-interconnect.
UCS-A # scope fabric-interconnect A
UCS-A /fabric-interconnect # scope card 1
UCS-A /fabric-interconnect/card #

Related Commands Command Description


scope beacon-led

Cisco UCS Manager CLI Command Reference, Release 2.0


806 OL-25718-02
Commands
scope cat-updater

scope cat-updater
To enter the capability catalog file updater mode, use the scope cat-updater command.

scope cat-updater filename

Syntax Description filename Enter the name of the capability catalog update file used in the previous update
operation.

Command Default None

Command Modes Capability (/system/capability)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to enter the capability catalog file updater mode for a previous update operation. In the
cat-updater mode, you can change parameters of the operation, such as remote server location, login information,
and protocol.

Examples The following example shows how to change a parameter from a failed previous capability catalog update
and restart the update:
UCS-A# scope system
UCS-A /system # scope capability
UCS-A /system/capability # show cat-updater
Catalog Updater:
File Name Protocol Server Userid Status
--------- -------- --------------- --------------- ------
ucs-catalog.1.0.0.4.bin
Scp 192.0.2.111 user1 Failed

UCS-A /system/capability # scope cat-updater ucs-catalog.1.0.0.4.bin


UCS-A /system/capability/cat-updater # set server 192.0.2.112
UCS-A /system/capability/cat-updater # restart
UCS-A /system/capability/cat-updater #

Related Commands Command Description


show cat-updater

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 807
Commands
scope cert-store

scope cert-store
To enter cert-store mode, use the scope cert-store command.

scope cert-store

This command has no arguments or keywords.

Command Default None

Command Modes Certificate store (/system/vm-mgmt/vmware/cert-store)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use cert-store mode to create, enter, delete, and show certificates.

Examples This example shows how to enter cert-store mode:


switch-A # scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope cert-store
switch-A /system/vm-mgmt/vmware/cert-store #

Related Commands Command Description


show
show vcon-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


808 OL-25718-02
Commands
scope chassis

scope chassis
To enter chassis mode, use the scope chassis command.

scope chassis chassis-id

Syntax Description id Chassis identification number.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter chassis mode:

switch-A# scope chassis 1

switch-A /chassis #

Related Commands Command Description


show chassis
show slot

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 809
Commands
scope chassis (/capability)

scope chassis (/capability)


To enter the chassis mode for a system, use the scope chassis command.

scope chassis vendor model hw-rev

Syntax Description vendor The name of the vendor of the chassis.

model The model number of the chassis. The value can include a maximum of 510
characters.

hw-rev The hardware revision number.

Command Default None

Command Modes Capability (/system/capability)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the chassis mode for a system:
Switch-A # scope system
Switch-A /system # scope capability
Switch-A /system/capability # scope chassis Cisco Systems Inc N20-C6508 1
Switch-A /system/capability/chassis #

Related Commands Command Description


show chassis

Cisco UCS Manager CLI Command Reference, Release 2.0


810 OL-25718-02
Commands
scope chassis-conn-policy

scope chassis-conn-policy
To enter the chassis connectivity policy mode for a fabric, use the scope chassis-conn-policy command.

scope chassis-conn-policy chassis id {a| b}

Syntax Description chassis id The ID of the chassis. The value must be a number between 1 and 255.

a To enter the chassis connectivity policy mode for fabric A.

b To enter the chassis connectivity policy mode for fabric B.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the chassis connectivity policy mode for fabric A:
UCS-A # scope org test
UCS-A /org # scope chassis-conn-policy 1 a
UCS-A /org/chassis-conn-policy #

Related Commands Command Description


set link-aggregation-pref

show chassis-conn-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 811
Commands
scope chassis-disc-policy

scope chassis-disc-policy
To enter chassis discovery policy mode, use the scope chassis-disc-policy command.

scope chassis-disc-policy

This command has no arguments or keywords.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter chassis discovery policy mode:

switch-A# scope org org30

switch-A /org # scope chassis-disc-policy

switch-A /org/chassis-disc-policy #

Related Commands Command Description


show chassis-disc-policy
show org

Cisco UCS Manager CLI Command Reference, Release 2.0


812 OL-25718-02
Commands
scope cimc

scope cimc
To enter CIMC mode, use the scope cimc command.

scope cimc

This command has no arguments or keywords.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.3(1) This command was introduced.

Examples This example shows how to enter CIMC mode:


switch-A# scope server 1/1
switch-A /chassis/server # scope cimc
switch-A /chassis/server/cimc #

Related Commands Command Description


show cimc
show raid-controller

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 813
Commands
scope class chassis-stats

scope class chassis-stats


To enter the chassis statistics of a class, use the scope class chassis-stats command.

scope class chassis-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created prior to using this command.

Examples This example shows how to enter the chassis statistics of a class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # scope class chassis-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show class chassis-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


814 OL-25718-02
Commands
scope class cpu-env-stats

scope class cpu-env-stats


To enter the CPU environment statistics class, use the scope class cpu-stats command.

scope class cpu-env-stats

Command Default None

Command Modes /org/stats-threshold-policy

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter the CPU environment statistics class:
switch-A# scope org org100
switch-A /org # scope stats-threshold-policy stp100
switch-A /org/stats-threshold-policy # scope class cpu-env-stats
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 815
Commands
scope class dimm-env-stats

scope class dimm-env-stats


To enter the dual in-line memory module (DIMM) environment statistics mode, use the scope class
dimm-env-stats command.

scope class dimm-env-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter the DIMM environment statistics mode:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # scope class dimm-env-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class dimm-env-stats

delete class dimm-env-stats

enter class dimm-env-stats

show class dimm-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


816 OL-25718-02
Commands
scope class ether-error-stats

scope class ether-error-stats


To enter an Ethernet error statistics class, use the scope class ether-error-stats command.

scope ether-error-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy/)


Statistics threshold policy under Ethernet Uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines There must be an available statistics threshold policy to view the Ethernet error statistics for the class.

Examples This example shows how to enter the Ethernet error statistics class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold policy default
Switch-A /eth-server/stats-threshold-policy # scope class ether-error-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


scope class ether-loss-stats

scope class ether-pause-stats

scope class ether-port-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 817
Commands
scope class ether-loss-stats

scope class ether-loss-stats


To enter the Ethernet loss statistics of a class, use the scope class ether-loss-stats command.

scope class ether-loss-stats

Syntax Description
This command has no arugments or keywords

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines The statistics threshold policy must be created prior to using this command.

Examples This example shows how to enter the Ethernet loss statistics for a class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-srver/stats-threshold-policy # scope class ether-loss-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


scope class ether-error-stats

scope class ether-port-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


818 OL-25718-02
Commands
scope class ethernet-port-err-stats

scope class ethernet-port-err-stats


To enter an Ethernet port error statistics class, use the scope class ethernet-port-err-stats command.

scope class ethernet-port-err-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter an Ethernet port error statistics class.

Examples This example shows how to enter an Ethernet port error statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # enter class ethernet-port-err-stats
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 819
Commands
scope class ethernet-port-multicast-stats

scope class ethernet-port-multicast-stats


To enter an Ethernet port multicast statistics class, use the scope class ethernet-port-multicast-stats
command.

scope class ethernet-port-multicast-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter an Ethernet port multicast statistics class.

Examples This example shows how to enter an Ethernet port multicast statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # scope class ethernet-port-multicast-stats
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


create class ethernet-port-multicast-stats
show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


820 OL-25718-02
Commands
scope class ethernet-port-over-under-sized-stats

scope class ethernet-port-over-under-sized-stats


To enter an Ethernet port over-under-sized statistics class, use the scope class
ethernet-port-over-under-sized-stats command.

scope class ethernet-port-over-under-sized-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter an Ethernet port over-under-sized statistics class.

Examples This example shows how to enter an Ethernet port over-under-sized statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # enter class ethernet-port-over-under-sized-stats
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 821
Commands
scope class ethernet-port-stats

scope class ethernet-port-stats


To enter an Ethernet port statistics class, use the scope class ethernet-port-stats command.

scope class ethernet-port-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter an Ethernet port statistics class.

Examples This example shows how to enter an Ethernet port statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # enter class ethernet-port-stats
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


822 OL-25718-02
Commands
scope class ethernet-port-stats-by-size-large-packets

scope class ethernet-port-stats-by-size-large-packets


To enter an Ethernet port large packet statistics class, use the scope class
ethernet-port-stats-by-size-large-packets command.

scope class ethernet-port-stats-by-size-large-packets

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter an Ethernet port large packet statistics class.

Examples This example shows how to enter an Ethernet port large packet statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # enter class ethernet-port-stats-by-size-large-packets
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 823
Commands
scope class ethernet-port-stats-by-size-small-packets

scope class ethernet-port-stats-by-size-small-packets


To enter an Ethernet port small packet statistics class, use the scope class
ethernet-port-stats-by-size-small-packets command.

scope class ethernet-port-stats-by-size-small-packets

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter an Ethernet port small packet statistics class.

Examples This example shows how to enter an Ethernet port small packet statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # enter class ethernet-port-stats-by-size-small-packets
switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


show class
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


824 OL-25718-02
Commands
scope class ether-pause-stats

scope class ether-pause-stats


To enter the Ethernet pause statistics class mode, use the scope class ether-pause-stats command.

scope class ether-pause-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to change to the Ethernet pause statistics class mode:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # scope class ether-pause-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class ether-pause-stats

delete class ether-pause-stats

enter class ether-pause-stats

show class ether-pause-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 825
Commands
scope class ether-rx-stats

scope class ether-rx-stats


To enter an Ethernet Rx statistics class, use the scope class ether-rx-stats command.

scope class ether-rx-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)


Statistics threshold policy under Ethernet Uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.

Examples This example shows how to enter the Ethernet Rx statistics class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # scope class ether-rx-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show class ether-rx-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


826 OL-25718-02
Commands
scope class ether-tx-stats

scope class ether-tx-stats


To enter the Ethernet tx statistics mode for a class, use the scope class ether-tx-stats command.

scope class ether-tx-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy/)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created prior to using this command.

Examples This example shows how to enter the Ethernert tx statistics mode for a class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # scope class ether-tx-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


scope class ether-rx-stats

show class ether-tx-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 827
Commands
scope class fan-module-stats

scope class fan-module-stats


To enter the fan module statistics mode for a class, use the scope class fan-module-stats command.

scope class fan-module-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created prior to using this command.

Examples This example shows how to enter the fan module statistics mode for a class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy/ # scope class fan-module-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show class fan-module-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


828 OL-25718-02
Commands
scope class fan-stats

scope class fan-stats


To enter the fan statistics mode of a class, use the scope class fan-stats command.

scope class fan-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created prior to using this command.

Examples This example shows how to enter the fan statistics mode of a class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # scope class fan-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show class fan-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 829
Commands
scope class fc-error-stats

scope class fc-error-stats


To enter the Fibre Channel error statistics mode of a class, use the scope class fc-error-stats command.

scope class fc-error-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy/)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created prior to using this command.

Examples This example shows how to enter the Fibre Channel error statistics mode of a class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # scope class fc-error-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show class fc-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


830 OL-25718-02
Commands
scope class fc-stats

scope class fc-stats


To enter the Fibre Channel statistics mode of a class, use the scope class fc-stats command.

scope class fc-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/fc-uplink/stats-threshold-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created prior to using this command.

Examples This example shows how to enter the Fibre Channel statistics mode for a class:
Switch-A # scope fc-uplink
Switch-A /fc-uplink # scope stats-threshold-policy default
Switch-A /fc-uplink/stats-threshold-policy # scope class fc-stats
Switch-A /fc-uplink/stats-threshold-policy/class #

Related Commands Command Description


show class fc-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 831
Commands
scope class fex-env-stats

scope class fex-env-stats


To enter the Fex environment statistics mode for a class, use the scope class fex-env-stats command.

scope class fex-env-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics Threshold Policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy must be created to use this command.
An Fex environment statistics mode must be created for a class to use this command.

Examples This example shows how to enter the Fex environment statistics mode for a class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy Default
Switch-A /eth-server/stats-threshold-policy # scope class fex-env-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


show class fex-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


832 OL-25718-02
Commands
scope class fex-power-summary

scope class fex-power-summary


To enter the Fex power summary statistics mode of a class, use the scope class fex-power-summary command.

scope class fex-power-summary

This command has no arguments or keywords.

Command Default None

Command Modes Statistics Threshold Policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy and an Fex power summary statistics class must be created to use this command

Examples This example shows how to enter the Fex power summary statistics class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # scope class fex-power-summary
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class fex-power-summary
delete class fex-power-summary

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 833
Commands
scope class fex-psu-input-stats

scope class fex-psu-input-stats


To enter the Fex power supply input statistics mode of a class, use the scope class fex-psu-input-stats
command.

scope class fex-psu-input-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy and an Fex power supply input statistics class must be created to use this command.

Examples This example shows how to enter the Fex power supply input statistics mode for a class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # scope class fex-psu-input-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class fex-psu-input-stats
delete class fex-psu-input-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


834 OL-25718-02
Commands
scope class io-card-stats

scope class io-card-stats


To change to the IO card statistics class mode, use the scope class io-card-stats command.

scope class io-card-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Ethernet statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines Use this command to enter the io-card-stats class mode to configure class properties.

Examples This example shows how to enter the IO card statistics class mode:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # scope class io-card-stats
server /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class io-card-stats

delete class io-card-stats

enter class io-card-stats

show class io-card-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 835
Commands
scope class memory-array-env-stats

scope class memory-array-env-stats


To change to the memory array environment statistics class mode, use the scope class memory-array-env-stats
command.

scope class memory-array-env-stats

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Statistcis threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter the memory array environment statistics class mode:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # scope class memory-array-env-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class memory-array-env-stats

delete class memory-array-env-stats

enter class memory-array-env-stats

show class memory-array-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


836 OL-25718-02
Commands
scope class memory-error-correctable-codes-stats

scope class memory-error-correctable-codes-stats


To enter the memory error correctable codes statistics class mode, use the scope class
memory-error-correctable-codes-stats command.

scope class memory-error-correctable-codes-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to change to the memory error correctable code statistics class mode:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # scope class memory-error-correctable-codes-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class memory-error-correctable-codes-stats

delete class memory-error-correctable-codes-stats

enter class memory-error-correctable-codes-stats

show class memory-error-correctable-codes-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 837
Commands
scope class memory-mirroring-error-stats

scope class memory-mirroring-error-stats


To enter the memory mirroring error statistics class mode, use the scope class memory-mirroring-error-stats
command.

scope class memory-mirroring-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to change to the memory mirroring error statistics class mode:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # scope class memory-mirroring-error-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class memory-mirroring-error-stats

delete class memory-mirroring-error-stats

enter class memory-mirroring-error-stats

show class memory-mirroring-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


838 OL-25718-02
Commands
scope class memory-sparing-error-stats

scope class memory-sparing-error-stats


To enter the memory sparing error statistics class mode, use the scope class memory-sparing-error-stats
command.

scope class memory-sparing-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to change to the memory sparing error statistics class mode:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # scope class memory-sparing-error-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class memory-sparing-error-stats

delete class memory-sparing-error-stats

enter class memory-sparing-error-stats

show class memory-sparing-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 839
Commands
scope class motherboard-temp-stats

scope class motherboard-temp-stats


To enter the motherboard temperature statistics mode for a class, use the scope class motherboard-temp-stats
command.

scope class motherboard-temp-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics Threshold Policy (/org/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy for the organization mode must be created to use this command.

Examples This example shows how to enter the motherboard temperature statistics mode for a class.
UCS-A # scope org test
UCS-A /org # scope stats-threshold-policy sample
UCS-A /org/stats-threshold-policy # scope class motherboard-temp-stats
UCS-A /org/stats-threshold-policy/class #

Related Commands Command Description


create class motherboard-temp-stats

enter class motherboard-temp-stats

show class motherboard-temp-stats

delete class motherboard-temp-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


840 OL-25718-02
Commands
scope class pc-ie-correctable-stats

scope class pc-ie-correctable-stats


To enter the Peripheral Component Interconnect (PCI) Express (PCIe) correctable error statistics class mode,
use the scope class pc-ie-correctable-stats command.

scope class pc-ie-correctable-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to change to the PCIe correctable error statistics class mode:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # scope class pc-ie-correctable-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class pc-ie-correctable-stats

delete class pc-ie-correctable-stats

enter class pc-ie-correctable-stats

show class pc-ie-correctable-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 841
Commands
scope class pcie-fatal-completion-error-stats

scope class pcie-fatal-completion-error-stats


To enter the Peripheral Component Interconnect (PCI) Express (PCIe) fatal completion error statistics class
mode, use the scope class pcie-fatal-completion-error-stats command.

scope class pcie-fatal-completion-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to enter the PCIe fatal completion error statistics class mode:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # scope class pcie-fatal-completion-error-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class pcie-fatal-completion-error-stats

delete class pcie-fatal-completion-error-stats

enter class pcie-fatal-completion-error-stats

show class pcie-fatal-completion-error-statss

Cisco UCS Manager CLI Command Reference, Release 2.0


842 OL-25718-02
Commands
scope class pcie-fatal-error-stats

scope class pcie-fatal-error-stats


To enter the Peripheral Component Interconnect (PCI) Express (PCIe) fatal error statistics class mode, use
the scope class pcie-fatal-error-stats command.

scope class pcie-fatal-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to change to the PCIe fatal error statistics class mode:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # scope class pcie-fatal-error-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class pcie-fatal-error-stats

delete class pcie-fatal-error-stats

enter class pcie-fatal-error-stats

show class pcie-fatal-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 843
Commands
scope class pcie-fatal-protocol-error-stats

scope class pcie-fatal-protocol-error-stats


To enter the Peripheral Component Interconnect (PCI) Express (PCIe) fatal protocol error statistics class
mode, use the scope class pcie-fatal-protocol-error-stats command.

scope class pcie-fatal-protocol-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to change to a PCIe fatal protocol error statistics class mode:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # scope class pcie-fatal-protocol-error-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class pcie-fatal-protocol-error-stats

delete class pcie-fatal-protocol-error-stats

enter class pcie-fatal-protocol-error-stats

show class pcie-fatal-protocol-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


844 OL-25718-02
Commands
scope class pcie-fatal-receiving-error-stats

scope class pcie-fatal-receiving-error-stats


To enter the Peripheral Component Interconnect (PCI) Express (PCIe) fatal receive error statistics class mode,
use the scope class pcie-fatal-receiving-error-stats command.

scope class pcie-fatal-receiving-error-stats

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to change to the PCIe fatal receive error statistics class mode:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # scope class pcie-fatal-receiving-error-stats
server /org/stats-threshold-policy/class #

Related Commands Command Description


create class pcie-fatal-receiving-error-stats

delete class pcie-fatal-receiving-error-stats

enter class pcie-fatal-receiving-error-stats

show class pcie-fatal-receiving-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 845
Commands
scope class rack-unit-fan-stats

scope class rack-unit-fan-stats


To enter the rack unit fan statistics mode for a class, use the scope class rack-unit-fan-stats command.

scope class rack-unit-fan-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy and a rack unit fan statistics class must be created to use this command.

Examples This example shows how to enter the rack unit fan statistics mode for a class:
Switch-A # scope eth-server
Switch-A /eth-server # scope stats-threshold-policy default
Switch-A /eth-server/stats-threshold-policy # scope class rack-unit-fan-stats
Switch-A /eth-server/stats-threshold-policy/class #

Related Commands Command Description


create class rack-unit-fan-stats
delete class rack-unit-fan-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


846 OL-25718-02
Commands
scope class rack-unit-psu-stats

scope class rack-unit-psu-stats


To enter the rack unit power supply statistics mode for a class, use the scope class rack-unit-psu-stats
command.

scope class rack-unit-psu-stats

This command has no arguments or keywords.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy and a rack unit power supply statistics class must be created to use this command.

Examples This example shows how to enter the rack unit power supply statistics mode for a class.
Switch-A # scope org
Switch-A /org # scope stats-threshold-policy default
Switch-A /org/stats-threshold-policy # scope class rack-unit-psu-stats
Switch-A /org/stats-threshold-policy/class #

Related Commands Command Description


enter class rack-unit-psu-stats
delete class rack-unit-psu-stats
create class rack-unit-psu-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 847
Commands
scope client

scope client
To enter a specific client mode, use the scope client command in port-profile mode.

scope client client-name

Syntax Description client-name The name of the client.

Command Default None

Command Modes Port profile within the VMware command mode (/system/vm-mgmt/vmware/profile-set/port-profile)
Port profile with the virtual management command mode (/system/vm-mgmt/profile-set/port-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use client mode to create the following managed objects:
• Data centers
• Distributed virtual switches
• Folders

Examples This example shows how to enter client mode:


UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope vmware
UCS-A /system/vm-mgmt/vmware # scope profile-set
UCS-A /system/vm-mgmt/vmware/profile-set # scope port-profile pp100
UCS-A /system/vm-mgmt/vmware/profile-set/port-profile # scope client c100
UCS-A /system/vm-mgmt/vmware/profile-set/port-profile/client #

Related Commands Command Description


show client
show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


848 OL-25718-02
Commands
scope cluster-set

scope cluster-set
To enter the cluster-set mode for the system, use the scope cluster-set command.

scope cluster-set

This command has no arguments or keywords.

Command Default None

Command Modes Virtual Machine Management (/system/vm-mgmt)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the cluster-set mode for the system.
UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope cluster-set
UCS-A /system/vm-mgmt/cluster-set #

Related Commands Command Description


create cluster
enter cluster
scope cluster
show cluster
delete cluster

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 849
Commands
scope cluster

scope cluster
To enter the distributed virtual switch mode, use the scope cluster command.

scope cluster name

Syntax Description name The name of the distributed virtual switch. It is the name you provided while creating
the switch.

Command Default None

Command Modes Cluster set (/system/vm-mgmt/cluster-set)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines A distributed virtual switch must be created to use this command.

Examples This example shows how to enter the distributed virtual switch mode.
UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope cluster-set
UCS-A /system/vm-mgmt/cluster-set # scope cluster sample
UCS-A /system/vm-mgmt/cluster-set/cluster #

Related Commands Command Description


create cluster

enter cluster

delete cluster

show cluster

Cisco UCS Manager CLI Command Reference, Release 2.0


850 OL-25718-02
Commands
scope console-auth

scope console-auth
To enter the console authentication mode, use the scope console-auth command.

scope console-auth

This command has no arguments or keywords.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the console authentication mode:
Switch-A # scope security
Switch-A /security # scope console-auth
Switch-A /security/console-auth #

Related Commands Command Description


set auth-server-group
set realm

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 851
Commands
scope cpu

scope cpu
To enter a CPU mode, use the scope cpu command.

scope cpu

Command Default None

Command Modes Server qualifier (/org/server-qual)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter a CPU mode:


server# scope org
server /org # scope server-qual all-chassis
server /org/server-qual # scope cpu
server /org/server-qual/cpu #

Related Commands Command Description


create cpu

delete cpu

enter cpu

show server

Cisco UCS Manager CLI Command Reference, Release 2.0


852 OL-25718-02
Commands
scope cpu (/system/capability)

scope cpu (/system/capability)


To enter the CPU mode for a system, use the scope cpu command.

scope cpu vendor model hw-rev

Syntax Description vendor The vendor name of the CPU. The name can include a maximum of 510
characters.

model The model number of the CPU. The name can include a maximum of 510
characters.

hw-rev The hardware revision of the CPU.

Command Default None

Command Modes Capability (/system/capability)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the CPU mode for a system.
Switch-A # scope system
Switch-A /system # scope capability
Switch-A /system/capability # scope cpu Intel(R) Genuine Intel(R) CPU 1
Switch-A /system/capability/cpu #

Related Commands Command Description


show cpu

scope chassis

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 853
Commands
scope data-center

scope data-center
To enter data-center mode, use the scope data-center command in vcenter mode.

scope data-center datacenter-name

Syntax Description datacenter-name The name of the data center.

Command Default None

Command Modes Data center (/system/vm-mgmt/vmware/vcenter/data-center)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use data-center mode to perform the following tasks:


• Create and delete folders
• Show folder information

Examples This example shows how to enter data-center mode:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc1
switch-A /system/vm-mgmt/vmware/vcenter # scope data-center dc1
switch-A /system/vm-mgmt/vmware/vcenter/data-center #

Related Commands Command Description


show data-center
show vcenter

Cisco UCS Manager CLI Command Reference, Release 2.0


854 OL-25718-02
Commands
scope default-auth

scope default-auth
To enter the default authentication mode, use the scope default-auth command.

scope default-auth

This command has no arguments or keywords.

Command Default None

Command Modes Security (/security)


Authentication Domain (/security/auth-domain)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication domain must be created prior to using this command to enter the default authentication
mode for an authentication domain.

Examples This example shows how to enter the default authentication mode in an authentication domain:
Switch-A # scope security
Switch-A /security # scope auth-domain Default
Switch-A /security/auth-domain # scope default-auth
Switch-A /security/auth-domain/default-auth #

Related Commands Command Description


create default-auth
delete default-auth

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 855
Commands
scope default-behavior

scope default-behavior
To enter default-behavior mode, use the scope default-behavior command.

scope default-behavior {vhba | vnic}

Syntax Description vhba Specifies vHBA default behavior mode.

vnic Specifies vNIC default behavior mode.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to enter vNIC default behavior mode:
switch-A# scope org org100
switch-A /org # scope service-profile sp100
switch-A /org/service-profile # scope default-behavior vnic
switch-A /org/service-profile/default-behavior #

Related Commands Command Description


show default-behavior
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


856 OL-25718-02
Commands
scope dest-interface

scope dest-interface
To enter the destination interface mode for the Fibre Channel traffic monitoring session or the Ethernet traffic
monitoring session, use the scope dest-interface command.

scope dest-interface slotid portid

Syntax Description slotid The slot ID of the destination interface. It must be a value between 1-5.

portid The port ID of the destination interface. It must be a value between 1-40.

Command Default None

Command Modes Fibre Channel traffic monitoring session (/fc-traffic-mon/fabric/fc-mon-session)


Ethernet traffic monitoring session (/eth-traffic-mon/fabric/eth-mon-session)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A Fibre Channel traffic monitoring session or an Ethernet traffic monitoring session must be created prior to
using this command.

Examples This example shows how to enter the destination interface mode for the Ethernet traffic monitoring session.
To enter the destination interface mode for the Fibre Channel traffic monitoring session, replace
eth-traffic-mon with fc-traffic-mon , and eth-mon-session with fc-mon-session .
Switch-A # scope eth-traffic-mon
Switch-A /eth-traffic-mon # scope fabric a
Switch-A /eth-traffic-mon/fabric # scope eth-mon-session Default
Switch-A /eth-traffic-mon/fabric/eth-mon-session # scope dest-interface 1 33
Switch-A /eth-traffic-mon/fabric/eth-mon-session/dest-interface #

Related Commands Command Description


create dest-interface
delete dest-interface

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 857
Commands
scope dhcp-ip-params

scope dhcp-ip-params
To enter the configured DHCP for initiator IP parameters mode, use the scope dhcp-ip-params command.

scope dhcp-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface of the iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a DHCP initiator for IP parameters before you use this command.

Examples This example shows how to enter the DHCP for initiator IP parameters mode:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # scope dhcp-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/dhcp-ip-params #

Related Commands Command Description


create dhcp-ip-params

enter dhcp-ip-params

delete dhcp-ip-params

create ip-if

Cisco UCS Manager CLI Command Reference, Release 2.0


858 OL-25718-02
Commands
scope diag

scope diag
To enter the diagnostics mode for a server, use the scope diag
command.

scope diag

This command has no arguments or keywords.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the diagnostic mode for a server.
Switch-A # scope server 1/1
Switch-A /chassis/server # scope diag
Switch-A /chassis/server/diag #

Related Commands Command Description


show diag

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 859
Commands
scope dimm

scope dimm
To enter the dual in-line memory module (DIMM) for a server, use the scope dimm command.

scope dimm id

Syntax Description Id The ID of the dual in-line memory module. It must be a value between 0 and 4294967295.

Command Default None

Command Modes Memory array (/chassis/server/memory-array)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the DIMM mode for a server.
Switch-A # scope server 1/1
Switch-A /chassis/server # scope memory-array 1
Switch-A /chassis/server/memory-array # scope dimm 2
Switch-A /chassis/server/memory-array/dimm #

Related Commands Command Description


reset-errors

acknowledge fault

Cisco UCS Manager CLI Command Reference, Release 2.0


860 OL-25718-02
Commands
scope distributed-virtual-switch

scope distributed-virtual-switch
To enter distributed-virtual-switch mode, use the enter distributed-virtual-switch command in folder mode.

scope distributed-virtual-switch dvs-name

Syntax Description dvs-name The name of the switch.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware/vcenter/data-center/folder)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use distributed-virtual-switch mode to perform the following tasks:


• Enable and disable DVS administrative state
• Scope to port-profile mode
• Show port profile information

Examples This example shows how to enter distributed-virtual-switch mode:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc10
switch-A /system/vm-mgmt/vmware/vcenter # scope data-center dc10
switch-A /system/vm-mgmt/vmware/vcenter/data-center # scope folder f10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder # scope distributed-virtual-switch
dvs10
switch-A /system/vm-mgmt/vmware/vcenter/data-center/folder/distributed-virtual-switch #

Related Commands Command Description


show distributed-virtual-switch
show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 861
Commands
scope download-task

scope download-task
To download a task for a license, use the scope download-task command.

scope download-task filename

Syntax Description filename The name of the file.

Command Default None

Command Modes License (/license)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The file must exist to use this command.

Examples This example shows how to download a task for a license.


Switch-A # scope license
Switch-A /license # scope download-task Sample
Switch-A /license* # commit-buffer
Switch-A /license #

Related Commands Command Description


scope license
install file
clear file

Cisco UCS Manager CLI Command Reference, Release 2.0


862 OL-25718-02
Commands
scope dynamic-vnic-conn

scope dynamic-vnic-conn
To enter dynamic-vnic-conn mode, use the scope dynamic-vnic-conn command.

scope dynamic-vnic-conn

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use dynamic-vnic-conn mode to perform the following tasks:


• Set adapter policies
• Show the dynamic vNIC connection

Examples This example shows how to enter dynamic-vnic-conn mode:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # scope dynamic-vnic-conn

switch-A /org/service-profile #

Related Commands Command Description


show dynamic-vnic-con
show dynamic-vnic-con-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 863
Commands
scope dynamic-vnic-conn-policy

scope dynamic-vnic-conn-policy
To enter dynamic-vnic-conn-policy mode, use the enter dynamic-vnic-conn-policy command.

enter dynamic-vnic-conn-policy policy-name

Syntax Description policy-name The name of the vNIC connection policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use dynamic-vnic-conn-policy mode to perform the following tasks:


• Set adapter policies
• Show dynamic vNIC connection policies

Examples The following example shows how to enter dynamic-vnic-conn-policy mode:


switch-A# scope org org100
switch-A /org # scope dynamic-vnic-conn-policy dvcp100
switch-A /org/dynamic-vnic-conn-policy #

Related Commands Command Description


show dynamic-vnic-connection-policy
show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


864 OL-25718-02
Commands
scope egress-policy

scope egress-policy
To enter egress-policy mode, use the scope egress-policy command in qos-policy mode.

scope egress-policy

This command has no argument or keywords.

Command Default None

Command Modes Egress policy (/org/qos-policy/egress-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines You must create an egress policy before you scope to egress-policy mode.
Use egress-policy mode to perform the following tasks:
• Set QoS priority and rate
• Show egress QoS policy information

Examples This example shows how to enter egress-policy mode:


switch-A# scope org
switch-A /system # scope qos-policy qp10
switch-A /system/vm-mgmt # scope egress-policy
switch-A /system/vm-mgmt/server/container #

Related Commands Command Description


show egress-policy
show qos-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 865
Commands
scope eth-best-effort

scope eth-best-effort
To enter eth-best-effort mode, use the scope eth-best-effort command in qos mode.

scope eth-best-effort

This command has no argument or keywords.

Command Default None

Command Modes Ethernet best effort (/eth-server/qos/eth-best-effort)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use eth-best-effort mode to perform the following tasks:


• Set MTU, multicast optimize, and weight
• Show Ethernet best effort details

Examples This example shows how to enter eth-best-effort mode:


switch-A # scope eth-server
switch-A /eth-server # scope qos
switch-A /eth-server/qos # scope eth-best-effort
switch-A /eth-server/qos/eth-best-effort #

Related Commands Command Description


show eth-best-effort
show

Cisco UCS Manager CLI Command Reference, Release 2.0


866 OL-25718-02
Commands
scope eth-classified

scope eth-classified
To enter eth-classified mode, use the scope eth-classified command.

scope eth-classified {best-effort| bronze| gold| platinum| silver}

Syntax Description best-effort Specifies best effort mode.

bronze Specifies bronze classified mode.

gold Specifies gold classified mode.

platinum Specifies platinum classified mode.

silver Specifies silver classified mode.

Command Default None

Command Modes QoS (/eth-server/qos)

Command History Release Modification


1.0(1) This command was introduced.

Examples The following example shows how to enter eth-classified mode:

switch-A# eth-server

switch-A /eth-server # scope qos

switch-A /eth-server/qos # scope eth-classified

switch-A /eth-server/qos/eth-classified #

Related Commands Command Description


show eth-best-effort
show eth-classified

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 867
Commands
scope eth-if

scope eth-if
To view the Ethernet interface, use the scope eth-if command.

scope eth-if {Name}

Syntax Description Name Name of the Ethernet interface. This name can include a maximum of 32
alphanumeric characters.

Command Default None

Command Modes vNIC Template (/org/vnic-template)


vNIC (/org/service-profile/vnic)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines The name of the Ethernet interface can include a maximum of 32 characters and can be alphanumeric. Special
characters cannot be used.

Examples This example shows how to view the Ethernet interface information:
switch-A # scope org
switch-A # /org # scope vnic-templ
switch-A # /org/vnic-templ # scope eth-if
Word Name (Max Size 32)
switch-A # /org/vnic-templ # scope eth-if Sample
switch-A # /org/vnic-templ/eth-if #

Related Commands Command Description


scope eth-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


868 OL-25718-02
Commands
scope eth-if (vnic-iscsi)

scope eth-if (vnic-iscsi)


To enter the Ethernet interface mode for an iSCSI VNIC, use the scope eth-if command.

scope eth-if

This command has no arguments or keywords.

Command Default None

Command Modes iSCSI VNIC (/org/service-profile/vnic-iscsi)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a service profile and an iSCSI VNIC for the service profile before you use this command.

Examples This example shows how to enter the Ethernet interface mode for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-isci testing
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if #

Related Commands Command Description


create ip-if

create eth-if

enter eth-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 869
Commands
scope eth-mon-session

scope eth-mon-session
To enter the Ethernet monitoring session mode, use the scope eth-mon-session command.

scope eth-mon-session name

Syntax Description name Name of the Ethernet monitoring session. The name can include a maximum of 16
characters.

Command Default None

Command Modes Fabric (/eth-traffic-mon/fabric)


Ether traffic monitoring session (/eth-traffic-mon/fabric/eth-mon-session)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the Ethernet traffic monitoring session can include alphanumeric characters, but no special
characters are allowed.
An Ethernet traffic monitoring session must be created to use this command.

Examples This example shows how to enter the Ethernet traffic monitoring session mode:
UCS-A # scope eth-traffic-mon
UCS-A /eth-traffic-mon # scope fabric a
UCS-A /eth-traffic-mon/fabric # scope eth-mon-session Default
UCS-A /eth-traffic-mon/fabric/eth-mon-session #

Related Commands Command Description


create eth-mon-session
delete eth-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


870 OL-25718-02
Commands
scope eth-policy

scope eth-policy
To enter eth-policy mode, use the scope eth-policy command.

scope eth-policy policy-name

Syntax Description policy-name The name of the Ethernet policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter eth-policy mode using Ethernet policy ep100:

switch-A# scope org org100

switch-A /org # scope eth-policy ep100

switch-A /org/eth-policy #

Related Commands Command Description


show eth-policy
show trans-queue

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 871
Commands
scope eth-server

scope eth-server
To enter eth-server mode, use the scope eth-server command.

scope eth-server

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter eth-server mode:

switch-A#scope eth-server

switch-A /eth-server #

Related Commands Command Description


show interface
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


872 OL-25718-02
Commands
scope eth-storage

scope eth-storage
To enter the Ethernet storage mode, use the scope eth-storage command.

scope eth-storage

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode.

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None.

Examples This example shows how to enter the Ethernet storage mode from the chassis mode.
Switch-A # scope chassis 1
Switch-A /chassis # scope eth-storage
Switch-A /eth-storage #

Related Commands Command Description


create vlan
acknowledge fault
scope vlan
scope stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 873
Commands
scope eth-target

scope eth-target
To enter the Ethernet target endpoint mode for a fabric interface, use the scope eth-target command.

scope eth-target name

Syntax Description name Name of the Ethernet target endpoint.

Command Default None

Command Modes Interface (/eth-storage/fabric/interface)


Port channel within Ethernet storage command mode (/eth-storage/fabric/port-channel)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create an interface for a fabric, and an Ethernet target endpoint for that interface before you use
this command in the interface command mode.
You must create a port channel for a fabric in the Ethernet storage command mode before you use this
command.

Examples This example shows how to enter the Ethernet target endpoint for a fabric interface:
UCS-A # scope eth-storage
UCS-A /eth-storage # scope fabric a
UCS-A /eth-storage/fabric # scope interface 2 33
UCS-A /eth-storage/fabric/interface # scope eth-target Testing
UCS-A /eth-storage/fabric/interface/eth-target #

Related Commands Command Description


set macaddress
enter eth-target
show eth-target
delete eth-target
create eth-target

Cisco UCS Manager CLI Command Reference, Release 2.0


874 OL-25718-02
Commands
scope eth-traffic-mon

scope eth-traffic-mon
To enter the Ethernet traffic monitoring session mode, use the scope eth-traffic-mon command.

scope eth-traffic-mon

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the Ethernet traffic monitoring session mode:
Switch-A # scope adapter 1/1/1
Switch-A chassis/server/adapter # scope eth-traffic-mon
Switch-A /eth-traffic-mon #

Related Commands Command Description


scope eth-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 875
Commands
scope eth-uplink

scope eth-uplink
To enter eth-uplink mode, use the scope eth-uplink command.

scope eth-uplink

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter eth-uplink mode:

switch-A#scope eth-uplink

switch-A /eth-uplink #

Related Commands Command Description


show eth-uplink
show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


876 OL-25718-02
Commands
scope ext-eth-if

scope ext-eth-if
To enter the external Ethernet interface for an adapter, use the scope ext-eth-if command.

scope ext-eth-if {ID}

Syntax Description ID The ID of the external Ethernet interface. The value must be an integer 0 and
4294967295.

Command Default None

Command Modes Adapter (/chassis/server/adapter)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the external Ethernet interface for an adapter.
Switch-A # scope adapter 1/1/1
Switch-A /chassis/server/adapter # scope ext-eth-if 2
Switch-A /chassis/server/adapter/ext-eth-if #

Related Commands Command Description


acknowledge fault

set cli

show ext-eth-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 877
Commands
scope extension-key

scope extension-key
To enter extension-key mode, use the scope extension-key command in vm-mgmt mode.

scope extension-key

This command has no arguments or keywords.

Command Default None

Command Modes Extension key (/system/vm-mgmt/extension-key)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines You use extension key mode to :


• Set the master extension key
• Show events and finite state machines

Examples This example shows how to enter extension-key mode:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope extension-key
switch-A /system/vm-mgmt/extension-key #

Related Commands Command Description


show extension-key
show fsm

Cisco UCS Manager CLI Command Reference, Release 2.0


878 OL-25718-02
Commands
scope ext-pooled-ip

scope ext-pooled-ip
To enter the external management pooled IP address mode for a service profile, use the scope ext-pooled-ip
command.

scope ext-pooled-ip

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A service profile must be created and an external management pooled IP address must be set for this service
profile to use this command.

Examples This example shows how to enter the scope of the external management pooled IP address mode for a service
profile.
Switch-A # scope org
Switch-A /org # scope service-profile default
Switch-A /org/service-profile # scope ext-pooled-ip
Switch-A /org/service-profile/ext-pooled-ip #

Related Commands Command Description


create service-profile
set ext-mgmt-ip-state

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 879
Commands
scope ext-static-ip

scope ext-static-ip
To enter the external static management IP address mode, use the scope ext-static-ip command.

scope ext-static-ip

Command Default None

Command Modes CIMC (/chassis/server/cimc)


Service profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the external static management IP address mode for the CIMC.
Switch-A # scope server 1/7
Switch-A /chassis/server # scope cimc
Switch-A /chassis/server/cimc # scope ext-static-ip
Switch-A /chassis/server/cimc/ext-static-ip #

Related Commands Command Description


create ext-static-ip
enter ext-static-ip
show ext-static-ip
delete ext-static-ip

Cisco UCS Manager CLI Command Reference, Release 2.0


880 OL-25718-02
Commands
scope fabric

scope fabric
To enter fabric mode, use the scope fabric command.

scope fabric {a| b}

Syntax Description a Specifies switch A.

b Specifies switch B.

Command Default None

Command Modes Ethernet server (/eth-server)


Ethernet uplink (/eth-uplink)
Ethernet Traffic Monitoring (/eth-traffic-mon)
Fibre Channel uplink (/fc-uplink)
Fibre Channel Traffic Monitoring (/fc-traffic-mon)
Fibre Channel Storage (/fc-storage)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was introduced in the following modes:


Ethernet Traffic Monitoring (/eth-traffic-mon)
Fibre Channel Traffic Monitoring (/fc-traffic-mon)
Fibre Channel Storage (/fc-storage)

Usage Guidelines Use this command to enter fabric mode.

Examples This example shows how to enter Ethernet server fabric mode for fabric B:
switch-A# scope eth-server
switch-A /eth-server# scope fabric b
switch-A /eth-server/fabric #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 881
Commands
scope fabric

Related Commands Command Description


show fabric
show interface

Cisco UCS Manager CLI Command Reference, Release 2.0


882 OL-25718-02
Commands
scope fabric-if

scope fabric-if
To enter the fabric interface mode, use the scope fabric-if command.

scope fabric-if {ID}

Syntax Description ID Port ID of the fabric. The value must be an integer between 0 and 4294967295.

Command Default None

Command Modes Port group within a chassis (/chassis/iom/port-group)


Port group within a fabric extender module (/fex/iom/port-group)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines The Port ID must be an integer between 0 and 4294967295.

Examples This example shows how to enter the fabric interface mode of a chassis:
UCS-A # scope chassis 1
UCS-A /chassis # scope iom 1
UCS-A /chassis/iom # scope port-group fabric
UCS-A /chassis/iom/port-group # scope fabric-if 345

Related Commands Command Description


scope server-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 883
Commands
scope fabric-interconnect

scope fabric-interconnect
To enter fabric interconnect mode, use the scope fabric-interconnect command.

scope fabric-interconnect {a| b}

Syntax Description a Specifies switch A.

b Specifies switch B.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter fabric interconnect mode.

Examples This example shows how to enter fabric interconnect mode for fabric B:
switch-A# scope fabric-interconnect b
switch-A /fabric-interconnect #

Related Commands Command Description


show fabric

Cisco UCS Manager CLI Command Reference, Release 2.0


884 OL-25718-02
Commands
scope fabric-port-channel

scope fabric-port-channel
To enter the fabric port channel mode, use the scope fabric-port-channel command.

scope fabric-port-channel port channel id

Syntax Description port channel id The ID of the port channel interface. The value must be between 1024
and 4096.

Command Default None

Command Modes Fabric (/eth-server/fabric)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines A fabric port channel must be configured to use this command.

Examples This example shows how to enter the fabric port channel in the Ethernet server mode:
UCS-A # scope eth-server
UCS-A /eth-server # scope fabric a
UCS-A /eth-server/fabric # scope fabric-port-channel 1024
UCS-A /eth-server/fabric/fabric-port-channel #

Related Commands Command Description


show fabric-port-channel

scope host-port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 885
Commands
scope fan

scope fan
To enter the fan mode, use the scope fan command.

scope fan id

Syntax Description ID Identification number of the fan. It must be a number between 1 and 8.

Command Default None

Command Modes Fabric extender module (/fex)


Fabric interconnect module (/fabric-interconnect)
Fan module within a chassis (/chassis/fan-module)
Fan module within a fabric interconnect module (/fabric-interconnect/fan-module/)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the fan mode for a chassis:
Switch-A # scope chassis 1
Switch-A /chassis # scope fan-module 1 2
Switch-A /chassis/fan-module # scope fan 3
Switch-A /chassis/fan-module/fan #

Related Commands Command Description


show fan

Cisco UCS Manager CLI Command Reference, Release 2.0


886 OL-25718-02
Commands
scope fan-module

scope fan-module
To enter the fan module, use the scope fan-module command.

scope fan-module tray module

Syntax Description tray ID of the tray.

module ID of the module. It must be a number between 1 and 8.

Command Default None

Command Modes Chassis (/chassis)


Fabric interconnect module (/fabric-interconnect)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the fan module mode for a chassis:
Switch-A # scope chassis 1
Switch-A /chassis # scope fan-module 1 3
Switch-A /chassis/fan-module #

Related Commands Command Description


scope fan

show fan-module

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 887
Commands
scope fc

scope fc
To view and set Fibre Channel information, use the scope fc command.

scopefc{set| show}

Syntax Description set Use this option to set details such as Cos and weight.

show To view the Fibre Channel information.

Command Default None

Command Modes Ethernet Server (/eth-server/qos/fc)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines
• The range of valid values for setting cos is 0 to 6. You must select an integer between 0 and 6.
• The range of valid values for setting weight is 0-10. You must select an integer between 0 and 10.

Examples This example shows how to view the fibre channel information:
switch-A# scope eth-server
switch-A# /eth-server # scope qos
switch-A# /eth-server/qos # scope fc
switch-A# /eth-server/qos/fc # show
FC Class:
Priority: Fc
Cos: 3
Weight: 5
Bw Percent: 50
Drop: No Drop
Mtu: FC
Admin State: Enabled

Related Commands Command Description


show eth-best-effort

Cisco UCS Manager CLI Command Reference, Release 2.0


888 OL-25718-02
Commands
scope fc-mon-session

scope fc-mon-session
To enter the Fibre Channel traffic monitoring session mode, use the scope fc-mon-session command.

scope fc-mon-session Name

Syntax Description name Name of the monitoring session. The name can include a maximum of 16 characters.

Command Default None

Command Modes Fabric (/fc-traffic-mon/fabric)


Fibre channel traffic monitoring session (/fc-traffic-mon/fabric/fc-mon-session/)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The name of the monitoring session can be alphanumeric, but cannot include special characters.
You must configure a traffic monitoring session before you use this command.

Examples This example shows how to enter the Fibre Channel traffic monitoring session:
Switch-A # scope fc-traffic-mon
Switch-A /fc-traffic-mon # scope fabric b
Switch-A /fc-traffic-mon/fabric # scope fc-mon-session Default
Switch-A /fc-traffic-mon/fabric/fc-mon-session #

Related Commands Command Description


scope dest-interface

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 889
Commands
scope fc-policy

scope fc-policy
To enter fc-policy mode, use the scope fc-policy command.

scope fc-policy policy-name

Syntax Description policy-name The name of the Fibre Channel policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use fc-policy mode to perform the following tasks:


• Create and delete Fibre Channel policies
• Show Fibre Channel policies

Examples The following example shows how to enter fc-policy mode:


switch-A# scope org org100
switch-A /org # scope fc-policy fp100
switch-A /org # scope fc-policy fcp100
switch-A /org/fc-policy #

Related Commands Command Description


show fc-policy
show trans-queue

Cisco UCS Manager CLI Command Reference, Release 2.0


890 OL-25718-02
Commands
scope fc-storage

scope fc-storage
To enter the Fibre Channel storage mode, use the scope fc-storage command.

scope fc-storage

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the Fibre Channel storage mode from the service profile mode.
Switch-A # scope org
Switch-A /org # scope service-profile sample
Switch-A /org/service-profile # scope fc-storage
Switch-A /fc-storage #

Related Commands Command Description


create vsan
scope fabric
scope vsan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 891
Commands
scope fc-traffic-mon

scope fc-traffic-mon
To enter the Fibre Channel traffic monitoring mode, use the scope fc-traffic-mon command.

scope fc-traffic-mon

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the Fibre Channel traffic monitoring mode:
Switch-A # scope adapter 1/1/1
Switch-A chassis/server/adapter # scope fc-traffic-mon
Switch-A /fc-traffic-mon #

Related Commands Command Description


scope fc-mon-session
create fc-mon-session
delete fc-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


892 OL-25718-02
Commands
scope fc-uplink

scope fc-uplink
To enter fc-uplink mode, use the scope fc-uplink command.

scope fc-uplink

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter fc-uplink mode:

switch-A# scope fc-uplink

switch-A /fc-uplink #

Related Commands Command Description


show interface
show vlan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 893
Commands
scope fex

scope fex
To enter the Fabric extender module, use the scope fex command.

scope fex id

Syntax Description id The ID of the Fabric extender module. The value must be a numeral.

Command Default None

Command Modes Any command mode.

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the fabric extender module from the adapter mode.
Switch-A # scope adapter 1/1
Switch-A /server/adapter # scope fex 2
Switch-A /fex #

Related Commands Command Description


scope fan
scope iom
scope psu

Cisco UCS Manager CLI Command Reference, Release 2.0


894 OL-25718-02
Commands
scope firmware

scope firmware
To enter firmware mode, use the scope firmware command.

scope firmware

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter firmware mode:

switch-A# scope firmware

switch-A /firmware #

Related Commands Command Description


show firmware
show version

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 895
Commands
scope flow-control

scope flow-control
To enter flow control mode, use the scope flow-control command.

scope flow-control

This command has no arguments or keywords.

Command Default None

Command Modes Ethernet uplink (/eth-uplink)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter flow control mode:

switch-A# scope eth-uplink

switch-A /eth-uplink # scope flow-control

switch-A /eth-uplink/flow-control #

Related Commands Command Description


show policy
show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


896 OL-25718-02
Commands
scope folder

scope folder
To enter folder mode, use the scope folder command in vcenter mode.

scope folder folder-name

Syntax Description folder-name The name of the folder.

Command Default None

Command Modes Data center (/system/vm-mgmt/vmware/vcenter/folder)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use folder mode to perform the following tasks:


• Create and delete data centers
• Show data center information

Examples This example shows how to enter data center mode:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc1
switch-A /system/vm-mgmt/vmware/vcenter # scope folder f1
switch-A /system/vm-mgmt/vmware/vcenter/folder #

Related Commands Command Description


show folder
show vcenter

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 897
Commands
scope fw-host-pack

scope fw-host-pack
To view the server host pack, use the scope fw-host-pack command.

scope fw-host-pack {Name}

Syntax Description Name The name of the server host pack. This name can include a maximum of 16
characters.

Command Default None

Command Modes Organization (org)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines The name of the server host pack can include a maximum of 16 characters. It should not include any special
characters.

Examples This example shows how to view the server host pack.
switch-A # scope org
switch-A # /org # scope fw-host-pack ?
Word Name (Max size 16)
switch-A # /org # scope fw-host-pack fhpl
switch-A # /org/fw-host-pack #

Related Commands Command Description


show fw-host-pack

Cisco UCS Manager CLI Command Reference, Release 2.0


898 OL-25718-02
Commands
scope fw-mgmt-pack

scope fw-mgmt-pack
To view the server management pack details, use the scope fw-mgmt-pack command.

scope fw-mgmt-pack {Name}

Syntax Description Name The name of the server management pack. This name can include a maximum of
16 characters.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines The name of the server management pack can include upto 16 characters only. The name can include
alphanumeric characters, but special characters are not allowed.

Examples This example shows how to view the server management pack.
switch-A # scope org
switch-A /org # scope fw-mgmt-pack ?
Word Name (Max size 16)
switch-A /org # scope fw-mgmt-pack Fhpl123
switch-A /org/fw-mgmt-pack #

Related Commands Command Description


show fw-mgmt-pack

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 899
Commands
scope host-eth-if

scope host-eth-if
To view the Ethernet interface information of the adapter, use the scope host-eth-if command.

scope host-eth-if ID

Syntax Description ID An integer. Range of valid values is 0 to 4294967295.

Command Default None

Command Modes Adapter (/chassis/server/adapter)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines The ID must be an integer. Alphanumeric characters are not allowed.

Examples This example shows how to view the Ethernet information of the host:
Switch-A # scope adapter 1/1/1
Switch-A /chassis/server/adapter # scope host-eth-if 2
Switch-A /chassis/server/adapter/host-eth-if #

Related Commands Command Description


scope ext-eth-if

Cisco UCS Manager CLI Command Reference, Release 2.0


900 OL-25718-02
Commands
scope host-eth-if dynamic-mac

scope host-eth-if dynamic-mac


To view the host Ethernet interface information of a specific device, use the scope host-eth-if dynamic-mac
command.

scope host-eth-if dynamic-mac dynamic MAC address

Syntax Description dynamic MAC address Enter the MAC address of the host Ethernet interface.
The standard format of the MAC address is hh:hh:hh:hh:hh:hh.

Command Default None

Command Modes Host Ethernet Interface (chassis/server/adapter/host-eth-if)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines The dynamic MAC address must be entered in the standard hh:hh:hh:hh:hh:hh format.

Examples This example shows how to view the host Ethernet interface information of a particular device:
Switch-A # scope adapter 1/1/1
Switch-A /chassis/server/adapter # scope host-eth-if 2
Switch-A /chassis/server/adapter/host-eth-if # scope host-eth-if dynamic-mac 00:1B:50:35:56:99
Switch-A /chassis/server/adapter/host-eth-if #

Related Commands Command Description


show host-eth-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 901
Commands
scope host-fc-if

scope host-fc-if
To view the Fibre Channel information of the host interface, use the scope host-fc-if command.

scope host-fc-if ID

Syntax Description ID The range of valid values is 0 to 4294967295.

Command Default None

Command Modes Adapter (chassis/server/adapter)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines The ID is an integer and the range of valid values is between 0 to 4294967295.

Examples This example shows how to view the Fibre Channel information of the host interface:
Switch-A # scope adapter 1/1/1
Switch-A /chassis/server/adapter # scope host-fc-if 2
Switch-A /chassis/server/adapter/host-fc-if #

Related Commands Command Description


scope host-fc-if wwn

Cisco UCS Manager CLI Command Reference, Release 2.0


902 OL-25718-02
Commands
scope host-fc-if wwn

scope host-fc-if wwn


To enter the worldwide name mode of the Fibre Channel host, use the scope host-fc-if wwn command.

scope host-fc-if wwn

Syntax Description wwn Worldwide Name. The valid value is a 64-bit alphanumeric string.

Command Default None

Command Modes Adapter (chassis/server/adapter/host-fc-if)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines The WWN must be a valid 64-bit alphanumeric string.

Examples This example shows how to view the Fibre Channel interface information of a particular device:
Switch-A # scope adapter 1/1/1
Switch-A /chassis/server/adapter # scope host-fc-if wwn 01:23:45:67:89:ab:cd:ef
Switch-A /chassis/server/adapter/host-fc-if #

Related Commands Command Description


show host-fc-if wwn

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 903
Commands
scope host-iscsi-if

scope host-iscsi-if
To enter the host iSCSI interface mode, use the scope host-iscsi-if command.

scope host-iscsi-if ID

Syntax Description ID Identification number of the host iSCSI interface. It must be a value between 0 and
4294967295.

Command Default None

Command Modes Adapter within the chassis mode (/chassis/server/adapter)


Adapter within the server mode (/server/adapter)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create the host iSCSI interface before you use this command.

Examples This example shows how to enter the host iSCSI interface mode for an adapter:
UCS-A # scope adapter 1/1/1
UCS-A /chassis/server/adapter # scope host-iscsi-if 2
UCS-A /chassis/server/adapter/host-iscsi-if #

Related Commands Command Description


show host-iscsi-if

Cisco UCS Manager CLI Command Reference, Release 2.0


904 OL-25718-02
Commands
scope host-port-channel

scope host-port-channel
To enter the host port channel mode, use the scope host-port-channel command.

scope host-port-channel port channel id

Syntax Description port channel id The port channel ID. The value must be between 1024 and 4096.

Command Default None

Command Modes Fabric within the Ethernet server mode (/eth-server/fabric)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines The host port channels must be available to use this command.

Examples This example shows how to enter the host port channel mode for a fabric within the Ethernet server mode:
UCS-A # scope eth-server
UCS-A /eth-server # scope fabric a
UCS-A /eth-server/fabric # scope host-port-channel 1023
UCS-A /eth-server/fabric/host-port-channel #

Related Commands Command Description


show host-port-channel

scope fabric-port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 905
Commands
scope import-config

scope import-config
To enter import configuration mode, use the scope import-config command.

scope import-config name

Syntax Description name Import configuration name.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter import configuration mode:

switch-A# scope system

switch-A /system # scope import-config ic10

switch-A /system/import-config #

Related Commands Command Description


show import-config
show managed-entity

Cisco UCS Manager CLI Command Reference, Release 2.0


906 OL-25718-02
Commands
scope instance

scope instance
To enter instance mode, use the scope instance command in vm-mgmt mode.

scope instance uuid

Syntax Description uuid The UUID of the instance. The format is


NNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN.

Command Default None

Command Modes Instance (/system/vm-mgmt/instance)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use instance mode to perform the following tasks:


•?
•?

Examples This example shows how to enter instance mode:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope instance 700c4760-da08-11de-8a39-0800200c9a66
switch-A /system/vm-mgmt/instance #

Related Commands Command Description


show ?
show ?

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 907
Commands
scope interface

scope interface
To view the Ethernet interface information of the fabric, use the scope interface command.

scope interface {slot ID | port id}

Syntax Description slot ID The ID of the slot. It must be a number between 1 and 5.

port ID The ID of the port. It must be a number between 1 and 40.

Command Default None

Command Modes Ethernet Uplink (/eth-uplink/fabric)


Ethernet Server (/eth-server/fabric)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines The Slot ID must be a number between 1 and 5. You cannot enter any alphanumeric or special characters.
The Port ID must be a number between 1 and 40. You cannot enter any alphanumeric or special characters.

Examples This example shows how to view the interface information for the Ethernet Uplink:
Switch-A # scope eth-uplink
Switch-A /eth-uplink # scope fabric a
Switch-A /eth-uplink/fabric # scope interface
1-5 Slot ID
Switch-A /eth-uplink/fabric # scope interface 2
1-40 Port ID
Switch-A /eth-uplink/fabric # scope interface 2 33
Switch-A /eth-uplink/fabric/interface #

Related Commands Command Description


scope eth-uplink

Cisco UCS Manager CLI Command Reference, Release 2.0


908 OL-25718-02
Commands
scope interface fc

scope interface fc
To enter the fibre channel interface for a fabric, use the scope interface fc command.

scope interface fc slot id port id

Syntax Description slot id The slot identification number. The range of valid values is between 2 and 5.

port id The port identification number. The range of valid values is between 1 and 40.

Command Default None

Command Modes Fabric (/fc-storage/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A fibre channel interface for the fabric must be created to use this command.

Examples This example shows how to enter the fibre channel interface for a fabric.
Switch-A # scope fc-storage
Switch-A /fc-storage # scope fabric a
Switch-A /fc-storage/fabric # scope interface fc 2 33
Switch-A /fc-storage/fabric/fc #

Related Commands Command Description


create interface fc
enter interface fc
show interface fc
delete interface fc

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 909
Commands
scope interface fcoe

scope interface fcoe


To enter the Fibre Channel over Ethernet mode for a fabric, use the scope interface fcoe command.

scope interface fcoe slot id port id

Syntax Description slot id The slot identification number.

port id The port identification number.

Command Default None

Command Modes Fabric (/fc-storage/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A Fibre Channel over Ethernet interface for a fabric must be created to use this command.

Examples This example shows how to enter the Fibre Channel over Ethernet interface for a fabric.
Switch-A # scope fc-storage
Switch-A /fc-storage # scope fabric a
Switch-A /fc-storage/fabric # scope interface fcoe 2 33
Switch-A /fc-storage/fabric/fcoe #

Related Commands Command Description


create interface fcoe
enter interface fcoe
show interface fcoe
delete interface fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


910 OL-25718-02
Commands
scope inventory

scope inventory
To view the Callhome periodic system inventory information, use the scope inventory command.

scope inventory

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Periodic system inventory (/monitoring/callhome/periodic-system-inventory)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to view the periodic system inventory.

Examples This example shows how to view the periodic system inventory information:
switch-A # scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # scope inventory
switch-A /monitoring/callhome/inventory #

Related Commands Command Description


scope policy

scope profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 911
Commands
scope iom (/chassis)

scope iom (/chassis)


To enter iom mode for a chassis, use the scope iom command.

scope iom {id | a| b}

Syntax Description id Module identification number.

a Specifies switch A.

b Specifies switch B.

Command Default None

Command Modes Chassis (/chassis)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter iom mode:

switch-A# scope chassis 1

switch-A /chassis # scope iom 1

switch-A /chassis/iom #

Related Commands Command Description


scope iom (/capability)

show iom
show slot

Cisco UCS Manager CLI Command Reference, Release 2.0


912 OL-25718-02
Commands
scope iom (/capability)

scope iom (/capability)


To enter the IOM mode of a system, use the scope iom command.

scope iom vendor model hw-rev

Syntax Description vendor Vendor name. The name can include a maximum of 510 characters.

model Model number. The number can include a maximum of 510


characters.

hw-rev Hardware revision. The number can include a maximum of 510


characters.

Command Default None

Command Modes Capability (/system/capability)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the IOM mode for a system.
Switch-A # scope system
Switch-A /system # scope capability
Switch-A /system/capability # scope iom Cisco Systems Inc N20-I6583 0
Switch-A /system/capability/iom #

Related Commands Command Description


scope iom

show iom

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 913
Commands
scope iom (/fex)

scope iom (/fex)


To enter the IO module mode, use the scope iom command.

scope iom id

Syntax Description id ID of the IO module.

Command Default None

Command Modes Fabric-extender module (/fex)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the IO module mode:


UCS-A # scope fex 1
UCS-A /fex # scope iom 2
UCS-A /fex/iom #

Related Commands Command Description


scope fex

Cisco UCS Manager CLI Command Reference, Release 2.0


914 OL-25718-02
Commands
scope ip-if

scope ip-if
To enter the IPv4 interface mode of the iSCSI VNIC, use the scope ip-if command.

scope ip-if

This command has no arguments or keywords.

Command Default None

Command Modes Ethernet interface within the iSCSI VNIC mode (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an IPv4 target interface before you use this command.

Examples This example shows how to enter the IPv4 target interface for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi example
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if #

Related Commands Command Description


create dhcp-ip-params

create pooled-ip-params

create static-ip-params

create ip-if

enter ip-if

delete ip-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 915
Commands
scope ipmi-access-profile

scope ipmi-access-profile
To enter IPMI access profile mode, use the scope ipmi-access-profile command.

scope ipmi-access-profile name

Syntax Description name Access profile name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples The following example shows how to enter IPMI access profile mode:

switch-A# scope org org10

switch-A /org # scope ipmi-access-profile ipmiAP10

switch-A /org/ipmi-access-profile #

Related Commands Command Description


show epuser
show ipmi-access-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


916 OL-25718-02
Commands
scope ipmi-user

scope ipmi-user
To change the mode to the IPMI user, use the scope ipmi-user command.

scope ipmi-user {User Name}

Syntax Description User Name Name of the IPMI user.

Command Default None

Command Modes IPMI Access Profile (/org/ipmi-access-profile/)

Command History Release Modification


1.3(1) This command was introduced as scope epuser.

1.4(1) This command was renamed as scope ipmi-user.

Usage Guidelines The name of the IPMI user can be alphanumeric, but cannot contain any special characters.

Examples This example shows how to change the mode to the IPMI user:
switch-A # scope org
switch-A /org # scope ipmi-access-profile Sample
switch-A /org/ipmi-access-profile # scope ipmi-user Example
switch-A /org/ipmi-access-profile/ipmi-user #

Related Commands Command Description


create ipmi-user

enter ipmi-user

delete ipmi-user

set descr

set password

set privilege

show ipmi-access profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 917
Commands
scope iqn-pool

scope iqn-pool
To change the command mode to the IQN pool mode, use the scope iqn-pool command.

scope iqn-pool name

Syntax Description name Name of the IQN pool name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines An IQN pool must be created to use this command.

Examples This example shows how to change the command mode to IQN pool mode.
UCS-A # scope org
UCS-A /org # scope iqn-pool Sample1
UCS-A /org/iqn-pool #

Related Commands Command Description


create iqn-pool

enter iqn-pool

show iqn-pool

delete iqn-pool

set iqn-prefix

set descr

create block

Cisco UCS Manager CLI Command Reference, Release 2.0


918 OL-25718-02
Commands
scope iscsi-policy

scope iscsi-policy
To enter the iSCSI adapter policy mode for the organization, use the scope iscsi-policy command.

scope iscsi-policy name

Syntax Description name Name of the iSCSI adapter policy. It is the name that you provided when you created
the iSCSI adapter policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI policy before you use this command.

Examples This example shows how to enter the iSCSI adapter policy mode for an organization:
UCS-A # scope org test
UCS-A /org # scope iscsi-policy sample
UCS-A /org/iscsi-policy #

Related Commands Command Description


create iscsi-policy

enter iscsi-policy

show iscsi-policy

delete iscsi-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 919
Commands
scope iscsi

scope iscsi
To enter the boot iSCSI mode, use the scope iscsi command.

scope iscsi

This command has no arguments or keywords.

Command Default None

Command Modes Boot definition for a service profile (/org/service-profile/boot-definition)


Boot policy (/org/boot-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a boot iSCSI policy before you use this command.

Examples This example shows how to enter the boot iSCSI mode for the boot definition of a service profile:
UCS-A # scope org Sample
UCS-A /org # scope service-profile test
UCS-A /org/service-profile # scope boot-definition
UCS-A /org/service-profile/boot-definition # scope iscsi
UCS-A /org/service-profile/boot-definition/iscsi #

Related Commands Command Description


create iscsi

delete iscsi

enter iscsi

show iscsi

Cisco UCS Manager CLI Command Reference, Release 2.0


920 OL-25718-02
Commands
scope lan

scope lan
To view information on the boot LAN, use the scope lan command.

scope lan

Syntax Description
This command has no arguments or keywords.

Command Default None.

Command Modes Boot Policy (/org/boot-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to view the boot LAN information.

Examples This example shows how to view the boot LAN information:
switch-A # scope org
switch-A /org # scope boot-policy Example
switch-A /org/boot-policy # scope lan

Related Commands Command Description


scope storage

scope virtual-media

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 921
Commands
scope ldap

scope ldap
To enter LDAP mode, use the scope ldap command.

scope ldap

This command has no arguments or keywords.

Command Default None

Command Modes LDAP (/security/ldap)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter LDAP mode:

switch-A#scope security

switch-A /security # scope ldap

switch-A /security/ldap #

Related Commands Command Description


show ldap
show tacacs

Cisco UCS Manager CLI Command Reference, Release 2.0


922 OL-25718-02
Commands
scope ldap-group

scope ldap-group
To enter the LDAP group mode, use the scope ldap-group command.

scope ldap-group Group DN

Syntax Description Group DN Name of the LDAP group.

Command Default None

Command Modes LDAP (/security/ldap)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An LDAP group must be created to use this command.

Examples This example shows how to enter the LDAP group mode:
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope ldap-group Sample
Switch-A /security/ldap/ldap-group #

Related Commands Command Description


create ldap-group
delete ldap-group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 923
Commands
scope ldap-group-rule

scope ldap-group-rule
To enter the LDAP group rule mode, use the scope ldap-group-rule command.

scope ldap-group-rule

Command Default None

Command Modes LDAP (/security/ldap)


Server (/security/ldap/server)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines To use this command in the server mode, an LDAP server must be created to use this command.

Examples This example shows how to enter the LDAP group rule mode for an LDAP server.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope server Sample
Switch-A /security/ldap/server # scope ldap-group-rule
Switch-A /security/ldap/server/ldap-group-rule #

Related Commands Command Description


create ldap-group-rule
enter ldap-group-rule
delete ldap-group-rule

Cisco UCS Manager CLI Command Reference, Release 2.0


924 OL-25718-02
Commands
scope license

scope license
To enter the license mode, use the scope license command.

scope license

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode.

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the license mode from the adapter mode.
Switch-A # scope adapter 1/1
Switch-A /server/adapter # scope license
Switch-A /license #

Related Commands Command Description


scope download-task
install file
clear file

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 925
Commands
scope locale

scope locale
To enter locale mode, use the scope locale command.

scope locale name

Syntax Description name Locale name.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter locale mode:

switch-A#scope security

switch-A /security # scope locale

switch-A /security/locale #

Related Commands Command Description


show locale
show remote-user

Cisco UCS Manager CLI Command Reference, Release 2.0


926 OL-25718-02
Commands
scope local-disk-config

scope local-disk-config
To enter the local disk configuration mode, use the scope local-disk-config command.

scope local-disk-config

This command has no arguments or keywords.

Command Default None

Command Modes RAID Controller (/chassis/server/raid-controller)


Service Profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the local disk configuration mode for the RAID controller of a server.
Switch-A # scope server 1/1
Switch-A /chassis/server # scope raid-controller 1 Sas
Switch-A /chassis/server/raid-controller # scope local-disk-config
Switch-A /chassis/server/raid-controller/local-disk-config #

Related Commands Command Description


show local-disk-config

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 927
Commands
scope lun

scope lun
To enter the logical unit number (LUN) mode for a server, use the scope lun command.

scope lun id

Syntax Description ID The ID of the logical unit number. It must be a value between 0 and 4294967297.

Command Default None

Command Modes RAID Controller (/chassis/server/raid-controller)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the logical unit number mode for a RAID controller.
Switch-A # scope server 1/1
Switch-A /chassis/server # scope raid-controller 1 Sas
Switch-A /chassis/server/raid-controller # scope lun 1
Switch-A /chassis/server/raid-controller/lun #

Related Commands Command Description


scope local-disk-config

show lun

Cisco UCS Manager CLI Command Reference, Release 2.0


928 OL-25718-02
Commands
scope lun (static-target-if)

scope lun (static-target-if)


To enter the LUN mode for an iSCSI VNIC, use the scope lun command.

scope lun

This command has no arguments or keywords.

Command Default None

Command Modes Static target interface priority (/org/service-profile/vnic-iscsi/eth-if/static-target-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a static target interface priority for an iSCSI VNIC before you use this command.

Examples This example shows how to enter the LUN mode for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope static-target-if 1
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if # scope lun
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if #

Related Commands Command Description


set auth-name

set ipaddress

set name

set port

create lun

enter lun

show lun

delete lun

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 929
Commands
scope mac-security

scope mac-security
To enter the MAC security mode for a network control policy, use the scope mac-security command.

scope mac-security

This command has no arguments or keywords.

Command Default None

Command Modes Network Control Policy (/org/nw-ctrl-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A network control policy for an organization must be created to use this command.

Examples This example shows how to enter the MAC security mode for a network control policy for an organization.
Switch-A # scope org Test
Switch-A /org # scope nw-ctrl-policy Sample
Switch-A /org/nw-ctrl-policy # scope mac-security
Switch-A /org/nw-ctrl-policy/mac-security #

Related Commands Command Description


set forged-transmit

show mac-security

Cisco UCS Manager CLI Command Reference, Release 2.0


930 OL-25718-02
Commands
scope maint-policy

scope maint-policy
To enter the maintenance policy mode, use the scope maint-policy command.

scope maint-policy Name

Syntax Description Name The name of the maintenance policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A maintenance policy must be created to use this command.

Examples This example shows how to enter the maintenance policy mode.
Switch-A # scope org
Switch-A /org # scope maint-policy Default
Switch-A /org/maint-policy #

Related Commands Command Description


enter maint-policy
delete maint-policy
show maint-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 931
Commands
scope management-extension

scope management-extension
To enter the management extension mode for the system, use the scope management-extension command.

scope management-extension

This command has no arguments or keywords.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the management extension mode for a system.
Switch-A # scope system
Switch-A /system # scope management-extension
Switch-A /system/management-extension #

Related Commands Command Description


activate firmware version
scope backup
scope capability
scope import-config
scope managed-entity
scope scheduler
scope server-default
scope services
scope vm-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


932 OL-25718-02
Commands
scope member-port-channel

scope member-port-channel
To enter the member port channel mode, use the scope member-port-channel command.

scope member-port-channel {a| b} port channel id

Syntax Description a Specifies port A.

b Specifies port B.

port channel id Port channel ID.

Command Default None

Command Modes VSAN (/fc-uplink/vsan)


VSAN under fabric (/fc-uplink/fabric/vsan)
VLAN within Ethernet storage (/eth-storage/vlan)
VLAN within a fabric in the Ethernet storage (/eth-storage/fabric/vlan)
VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within a fabric in Ethernet uplink (/eth-uplink/fabric/vlan)

Command History Release Modification


1.4(1) This command was introduced.

2.0(1) This command was introduced in Ethernet uplink mode (/eth-uplink/vlan and
/eth-uplink/fabric/vlan).

Usage Guidelines You must create a VSAN or a VLAN and a member port channel before you use this command.

Examples This example shows how to enter the member port channel for VSAN:
Switch-A # scope fc-uplink
Switch-A /fc-uplink # scope fabric a
Switch-A /fc-uplink/fabric # scope vsan default
Switch-a /fc-uplink/fabric/vsan # scope member-port-channel a 22
Switch-a /fc-uplink/fabric/vsan/member-port-channel #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 933
Commands
scope member-port-channel

Related Commands Command Description


create member-port-channel
enter member-port-channel
show member-port-channel
delete member-port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


934 OL-25718-02
Commands
scope member-port

scope member-port
To enter the member port command mode, use the scope member-port command.

scope member-port {a| b} slot-id port-id

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number.

port-id Port identification number.

Command Default None

Command Modes VLAN within Ethernet storage (/eth-storage/vlan)


VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within a fabric in the Ethernet uplink mode (/eth-uplink/fabric/vlan)
VSAN within the Fibre Channel uplink mode (/fc-uplink/vsan)
VSAN within the fabric interconnect mode (/fc-uplink/fabric/vsan)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was introduced in the Ethernet storage


command mode.

2.0(1) This command was introduced in the Ethernet uplink


command mode.

Usage Guidelines You must create member ports before you use this command.

Examples This example shows how to enter the member port command mode:
UCS-A # scope eth-storage
UCS-A /eth-storage # scope vlan sample
UCS-A /eth-storage/vlan # scope member-port a 1 22
UCS-A /eth-storage/vlan/member-port #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 935
Commands
scope member-port

Related Commands Command Description


create member-port

enter member-port

show member-port

delete member-port

Cisco UCS Manager CLI Command Reference, Release 2.0


936 OL-25718-02
Commands
scope member-port fc

scope member-port fc
To enter the Fibre Channel member port command mode, use the scope member-port fc command.

scope member-port fc {a| b}slot-id port-id

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number.

port-id Port identification number.

Command Default None

Command Modes VSAN within the Fibre Channel storage mode (/fc-storage/vsan)
VSAN within a fabric in the Fibre Channel storage mode (/fc-storage/fabric/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create Fibre Channel member ports before you use this command.

Examples This example shows how to enter the Fibre Channel member port command mode:
UCS-A # scope fc-storage
UCS-A /fc-storage # scope vsan sample
UCS-A /fc-storage/vsan # scope member-port fc a 1 22
UCS-A /fc-storage/vsan/member-port #

Related Commands Command Description


create member-port fc

enter member-port fc

show member-port fc

delete member-port fc

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 937
Commands
scope member-port fcoe

scope member-port fcoe


To enter the Fibre Channel over Ethernet member port command mode, use the scope member-port fcoe
command.

scope member-port fcoe {a| b} slot-id port-id

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number. The value must be between 1 and 5.

port-id Port identification number. The value must be between 1 and 256.

Command Default None

Command Modes VSAN within the Fibre Channel storage command mode (/fc-storage/vsan)
VSAN within a fabric (/fc-storage/fabric/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create Fibre Channel over Ethernet member ports before you use this command.

Examples This example shows how to enter the Fibre Channel over Ethernet member ports command mode:
UCS-A # scope fc-storage
UCS-A /fc-storage # scope vsan sample
UCS-A /fc-storage/vsan # scope member-port fcoe 1 233
UCS-A /fc-storage/vsan/member-port #

Related Commands Command Description


create member-port fcoe

enter member-port fcoe

show member-port fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


938 OL-25718-02
Commands
scope member-port fcoe

Command Description
delete member-port fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 939
Commands
scope memory-array

scope memory-array
To enter the memory array mode for a server, use the scope memory-array command.

scope memory-array {ID}

Syntax Description ID The ID of the memory array. The value must be an integer between 1 and 8.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the memory array mode for a server.
Switch-A # scope server 1/1
Switch-A /chassis/server # scope memory-array 2
Switch-A /chassis/server/memory-array #

Related Commands Command Description


scope dimm

acknowledge fault

Cisco UCS Manager CLI Command Reference, Release 2.0


940 OL-25718-02
Commands
scope mon-flt

scope mon-flt
To enter the monitor filter mode, use the scope mon-flt command.

scope mon-flt name

Syntax Description name The name of the monitor filter.

Command Default None

Command Modes VSAN under Fibre Channel uplink (/fc-uplink/vsan)


VSAN under Fabric within Fibre Channel uplink (/fc-uplink/fabric/vsan)
VLAN under Ethernet Uplink (/eth-uplink/vlan)
VLAN under Fabric within Ethernet Uplink (/eth-uplink/fabric/vlan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines To use this command within a fabric, either a VLAN or a VSAN must be created.

Examples This example shows how to enter the monitor filter mode for a VSAN under Fibre Channel mode.
Switch-A # scope fc-uplink
Switch-A /fc-uplink # scope fabric b
Switch-A /fc-uplink/fabric # scope vsan test200
Switch-A /fc-uplink/fabric/vsan # scope mon-flt
Switch-A /fc-uplink/fabric/vsan/mon-flt #

Related Commands Command Description


create vsan
create vlan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 941
Commands
scope monitoring

scope monitoring
To enter monitoring mode, use the scope monitoring command.

scope monitoring

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter monitoring mode:

switch-A#scope monitoring

switch-A /monitoring #

Related Commands Command Description


show callhome
show syslog

Cisco UCS Manager CLI Command Reference, Release 2.0


942 OL-25718-02
Commands
scope mon-src

scope mon-src
To enter the monitor source session mode, use the scope mon-src command.

scope mon-src session name

Syntax Description session name The name of the monitor source session.

Command Default None

Command Modes External Ethernet Interface (/chassis/server/adapter/ext-eth-if)


Fibre Channel interface within Fibre Channel storage (/fc-storage/fabric/fc)
Fibre Channel over Ethernet interface within fabric (/fc-storage/fabric/fcoe)
Interface within Ethernet uplink (/eth-uplink/fabric/interface)
Interface within Fibre Channel uplink (/fc-uplink/fabric/interface)
Port channel within Ethernet uplink (/eth-uplink/fabric/port-channel)
Port channel within Fibre Channel uplink (/fc-uplink/fabric/port-channel)
VHBA within service profile (/org/service-profile/vhba)
VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within Ethernet uplink (/eth-uplink/fabric/vlan)
VNIC within service profile (/org/service-profile/vnic)
VSAN within Fibre Channel Uplink (/fc-uplink/fabric/vsan)
VSAN within Fibre Channel uplink (/fc-uplink/vsan)
VSAN within Fibre Channel Storage (/fc-storage/fabric/vsan)
VSAN within Fibre Channel storage (/fc-storage/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The monitor source session must be created to use this command.

Examples This example shows how to enter the monitor source session mode for a VNIC in a service profile.
Switch-A # scope org
Switch-A /org # scope service-profile sample

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 943
Commands
scope mon-src

Switch-A /org/service-profile # scope vnic example


Switch-A /org/service-profile/vnic # scope mon-src testing
Switch-A /org/service-profile/vnic/mon-src #

Related Commands Command Description


set direction
create mon-src
enter mon-src
show mon-src
delete mon-src

Cisco UCS Manager CLI Command Reference, Release 2.0


944 OL-25718-02
Commands
scope network

scope network
To enter network mode, use the scope network command in port-profile mode.

scope network network-name

Syntax Description network-name The name of the network.

Command Default None

Command Modes Port profile (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use network mode to enable or disable the default network.

Examples This example shows how to enter network mode:


switch-A # scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope profile-set
switch-A /system/vm-mgmt/vmware/profile-set # scope port-profile pp100
switch-A /system/vm-mgmt/vmware/profile-set # scope network n100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile/network #

Related Commands Command Description


show network
show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 945
Commands
scope nw-ctrl-policy

scope nw-ctrl-policy
To enter network control policy mode, use the scope nw-ctrl-policy command.

scope nw-ctrl-policy name

Syntax Description name Name of the network control policy.

Command Default None

Command Modes Organization (/org)


Ethernet storage (/eth-storage)

Command History Release Modification


1.0(2) This command was introduced.

1.4(1) This command was introduced in the Ethernet storage command mode.

Usage Guidelines You must create a network control policy before you use this command.

Examples This example shows how to enter network control policy mode:
UCS-A# scope org org10
UCS-A /org/ # scope nw-ctrl-policy nCP10
UCS-A /org/nw-ctrl-policy #

Related Commands Command Description


show nw-ctrl-policy

create nw-ctrl-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


946 OL-25718-02
Commands
scope occurrence one-time

scope occurrence one-time


To enter the one-time occurrence mode for a schedule, use the scope occurrence one-time command.

scope occurrence one-time name

Syntax Description name The name of the one-time occurrence instance.

Command Default None

Command Modes Schedule (/system/schedule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A schedule and a one-time occurrence instance for the schedule must be created to use this command.

Examples This example shows how to enter the one-time occurrence mode for a schedule.
Switch-A # scope system
Switch-A /system # scope schedule Sample
Switch-A /system/schedule # scope occurrence one-time Trial
Switch-A /system/schedule/one-time #

Related Commands Command Description


create occurrence one-time
enter occurrence one-time
show occurrence one-time
delete occurrence one-time

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 947
Commands
scope occurrence recurring

scope occurrence recurring


To enter the recurring occurrence mode for a schedule, mode, use the scope occurrence recurring command.

scope occurrence recurring name

Syntax Description name The name of the recurring occurrence instance for the schedule.

Command Default None

Command Modes Schedule (/system/schedule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A schedule and the recurring occurrence instance for that schedule must be created to use this command.

Examples This example shows how to enter the recurring occurrence mode for a schedule.
Switch-A # scope system
Switch-A /system # scope schedule Default
Switch-A /system/schedule # scope occurrence recurring Trial
Switch-A /system/schedule/recurring #

Related Commands Command Description


create occurrence recurring
enter occurrence recurring
show occurrence recurring
delete occurrence recurring

Cisco UCS Manager CLI Command Reference, Release 2.0


948 OL-25718-02
Commands
scope org

scope org
To enter org mode, use the scope org command.

scope org [org-name]

Syntax Description name (Optional) Organization name.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter org mode:


switch-A# scope org org100
switch-A /org #

Related Commands Command Description


show mac-pool
show org

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 949
Commands
scope password-profile

scope password-profile
To enter the password profile mode, use the scope password-profile command.

scope password-profile

This command has no arguments or keywords.

Command Default None

Command Modes Security (/security)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must be an administrator user or have aaa privileges to use this command.

Examples This example shows how to enter the password profile mode:
UCS-A # scope security
UCS-A /security # scope password-profile
UCS-A /security/password-profile #

Related Commands Command Description


set change-count

set change-during-interval

set change-interval

set history-count

set no-change-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


950 OL-25718-02
Commands
scope path (iscsi)

scope path (iscsi)


To enter the path mode for an iSCSI image, use the scope path command.

scope path {primary| secondary}

Syntax Description primary Specifies the primary path of the iSCSI image.

secondary Specifies the secondary path of the iSCSI image.

Command Default None

Command Modes iSCSI within the service profile mode (/org/service-profile/boot-def/iscsi)


iSCSI within a boot policy (/org/boot-policy/iscsi)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI profile and a path to the iSCSI image before you use this command.

Examples This example shows how to enter the path for an iSCSI profile within the boot-policy mode:
UCS-A # scope org test
UCS-A /org # scope boot-policy sample
UCS-A /org/boot-policy # scope iscsi
UCS-A /org/boot-policy/iscsi # scope path secondary
UCS-A /org/boot-policy/iscsi/path #

Related Commands Command Description


set iscsivnicname

create path (iscsi)

enter path (iscsi)

delete path (iscsi)

show path (iscsi)

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 951
Commands
scope policy

scope policy
To enter policy mode for various types of faults and system events, use the scope policy command.

scope policy event

Syntax Description event Select a predefined fault or system event type. See Usage Guidelines for event
options.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(1) This command was introduced.

1.1(1) This command was modified to add additional event types.

Usage Guidelines Use this command to enter the policy mode for various types of faults and system events. In the specific policy
mode, you can enable or disable Call Home messages for the type of fault or system event. The following list
shows the available keywords:
• association-failed
• chassis-seeprom-error
• configuration-failure
• connectivity-problem
• election-failure
• equipment-inaccessible
• equipment-inoperable
• equipment-problem
• fru-problem
• identity-unestablishable
• link-down
• management-services-failure

Cisco UCS Manager CLI Command Reference, Release 2.0


952 OL-25718-02
Commands
scope policy

• management-services-unresponsive
• power-problem
• thermal-problem
• unspecified
• version-incompatible
• voltage-problem

Examples This example shows how to enter an existing policy mode for link-down events and how to enable Call Home
messages for those events:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # scope policy link-down
switch-A /monitoring/callhome/policy # set admin-state enabled
switch-A /monitoring/callhome/policy* # commit-buffer
switch-A /monitoring/callhome/policy #

Related Commands Command Description


create policy
enter policy
show policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 953
Commands
scope pooled-ip-params

scope pooled-ip-params
To enter the configured pool for initiator IP addresses mode, use the scope pooled-ip-params command.

scope pooled-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface within the iSCSI VNIC mode (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must configure a pool of initiator IP parameters before you use this command.

Examples This example shows how to enter the configured pool of initiator IP parameters mode:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # scope pooled-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/pooled-ip-params #

Related Commands Command Description


create pooled-ip-params

enter pooled-ip-params

show pooled-ip-params

delete pooled-ip-params

create ip-if

Cisco UCS Manager CLI Command Reference, Release 2.0


954 OL-25718-02
Commands
scope port-channel

scope port-channel
To enter the port channel mode, use the scope port-channel command.

scope port-channel port-channel-id

Syntax Description port-channel-id Port identification number. It is the value you specified while creating the
port channel.

Command Default None

Command Modes Fabric interconnect mode within the Ethernet Uplink mode (/eth-uplink/fabric)
Fabric interconnect mode within the Ethernet storage mode (/eth-storage/fabric)
Fabric interconnect mode within the Fibre Channel Uplink mode (/fc-uplink/fabric)

Command History Release Modification


1.0(1) This command was introduced in the fabric interconnect mode within the Ethernet
uplink mode (/eth-uplink/fabric).

1.4(1) This command was introduced in the fabric interconnect mode within the Fibre
Channel uplink mode (/fc-uplink/fabric) and Ethernet storage mode
(/eth-storage/fabric).

Examples This example shows how to enter port channel mode:


UCS-A # scope eth-uplink
UCS-A /eth-uplink # scope fabric b
UCS-A /eth-uplink/fabric # scope port-channel 10
UCS-A /eth-uplink/fabric/port-channel #

Related Commands Command Description


show switch
show port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 955
Commands
scope port-profile

scope port-profile
To enter port-profile mode, use the scope port-profile command in profile-set mode.

scope port-profile port-profile-name

Syntax Description port-profile-name The name of the port profile.

Command Default None

Command Modes Port profile within a profile set (/system/vm-mgmt/vmware/profile-set)


Port profile within virtual management (/system/vm-mgmt/profile-set)
Port profile within a cluster set (/system/vm-mgmt/cluster-set/cluster)

Command History Release Modification


1.1(1) This command was introduced.

2.0(1) This command was introduced in the cluster set command mode.

Usage Guidelines Use port-profile mode to perform the following tasks:


• Create and delete clients and networks
• Enter clients and networks
• Show clients and networks

Examples This example shows how to enter port-profile mode:


UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope vmware
UCS-A /system/vm-mgmt/vmware # scope profile-set
UCS-A /system/vm-mgmt/vmware/profile-set # scope port-profile pp100
UCS-A /system/vm-mgmt/vmware/profile-set/port-profile #

Related Commands Command Description


show port-profile
show profile-set

Cisco UCS Manager CLI Command Reference, Release 2.0


956 OL-25718-02
Commands
scope post-code-reporter

scope post-code-reporter
To enter the POST code reporter mode for a system, use the scope post-code-reporter command.

scope post-code-template name

Syntax Description name The name of the POST code reporter.

Command Default None

Command Modes Capability (/system/capability)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A POST code reporter must be available on the system to use this command.

Examples This example shows how to enter the POST code reporter mode for the system.
UCS-A # scope system
UCS-A /system # scope capability
UCS-A /system/capability # scope post-code-reporter testing
UCS-A /system/capability/post-code-reporter* # commit-buffer
UCS-A /system/capability/post-code-reporter #

Related Commands Command Description


scope post-code-template

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 957
Commands
scope post-code-template

scope post-code-template
To enter the POST code template mode for a system, use the scope post-code-template command.

scope post-code-template name

Syntax Description name The name of the POST code template.

Command Default None

Command Modes Capability (/system/capability)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A POST code template must be available on the system to use this command.

Examples This example shows how to enter the POST code template mode for the system
Switch-A # scope system
Switch-A /system # scope capability
Switch-A /system/capability # scope post-code-template test-codes
Switch-A /system/capability/post-code-template* # commit-buffer
Switch-A /system/capability/post-code-template #

Related Commands Command Description


scope post-code-reporter

Cisco UCS Manager CLI Command Reference, Release 2.0


958 OL-25718-02
Commands
scope power-cap-mgmt

scope power-cap-mgmt
To enter the power capping management mode for the switch, use the scope power-cap-mgmt command.

scope power-cap-mgmt

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows you how to enter the power capping management mode from the adapter mode.
Switch-A # scope adapter 1/1
Switch-A /server/adapter # scope power-cap-mgmt
Switch-A /power-cap-mgmt #

Related Commands Command Description


scope power-group
scope priority-weight

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 959
Commands
scope power-control-policy

scope power-control-policy
To enter the power control policy mode, use the scope power-control-policy command.

scope power-control-policy name

Syntax Description name The name of the power control policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A power control policy must be created to use this command.

Examples This example shows how to enter the power control policy mode.
Switch-A # scope org
Switch-A /org # scope power-control-policy Sample
Switch-A /org/power-control-policy #

Related Commands Command Description


create power-control-policy
enter power-control-policy
show power-control-policy
delete power-control-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


960 OL-25718-02
Commands
scope power-group

scope power-group
To enter the power group mode, use the scope power-group command.

scope power-group name

Syntax Description name The name of the power group.

Command Default None

Command Modes Power Capping Management (/power-cap-mgmt)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A power group must be created to use this command.

Examples This example shows how to enter the power group mode.
Switch-A # scope power-cap-mgmt
Switch-A /power-cap-mgmt # scope power-group Sample
Switch-A /power-cap-mgmt/power-group #

Related Commands Command Description


create power-group
enter power-group
show power-group
delete power-group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 961
Commands
scope pre-login-banner

scope pre-login-banner
To enter the pre-login banner mode, use the scope pre-login-banner command.

scope pre-login-banner

This command has no arguments or keywords.

Command Default None

Command Modes Banner (/security/banner)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the pre-login banner mode.
UCS-A # scope security
UCS-A /security # scope banner
UCS-A /security/banner # scope pre-login-banner
UCS-A /security/banner/pre-login-banner #

Related Commands Command Description


set message
clear message
show pre-login-banner

Cisco UCS Manager CLI Command Reference, Release 2.0


962 OL-25718-02
Commands
scope priority-weight

scope priority-weight
To set a priority for a power capping management policy, use the scope priority-weight command.

scope priority-weight {Admin priority| no-cap}

Syntax Description Admin priority Use this option to set an administrator priority to the power capping
management policy. The value must be numeral between 1 - 10.

no-cap Use this option to not set a cap.

Command Default None

Command Modes Power capping management (/power-cap-mgmt)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows you how to set an administrator priority on the power capping management policy.
Switch-A # scope power-cap-mgmt
Switch-A /power-cap-mgmt # scope priority-weight 3
Switch-A /power-cap-mgmt/priority-weight #

Related Commands Command Description


scope power-cap-mgmt
scope power-group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 963
Commands
scope profile

scope profile
To change the mode to the callhome destination profile, use the scope profile command.

scope profile {Name}

Syntax Description Name Name of the callhome destination profile. The value of this name can include a
maximum of 16 characters.

Command Default None

Command Modes Callhome (/monitoring/callhome/)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines The name of the callhome profile can include a maximum of 16 characters that can be alphanumeric.

Examples This example show how to change modes to the callhome profile:
switch-A # scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # scope profile
Word Name (Max size 16)
switch-A /monitoring/callhome # scope profile Sample
switch-A /monitoring/callhome/profile #

Related Commands Command Description


scope inventory

scope policy

Cisco UCS Manager CLI Command Reference, Release 2.0


964 OL-25718-02
Commands
scope profile-set

scope profile-set
To enter profile-set mode, use the scope profile-set command in vmware mode.

scope profile-set

This command has no arguments or keywords.

Command Default None

Command Modes Virtual machine management (/system/vm-mgmt)


Profile set (/system/vm-mgmt/vmware/profile-set)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines You use profile-set mode to perform the following tasks:
• Create and delete port profiles
• Show events, the status of the port set finite state machine, and port profiles

Examples This example shows how to enter profile-set mode:


UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope vmware
UCS-A /system/vm-mgmt/vmware # scope profile-set
UCS-A /system/vm-mgmt/vmware/profile-set #

Related Commands Command Description


show port-profile
show profile-set

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 965
Commands
scope psu

scope psu
To enter the power supply unit mode, use the scope psu command.

scope psu {1-8 PSU}

Syntax Description 1-8 PSU Number of the power supply unit. The value must be an integer between 1 and
8.

Command Default None

Command Modes Chassis (/chassis/)


Fabric Interconnect (/fabric-interconnect/)
Fabric extender module (/fex)

Command History Release Modification


1.3(1) This command was introduced.

1.4(1) This command was introduced in the Fabric extender module (/fex) mode.

Usage Guidelines The PSU number must be a unique number between 1 and 8.

Examples This example shows how to change the mode to the power supply unit of the chassis:
Switch-A # scope chassis
1-255 Chassis ID
Switch-A # scope chassis 1
Switch-A /chassis # scope psu 2
Switch-A /chassis/psu #

Related Commands Command Description


scope psu-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


966 OL-25718-02
Commands
scope psu-policy

scope psu-policy
To enter psu-policy mode, use the scope psu-policy command.

scope psu-policy

This command has no arguments or keywords.

Command Default None

Command Modes Power supply unit policy (/org/psu-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use psu-policy mode to perform the following tasks:


• Create a description of the policy
• Set up power supply redundancy

Examples This example shows how to enter psu-policy mode:


switch-A # scope org
switch-A /org # scope psu-policy
switch-A /org/psu-policy #

Related Commands Command Description


show psu
show psu-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 967
Commands
scope qos

scope qos
To enter QoS mode, use the scope qos command.

scope qos

This command has no arguments or keywords.

Command Default None

Command Modes Ethernet server (/eth-server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter QoS mode:

switch-A# scope eth-server

switch-A /eth-server # scope qos

switch-A /eth-server/qos #

Related Commands Command Description


show eth-best-effort
show eth-classified

Cisco UCS Manager CLI Command Reference, Release 2.0


968 OL-25718-02
Commands
scope qos-policy

scope qos-policy
To enter qos-policy mode, use the scope qos-policy command in org mode.

scope qos-policy policy-name

Syntax Description policy-name The name of the QoS policy.

Command Default None

Command Modes QoS policy (/org/qos-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use qos-policy mode to perform the following tasks:


• Create and delete an egress QoS policy
• Show the egress policy

Examples This example shows how to enter qos-policy mode:


switch-A# scope org
switch-A /org # scope qos-policy qp10
switch-A /org/qos-policy #

Related Commands Command Description


show egress-policy
show qos-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 969
Commands
scope rack

scope rack
To enter the rack qualifier mode, use the scope rack command.

scope rack minimum-slot-id maximum-slot-id

Syntax Description minimum-slot-id The minimum slot ID that you specified while creating the rack qualifier.

maximum-slot-id The maximum slot ID that you specified while creating the rack qualifier.

Command Default None

Command Modes Server Pool Policy Qualification (/org/server-qual)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A server pool policy qualification and a rack qualifier must be created to use this command.

Examples This example shows how to enter the rack qualifier mode.
UCS-A # scope org test
UCS-A /org # scope server-qual sample_policy
UCS-A /org/server-qual # scope rack 1 25
UCS-A /org/server-qual/rack #

Related Commands Command Description


create rack

enter rack

show rack

delete rack

Cisco UCS Manager CLI Command Reference, Release 2.0


970 OL-25718-02
Commands
scope rack-mount

scope rack-mount
To enter the rack-mount mode, use the scope rack-mount command.

scope rack-mount vendor model hw-rev

Syntax Description vendor Name of the vendor of the rack mount server. The value can include a maximum of
510 alphanumeric characters.

model Model number of the rack mount server. The value can include a maximum of 510
alphanumeric characters.

hw-rev Hardware revision number of the rack mount server. The value can include a
maximum of 510 alphanumeric characters.

Command Default None

Command Modes Capability (/system/capability)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the rack-mount mode of the server:
UCS-A # scope system
UCS-A /system # scope capability
UCS-A /system/capability # scope rack-mount Cisco Systems Inc R200-23454W 0
UCS-A /system/capability/rack-mount #

Related Commands Command Description


scope capability

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 971
Commands
scope rackserver-disc-policy

scope rackserver-disc-policy
To enter the rack server discovery policy mode, use the scope rackserver-disc-policy command.

scope rackserver-disc-policy

This command has no arguments or keywords.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines This mode is applicable only in the root organization mode.

Examples This example shows how to enter the rack server discovery policy.
Switch-A # scope org
Switch-A /org # scope rackserver-disc-policy
Switch-A /org/rackserver-disc-policy #

Related Commands Command Description


show detail
set scrub-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


972 OL-25718-02
Commands
scope radius

scope radius
To enter radius mode, use the scope radius command.

scope radius

This command has no arguments or keywords.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter radius mode:

switch-A#scope security

switch-A /security # scope radius

switch-A /security /radius #

Related Commands Command Description


show ldap
show radius

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 973
Commands
scope raid-controller

scope raid-controller
To enter the RAID controller mode for a server, use the scope raid-controller command.

scope raid-controller id {sas| sata}

Syntax Description id The ID of the RAID controller. It must be a value between 0 and 4294967295.

sas Use this option to enter the SAS type of RAID controller.

sata Use this option to enter the SATA type of RAID controller.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A RAID controller for a server must be created to use this command.

Examples This example shows how to enter the RAID controller mode for a server.
Switch-A # scope server 1/1
Switch-A /chassis/server # scope raid-controller 1 Sas
Switch-A /chassis/server/raid-controller #

Related Commands Command Description


scope local-disk-config

scope lun

Cisco UCS Manager CLI Command Reference, Release 2.0


974 OL-25718-02
Commands
scope role

scope role
To enter role mode, use the scope role command.

scope role name

Syntax Description name Role name.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter role mode:

switch-A#scope security

switch-A /security # scope role admin

switch-A /security #

Related Commands Command Description


show local-user
show role

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 975
Commands
scope scheduler

scope scheduler
To enter the scope scheduler mode, use the scope scheduler command.

scope scheduler name

Syntax Description name The name of the scheduler.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A scheduler must be created to use this command.

Examples This example shows how to enter the scheduler mode.


Switch-A # scope system
Switch-A /system # scope scheduler Default
Switch-A /system/scheduler #

Related Commands Command Description


create scheduler
enter scheduler
set scheduler
show scheduler
delete scheduler
create maint-window

Cisco UCS Manager CLI Command Reference, Release 2.0


976 OL-25718-02
Commands
scope security

scope security
To enter security mode, use the scope security command.

scope security

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter security mode:

switch-A# scope security

switch-A /security #

Related Commands Command Description


show ldap
show tacacs

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 977
Commands
scope server

scope server
To enter server mode, use the scope server command.

scope server{name| dynamic-uuid}

Syntax Description name Server name.

dynamic-uuid Specifies the unique server identity.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter server mode:

switch-A# scope server 1/1

switch-A /chassis/server #

Related Commands Command Description


show server adapter
show server identity

Cisco UCS Manager CLI Command Reference, Release 2.0


978 OL-25718-02
Commands
scope server (/ldap)

scope server (/ldap)


To enter the LDAP server mode, use the scope server command.

scope server name

Syntax Description Name The name of the LDAP server.

Command Default None

Command Modes LDAP (/security/ldap)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The LDAP server must be created to use this command.

Examples This example shows how to enter the LDAP server mode.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope server Testserver
Switch-A /security/ldap/server #

Related Commands Command Description


create ldap-group-rule

show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 979
Commands
scope server (vm-mgmt)

scope server (vm-mgmt)


To enter server mode, use the scope server command in vm-mgmt mode.

scope server

This command has no arguments or keywords.

Command Default None

Command Modes Server (/system/vm-mgmt/server)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use server mode to perform the following tasks:


• Create and delete containers and data centers
• Set the server description and IP address
• Show containers, data centers, events, and finite state machines

Containers ?
Data centers ?

Examples This example shows how to enter server mode:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope server S1
switch-A /system/vm-mgmt/server #

Related Commands Command Description


show container
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


980 OL-25718-02
Commands
scope server-if

scope server-if
To enter the server facing interface mode, use the scope server-if command.

scopeserver-ifport id

Syntax Description port id ID of the port. It must be a value between 0 and 4294967295.

Command Default None

Command Modes Port group within a chassis (/chassis/iom/port-group)


Port group within the fabric extender module (/fex/iom/port-group)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the server facing interface mode for a port group within a chassis:
UCS-A # scope chassis 1
UCS-A /chassis # scope iom 2
UCS-A /chassis/iom # scope port-group fabric
UCS-A /chassis/iom/port-group # scope server-if 22
UCS-A /chassis/iom/port-group/server-if #

Related Commands Command Description


scope iom

scope fex

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 981
Commands
scope server-qual

scope server-qual
To enter server-qual mode, use the scope server-qual command.

scope server-qual name

Syntax Description name Server qualifier name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter server-qual mode:

switch-A# scope org org3

switch-A /org # scope server-qual squal1

switch-A /org/server-qual #

Related Commands Command Description


show server-pool
show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


982 OL-25718-02
Commands
scope server-ref

scope server-ref
To enter the server reference mode for an authentication server group, use the scope server-ref command.

scope server-ref name

Syntax Description name The name of the server. You can enter either the name of the server or the IP address.

Command Default None

Command Modes Authentication server group under LDAP (/security/ldap/auth-server-group)


Authentication server group under RADIUS (/security/radius/auth-server-group)
Authentication server group under TACACS (/security/tacacs/auth-server-group)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication server group and the server reference for the authentication server group is required to use
this command.

Examples This example shows how to enter the server reference mode for an authentication server group.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope auth-server-group Sample
Switch-A /security/ldap/auth-server-group # scope server-ref example-server
Switch-A /security/ldap/auth-server-group/server-ref #

Related Commands Command Description


create server-ref
enter server-ref
show server-ref
delete server-ref

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 983
Commands
scope services

scope services
To enter services mode, use the scope services command.

scope services

This command has no arguments or keywords.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter services mode:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services #

Related Commands Command Description


show cimxml
show dns

Cisco UCS Manager CLI Command Reference, Release 2.0


984 OL-25718-02
Commands
scope service-profile

scope service-profile
To enter the service profile command, use the scope service-profile command.

scope service-profile {dynamic-uuid | org | server}

Syntax Description dynamic-uuid The dynamic UUID of the service profile.

org The name of the organization for which the service profile was created.

server The server ID for which the service profile was created.

Command Default None

Command Modes Any command mode.

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines To use the command with the option org , an organization and a service profile for that organization must be
created.
To use the command with the option server , the value entered can either be the server ID, or the chassis ID
with the blade ID (n/n format).

Examples This example shows how to enter the service profile mode.
Switch-A # scope service-profile server 1/1
Switch-A /org/service-profile #

Related Commands Command Description


show service-profile assoc server

show service-profile circuit server

show service-profile connectivity server

show service-profile identity server

show service-profile inventory server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 985
Commands
scope service-profile

Command Description
show service-profile status server

Cisco UCS Manager CLI Command Reference, Release 2.0


986 OL-25718-02
Commands
scope service-profile (/org)

scope service-profile (/org)


To enter the service profile mode for an organization, use the scope service-profile command.

scope service-profile {dynamic-uuid | server | service-profile name}

Syntax Description dynamic-uuid The dynamic UUID for the service profile. The value can either be derived
or the UUID.

server The server ID. The value entered should either be the server ID or the
chassis-ID/blade-id (n/n format).

service-profile-name The name of the service profile.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The service profile for the organization must be created to use this command.

Examples This example shows how to enter the server of the service-profile for an organization.
Switch-A # scope org Testing
Switch-A /org # scope service-profile server 1/1
Switch-A /org/service-profile #

Related Commands Command Description


create service-profile

show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 987
Commands
scope snmp-user

scope snmp-user
To enter SNMP user mode, use the scope snmp-user command.

scope snmp-user

This command has no arguments or keywords.

Command Default None

Command Modes SNMP user (/monitoring/snmp-user)

Command History Release Modification


1.0(2) This command was introduced.

Examples This example shows how to enter SNMP user mode:

switch-A# scope monitoring

switch /monitoring # scope snmp-user SU10

switch /monitoring/snmp-user #

Related Commands Command Description


show snmp
show snmp-user

Cisco UCS Manager CLI Command Reference, Release 2.0


988 OL-25718-02
Commands
scope static-ip-params

scope static-ip-params
To enter the static initiator of IP parameters mode, use the scope static-ip-params command.

scope static-ip-params

This command has no arguments or keywords.

Command Default None

Command Modes IPv4 interface of the iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if/ip-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must configure a static initiator of IP parameters before you use this command.

Examples This example shows how to enter the static initiator of IP parameters mode:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope ip-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if # scope static-ip-params
UCS-A /org/service-profile/vnic-iscsi/eth-if/ip-if/static-ip-params #

Related Commands Command Description


set addr

set default-gw

set primary-dns

set secondary-dns

set subnet

create static-ip-params

enter static-ip-params

show static-ip-params

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 989
Commands
scope static-ip-params

Command Description
delete static-ip-params

Cisco UCS Manager CLI Command Reference, Release 2.0


990 OL-25718-02
Commands
scope static-target-if

scope static-target-if
To enter the configured static target interface mode for an iSCSI VNIC, use the scope static-target-if command.

scope static-target-if static target priority

Syntax Description static target priority Static target priority that you specified when you created the static
target interface.

Command Default None

Command Modes Ethernet interface of an iSCSI VNIC (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must configure a static target interface for an iSCSI VNIC before you use this command.

Examples This example shows how to enter the static target interface mode for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope static-target-if 1
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if #

Related Commands Command Description


create static-target-if

enter static-target-if

show static-target-if

delete static-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 991
Commands
scope stats-threshold-policy

scope stats-threshold-policy
To enter the statistics threshold policy mode, use the scope stats-threshold-policy command.

scope stats-threshold-policy name

Syntax Description name Name of the statistics threshold policy.

Command Default None

Command Modes Organization (/org)


Ethernet storage (/eth-storage)

Command History Release Modification


1.0(1) This command was introduced in the Organization command mode (/org).

1.4(1) This command was introduced in the Ethernet storage command mode
(/eth-storage).

Usage Guidelines You must create a statistics threshold policy before you use this command.

Examples This example shows how to enter the statistics threshold policy in the Ethernet storage command mode:
UCS-A # scope eth-storage
UCS-A /eth-storage # scope stats-threshold-policy sample-policy
UCS-A /eth-storage/stats-threshold-policy #

Related Commands Command Description


create stats-threshold-policy

show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


992 OL-25718-02
Commands
scope storage-controller

scope storage-controller
To enter the storage controller command mode, use the scope storage-controller command.

scope storage-controller vendor model hw-rev

Syntax Description vendor Name of the vendor of the storage controller.

model Model number of the storage controller.

hw-rev Hardware revision of the storage controller.

Command Default None

Command Modes Capability (/system/capability)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the storage controller command mode:
UCS-A # scope system
UCS-A /system # scope capability
UCS-A /system/capability # scope storage-controller Cisco C240 0
UCS-A /system/capability/storage-controller #

Related Commands Command Description


show storage-controller

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 993
Commands
scope sys-defaults

scope sys-defaults
To enter the system default settings mode, use the scope sys-defaults command.

scope sys-defaults

Command Default None

Command Modes System (/system)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the system default settings mode.
UCS-A # scope system
UCS-A /system # scope sys-defaults
UCS-A /system/sys-defaults #

Related Commands Command Description

Cisco UCS Manager CLI Command Reference, Release 2.0


994 OL-25718-02
Commands
scope system

scope system
To enter system mode, use the scope system command.

scope system

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter system mode:

switch-A# scope system

switch-A /system #

Related Commands Command Description


show fabric
show version

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 995
Commands
scope tacacs

scope tacacs
To enter TACACS mode, use the scope tacacs command.

scope tacacs

This command has no arguments or keywords.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You do not have to enter this mode with a managed object.

Examples This example shows how to enter TACACS mode:

switch-A#scope security

switch-A /security # scope tacacs

switch-A /security/tacacs #

Related Commands Command Description


show radius
show ttacacs

Cisco UCS Manager CLI Command Reference, Release 2.0


996 OL-25718-02
Commands
scope threshold-value

scope threshold-value
To enter a threshold value for a property, use the enter threshold-value command.

enter threshold-value {above-normal | below-normal} {cleared | condition | critical | info | major | minor
| warning}

Syntax Description above-normal Sets the value to above normal.

below-normal Sets the value to below normal.

cleared Sets the threshold value to cleared.

condition Sets the threshold value to condition.

critical Sets the threshold value to critical.

info Sets the threshold value to info.

major Sets the threshold value to major.

minor Sets the threshold value to minor.

warning Sets the threshold value to warning.

Command Default None

Command Modes Ethernet uplink (/eth-uplink/stats-threshold-policy/class/property)


Fibre channel (/fc-uplink/stats-threshold-policy/class/property)
Ethernet server (/eth-server/stats-threshold-policy/class/property)
Organization (/org/stats-threshold-policy/class/property)

Command History Release Modification


1.0.1 This command was introduced.

Examples The following example shows how to enter the threshold value above-normal critical in property packets-rx-delta
mode:
switch-A#scope org org100
switch-A /org # scope stats-threshold-policy stp100

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 997
Commands
scope threshold-value

switch-A /org/stats-threshold-policy # scope class vnic-stats


switch-A /org/stats-threshold-policy/class # scope property packets-rx-delta
switch-A /org/stats-threshold-policy/class/property # scope threshold-value above-normal
critical
switch-A /org/stats-threshold-policy/class/property/threshold-value #

Related Commands Command Description


show property
show threshold-value

Cisco UCS Manager CLI Command Reference, Release 2.0


998 OL-25718-02
Commands
scope update

scope update
To enter update mode, use the scope update command.

scope update label

Syntax Description label Specifies the label of an update in the update history.

Command Default None

Command Modes Capability (/system/capability)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the update mode.


Switch-A # scope system
Switch-A /system # scope capability
Switch-A /system/capability # scope update 1.0(8.43)
Switch-A /system/capability/update #

Related Commands Command Description


show version

scope cat-updater

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 999
Commands
scope vcenter

scope vcenter
To enter vcenter (VCenter) mode, use the scope vcenter command in vmware mode.

scope vcenter vcenter-name

Syntax Description vcenter-name The name of the VCenter.

Command Default None

Command Modes VCenter (/system/vm-mgmt/vmware/vcenter)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use vm-mgmt mode to perform the following tasks:


• Create and delete data centers and folders
• Set descriptions and hostnames
• Show data centers, events, finite state machines, and folders

Examples This example shows how to enter vcenter mode:


switch-A # scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc10
switch-A /system/vm-mgmt/vmware/vcenter #

Related Commands Command Description


show data-center
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


1000 OL-25718-02
Commands
scope vcon-policy

scope vcon-policy
To enter vcon-policy mode, use the scope vcon-policy command.

scope vcon-policy policy-name

Syntax Description policy-name The name of the policy.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use vcon-policy mode to perform the following tasks:


• Set vCons and vCon descriptions
• Show vCon information

Examples This example shows how to enter vcon-policy mode:


switch-A # scope org org100
switch-A /org # scope vcon-policy vcp100
switch-A /org/vcon-policy #

Related Commands Command Description


show vcon
show vcon-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1001
Commands
scope vhba

scope vhba
To enter virtual HBA mode, use the scope vhba command.

scope vhba name

Syntax Description name Virtual HBA name.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter virtual HBA mode:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org # scope vhba vHBA10

switch-A /org/vhba #

Related Commands Command Description


show service-profile
show vhba

Cisco UCS Manager CLI Command Reference, Release 2.0


1002 OL-25718-02
Commands
scope vhba-templ

scope vhba-templ
To enter virtual HBA template mode, use the scope vhba-templ command.

scope vhba-templ name

Syntax Description name Virtual HBA template name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter virtual HBA template mode:

switch-A# scope org org10

switch-A /org # scope vhba-templ vhbaT10

switch-A /org/vhba-templ #

Related Commands Command Description


show fc-if
show vhba-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1003
Commands
scope virtual-machine

scope virtual-machine
To enter virtual-machine mode, use the scope virtual-machine command in vmware mode.

scope virtual-machine

This command has no arguments or keywords.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware/virtual-machine)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to enter virtual-machine mode:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope virtual-machine 4125a5e0-e2c3-11de-8a39-0800200c9a66
switch-A /system/vm-mgmt/vmware/virtual-machine #

Related Commands Command Description


show vcenter
show virtual-machine

Cisco UCS Manager CLI Command Reference, Release 2.0


1004 OL-25718-02
Commands
scope virtual-machine (vm-mgmt)

scope virtual-machine (vm-mgmt)


To enter the virtual machine mode for a system, use the scope virtual-machine command.

scope virtual-machine uuid

Syntax Description uuid Specify the UUID in the NNNN-NNNNNNNNNNNN format.

Command Default None

Command Modes Virtual Machine management (/system/vm-mgmt)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines The virtual machine must be created to use this command.

Examples This example shows how to enter the virtual machine mode for the system.
UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope virtual-machine 4125a5e0-e2c3-11de-8a39-0800200c9a66
UCS-A /system/vm-mgmt/virtual-machine #

Related Commands Command Description


show virtual-machine

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1005
Commands
scope vlan

scope vlan
To enter VLAN mode, use the scope vlan command.

scope vlan name

Syntax Description name VLAN name.

Command Default None

Command Modes Ethernet uplink (/eth-uplink)


Ethernet Storage (/eth-storage)
Fabric within Ethernet Uplink (/eth-uplink/fabric)
Fabric within Ethernet Storage (/eth-storage/fabric)
Port profile (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.0(1) This command was introduced.

1.1(1) The port profile mode was added.

1.4(1) Ethernet Storage, and Fabric within Ethernet Storage modes were added.

Examples This example shows how to enter VLAN mode:


switch-A# scope eth-uplink
switch-A /eth-uplink # scope vlan vlan1
switch-A /eth-uplink/vlan #

Related Commands Command Description


show interface
show vlan

Cisco UCS Manager CLI Command Reference, Release 2.0


1006 OL-25718-02
Commands
scope vlan (port-profile)

scope vlan (port-profile)


To enter the VLAN mode for a profile-set, use the scope vlan command.

scope vlan name

Syntax Description name The name of the VLAN interface.

Command Default None

Command Modes Port profile (/system/vm-mgmt/profile-set/port-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A VLAN interface must be created to use this command.

Examples This example shows how to enter the VLAN mode.


UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope profile-set
UCS-A /system/vm-mgmt/profile-set # scope port-profile sample
UCS-A /system/vm-mgmt/profile-set/port-profile # scope vlan test
UCS-A /system/vm-mgmt/profile-set/port-profile/vlan #

Related Commands Command Description


create vlan (port-profile)
enter vlan (port-profile)
show vlan (port-profile)
delete vlan (port-profile)

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1007
Commands
scope vm-life-cycle-policy

scope vm-life-cycle-policy
To enter the virtual machine life cycle policy mode, use the scope vm-life-cycle-policy command.

scope vm-life-cycle-policy

This command has no arguments or keywords.

Command Default None

Command Modes Virtual machine management (/system/vm-mgmt)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the Virtual machine life cycle policy for the system.
Switch-A # scope system
Switch-A /system # scope vm-mgmt
Switch-A /system/vm-mgmt # scope vm-life-cycle-policy
Switch-A /system/vm-mgmt/vm-life-cycle-policy #

Related Commands Command Description


set vmretention
set vnicretention

Cisco UCS Manager CLI Command Reference, Release 2.0


1008 OL-25718-02
Commands
scope vm-mgmt

scope vm-mgmt
To enter vm-mgmt (virtual machine management) mode, use the scope vm-mgmt command in system mode.

scope vm-mgmt

This command has no arguments or keywords.

Command Default None

Command Modes Virtual machine management (/system/vm-mgmt)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use vm-mgmt mode to perform the following tasks:


• Scope to vmware mode
• Show event and finite state machine information

Examples This example shows how to enter vm-mgmt mode:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1009
Commands
scope vmware

scope vmware
To enter vmware (VMware) mode, use the scope vmware command in vm-mgmt mode.

scope vmware

This command has no arguments or keywords.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use vmware mode to perform the following tasks:


• Create and delete VCenters
• Set certificates
• Show event, extension key, finite state machine, profile-set, VCenter, and virtual machine information

Examples This example shows how to enter vmware mode:


switch-A # scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware #

Related Commands Command Description


show vcenter
show virtual-machine

Cisco UCS Manager CLI Command Reference, Release 2.0


1010 OL-25718-02
Commands
scope vnic

scope vnic
To enter virtual NIC mode, use the scope vnic command.

scope vnic name

Syntax Description name Virtual NIC name.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter virtual NIC mode:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org # scope vnic vNIC10

switch-A /org/vnic #

Related Commands Command Description


show service-profile
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1011
Commands
scope vnic-iscsi

scope vnic-iscsi
To enter the VNIC iSCSI mode for a service profile, use the scope vnic-iscsi command.

scope vnic-iscsi name

Syntax Description name Name of the iSCSI VNIC. It is the name that you provided when you created the
iSCSI VNIC.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a service profile and an iSCSI VNIC for the service profile before you use this command.

Examples This example shows how to enter the iSCSI VNIC mode for a service profile:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi #

Related Commands Command Description


create vnic-iscsi

enter vnic-iscsi

show vnic-iscsi

delete vnic-iscsi

Cisco UCS Manager CLI Command Reference, Release 2.0


1012 OL-25718-02
Commands
scope vnic-templ

scope vnic-templ
To enter virtual NIC template mode, use the scope vnic-templ command.

scope vnic-templ name

Syntax Description name Virtual NIC template name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter virtual NIC template mode:

switch-A# scope org org10

switch-A /org # scope vnic-templ vnicT10

switch-A /org/vnic-templ #

Related Commands Command Description


show eth-if
show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1013
Commands
scope vsan

scope vsan
To enter the VSAN mode, use the scope vsan command.

scope vsan name

Syntax Description name The VSAN name.

Command Default None

Command Modes Fibre Channel Uplink (/fc-uplink)


Fabric within Fibre Channel Uplink (/fc-uplink/fabric)
Fibre Channel Storage (/fc-storage)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) The following command modes were introduced:


Fabric within Fibre Channel Uplink (/fc-uplink/fabric)
Fibre Channel Storage (/fc-storage)

Usage Guidelines The VSAN must be created to use this command.

Examples This example shows how to enter the VSAN for a Fabric within the Fibre Channel uplink mode.
Switch-A # scope fc-uplink
Switch-A /fc-uplink # scope fabric a
Switch-A /fc-uplink/fabric # scope vsan vlan1
Switch-A /fc-uplink/fabric/vsan #

Related Commands Command Description


create vsan

show vsan

delete vsan

Cisco UCS Manager CLI Command Reference, Release 2.0


1014 OL-25718-02
Commands
scope web-session-limits

scope web-session-limits
To enter the web sessions mode, use the scope web-session-limits command.

scope web-session-limits

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enter the web session limits mode.
Switch-A # scope system
Switch-A /system # scope services
Switch-A /system/services # scope web-session-limits
Switch-A /system/services/web-session-limits #

Related Commands Command Description


set per-user

set total

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1015
Commands
scope wwn-pool

scope wwn-pool
To enter WWN pool mode, use the scope wwn-pool command.

scope wwn-pool name

Syntax Description name WWN pool name.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter WWN pool mode:

switch-A# scope org org10

switch-A /org # scope wwn-pool wwnP10

switch-A /org/wwn-pool #

Related Commands Command Description


show initiator
show org

Cisco UCS Manager CLI Command Reference, Release 2.0


1016 OL-25718-02
Commands
send

send
To send the current system inventory message to the Smart Call Home database, use the send command.

send

This command has no arguments or keywords.

Command Default None

Command Modes Inventory (/monitoring/callhome/inventory)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to immediately send the current system inventory message to the Smart Call Home database.

Examples This example shows how to send the current system inventory message:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # scope inventory
switch-A /monitoring/callhome/inventory # send
switch-A /monitoring/callhome/inventory #

Related Commands Command Description


set send-periodically
show inventory

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1017
Commands
send-syslog

send-syslog
To create and send a syslog message, use the send-syslog command.

send-syslog {emergencies| alerts| critical| errors| warnings| notifications| information| debugging} text

Syntax Description alerts Specifies alerts.

critical Specifies critical messages.

debugging Specifies debug messages.

emergencies Specifies emergency messages.

errors Specifies error messages.

information Specifies informational messages.

notifications Specifies notifications.

warnings Specifies warnings.

text Enter text of syslog message.

Command Default None

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to create and send a syslog message. Specify the urgency level of the message and enter
up to 512 characters of text. If the text includes spaces, it must be enclosed in quotes (" ").
The following table shows the urgency level options in order of decreasing urgency.

emergencies Emergency level (0)

alerts Alert level (1)

critical Critical level (2)

Cisco UCS Manager CLI Command Reference, Release 2.0


1018 OL-25718-02
Commands
send-syslog

errors Error level (3)

warnings Warning level (4)

notifications Notification level (5)

information Information level (6)

debugging Debug level (7)

Examples This example shows how to create and send a syslog message:
switch-A# scope monitoring
switch-A /monitoring # send-syslog alerts "This is a test message"
switch-A /monitoring #

Related Commands Command Description


show snmp-trap
show syslog

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1019
Commands
send-test-alert

send-test-alert
To send a Callhome test alert message, use the send-test-alert command.

send-test-alert {[alert-description description] [alert-group {diagnostic | environmental}] [alert-level


{critical | debug | fatal | major-1 | minor-1 | normal | notify | warning}] [alert-message-type {conf | diag
| env | inventory | syslog | test-1}] [alert-message-subtype {delta | full | goldmajor | goldminor | goldnormal
| major-2 | minor-2 | nosubtype | test-2}]}

Syntax Description alert-description alert-description Specifies the alert description.

alert-group Specifies the alert group type.

diagnostic Specifies the diagnostic alert group.

environmental Specifies the environmental alert group.

alert-level Specifies the alert level.

critical Specifies critical alert level.

debug Specifies debug alert level.

fatal Specifies fatal alert level.

major-1 Specifies major alert level.

minor-1 Specifies minor alert level.

normal Specifies minor alert level.

notify Specifies notify alert level.

warning Specifies warning alert level.

alert-message-type Specifies the alert message type.

conf Specifies the

diag Specifies the diagnostic alert message type.

env Specifies the

inventory Specifies the inventory alert messag type.

syslog Specifies the system log alert message type.

test-1 Specifies the test alert message type.

Cisco UCS Manager CLI Command Reference, Release 2.0


1020 OL-25718-02
Commands
send-test-alert

alert-message-subtype Specifies the alert message subtype.

delta Specifies the delta alert messge subtype.

full Specifies the full alert messge subtype.

goldmajor Specifies the gold major alert messge subtype.

goldminor Specifies the gold minor alert messge subtype.

goldnormal Specifies the gold normal alert messge subtype.

major-2 Specifies the major alert messge subtype.

minor-2 Specifies the minor alert messge subtype.

nosubtype Specifies no subtype.

test-2 Specifies the test alert messge subtype.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(2) This command was introduced.

Examples This example shows how to send a Callhome test alert message:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # send-test-alert alert-message-type diag
switch-A /monitoring/callhome #

Related Commands Command Description


show callhome
show policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1021
Commands
set account-status

set account-status
To set a status for an account of the local user, use the set account-status command.

set account-status {active| inactive}

Syntax Description active To set the account status to active.

inactive To set the account status to inactive. If an account is set to inactive, then the
user cannot login to the server.

Command Default None

Command Modes Local user (/security/local-user)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A local user must be created to use this command.

Examples This example shows how to change the status of a local user to inactive.
UCS-A # scope security
UCS-A /security # scope local-user admin
UCS-A /security/local-user # set account-status inactive
UCS-A /security/local-user* # commit-buffer
UCS-A /security/local-user #

Related Commands Command Description


set password
set email
set expiration

set firstname

set lastname

set phone

Cisco UCS Manager CLI Command Reference, Release 2.0


1022 OL-25718-02
Commands
set account-status

Command Description
set sshkey

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1023
Commands
set action

set action
To set action, use the set action command.

chassis-disc-policy mode
set action {1-link| 2-link| 4-link}

import-config mode
set action {merge| replace}

server-disc-policy mode
set action {diag| immediate| user-acknowledged}

Syntax Description 1-link Specifies one uplink.

2-link Specifies two uplinks.

4-link Specifies four uplinks.

merge Specifies merge.

replace Specifies replace.

diag Specifies diagnostic.

immediate Specifies immediate.

user-acknowledged Specifies user acknowledged.

Command Default None

Command Modes Chassis discovery policy (/org/chassis-disc-policy)


Import configuration (/system/import-config)
Server discovery policy /org/server-disc-policy

Command History Release Modification


1.0(1) This command was introduced.

Cisco UCS Manager CLI Command Reference, Release 2.0


1024 OL-25718-02
Commands
set action

Usage Guidelines Use this command in chassis-disc-policy mode to specify the number of links to the switch that the chassis
must have to be discovered.

Examples This example shows how to set action:

switch-A# scope org org10

switch-A /org/chassis-disc-policy # scope chassis-disc-policy cdp10

switch-A /org/chassis-disc-policy # set action 4-link

switch-A /org/chassis-disc-policy* # commit-buffer

switch-A /org/chassis-dis-policy #

Related Commands Command Description


show chassis
show chassis-disc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1025
Commands
set adaptor-policy

set adaptor-policy
To set an adaptor policy, use the set adaptor-policy command.

set adaptor-policy name

Syntax Description name Adapter policy name. Enter up to 16 characters.

Command Default None

Command Modes Dynamic vNIC connection (/org/service-profile/dynamic-vnic-conn)


Dynamic connection policy (/org/dynamic-conn-policy)
Virtual HBA (/org/service-profile/vhba)
Virtual NIC (/org/service-profile/vnic)

Command History Release Modification


1.0(1) This command was introduced.

Use this command to associate the specified profile with the service profile you used to enter service profile
mode.

Examples This example shows how to set an adapter policy:


switch-A# scope org org30a
switch-A /org # scope service-profile sp10
switch-A /org/service-profile # scope vnic
switch-A /org/service-profile/vnic # set adaptor-policy 20a
switch-A /org/service-profile/vnic* # commit-buffer
switch-A /org/service-profile/vnic #

Related Commands Command Description


show vhba
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


1026 OL-25718-02
Commands
set adaptor-policy

set adaptor-policy
To set an adaptor policy, use the set adaptor-policy command.

set adaptor-policy name

Syntax Description name Adapter policy name. Enter up to 16 characters.

Command Default None

Command Modes Dynamic vNIC connection (/org/service-profile/dynamic-vnic-conn)


Dynamic connection policy (/org/dynamic-conn-policy)
Virtual HBA (/org/service-profile/vhba)
Virtual NIC (/org/service-profile/vnic)

Command History Release Modification


1.0(1) This command was introduced.

Use this command to associate the specified profile with the service profile you used to enter service profile
mode.

Examples This example shows how to set an adapter policy:


switch-A# scope org org30a
switch-A /org # scope service-profile sp10
switch-A /org/service-profile # scope vnic
switch-A /org/service-profile/vnic # set adaptor-policy 20a
switch-A /org/service-profile/vnic* # commit-buffer
switch-A /org/service-profile/vnic #

Related Commands Command Description


show vhba
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1027
Commands
set addr

set addr
To set an IP address for the external management static IP address, use the set addr command.

set addr IP addr

Syntax Description IP addr The IP address. It must be in the a.b.c.d format.

Command Default None

Command Modes External management static IP address under service profile (/org/service-profile/ext-static-ip)
External management static IP address under CIMC (/chassis/server/cimc/ext-static-ip)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The external management IP address and the default gateway must be on the same subnet.
The external management IP address cannot match the default gateway.

Examples This example shows how to set an IP address for the external management static IP mode.
Switch-A # scope org
Switch-A /org # scope service-profile sample
Switch-A /org/service-profile # scope ext-static-ip
Switch-A /org/service-profile/ext-static-ip # set addr 1.2.3.4
Switch-A /org/service-profile/ext-static-ip* # commit-buffer
Switch-A /org/service-profile/ext-static-ip #

Related Commands Command Description


create service-profile
create ext-static-ip

Cisco UCS Manager CLI Command Reference, Release 2.0


1028 OL-25718-02
Commands
set adminspeed

set adminspeed
To set the speed for a fabric interface, use the set adminspeed command.

set adminspeed {10gbps| 1gbps}

Syntax Description 10gbps Use this option to set the speed of the interface to 10 Gbps.

1gbps Use this option to set the speed of the interface to 1 Gbps.

Command Default None

Command Modes Interface (/eth-storage/fabric/interface)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An interface must be created for the fabric to use this command.

Examples This example shows to set the speed for the fabric interface.
Switch-A # scope eth-storage
Switch-A /eth-storage # scope fabric b
Switch-A /eth-storage/fabric # scope interface 2 3
Switch-A /eth-storage/fabric/interface # set adminspeed 10gbps
Switch-A /eth-storage/fabric/interface #

Related Commands Command Description


create interface
set pingroup name
set portmode
set prio
set user-label

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1029
Commands
set adminstate

set adminstate
To reset the connectivity of an adapter, use the set adminstate command.

set adminstate {enabled| reset-connectivity| reset-connectivity-active| reset-connectivity-passive}

Syntax Description enabled The adapter is enabled.

reset-connectivity The adapter connectivity is reset on both fabrics.

reset-connectivity-active The adapter connectivity is reset on only the active fabric.

reset-connectivity-passive The adapter connectivity is reset on only the passive fabric.

Command Default The adapter state is enabled.

Command Modes External Ethernet interface (/chassis/server/adapter/ext-eth-if)


Host Ethernet interface (/chassis/server/adapter/host-eth-if)
Host Fibre Channel interface (/chassis/server/adapter/host-fc-if)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to reset connectivity on the vNIC or vHBA. A shutdown and enable sequence is performed
on the port.
The active and passive options are not available on external host ports.

Examples This example shows how to reset connectivity on a vHBA:


switch-A# scope server 1/1
switch-A /chassis/server # scope adapter 1
switch-A /chassis/server/adapter # scope host-fc-if 2
switch-A /chassis/server/adapter/host-fc-if # set adminstate reset-connectivity
switch-A /chassis/server/adapter/host-fc-if* # commit-buffer
switch-A /chassis/server/adapter/host-fc-if #

Related Commands Command Description


show ext-eth-if

Cisco UCS Manager CLI Command Reference, Release 2.0


1030 OL-25718-02
Commands
set adminstate

Command Description
show host-eth-if
show host-fc-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1031
Commands
set admin-state

set admin-state
To set the administration state of a policy, use the set admin-state command.

set admin-state {disabled| enabled}

Syntax Description disabled Specifies administration state disabled.

enabled Specifies administration state enabled.

Command Default None

Command Modes Policy (/monitoring/callhome/policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enable or disable the context policy when a fault or system event matching the associated
cause is encountered.

Examples This example shows how to enable the administration state for link-down system events:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # scope policy link-down
switch-A /monitoring/callhome/policy # set admin-state enabled
switch-A /monitoring/callhome/policy* # commit-buffer
switch-A /monitoring/callhome/policy #

Related Commands Command Description


scope policy
show policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1032 OL-25718-02
Commands
set admin-state (beacon-led)

set admin-state (beacon-led)


To specify which port mode is represented by illuminated beacon LED lights, use the set admin-state command.

set admin-state {eth| fc| off}

Syntax Description eth Specifies all of the unified ports in the Ethernet mode to be represented by illuminated
beacon LED lights.

fc Specifies all of the unified ports in the Fibre Channel mode to be represented by
illuminated beacon LED lights.

off Specifies that the beacon LED lights for all ports on the module are turned off.

Command Default None

Command Modes Beacon LED (/fabric-interconnect/card/beacon-led)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to specify that the beacon LED lights for all ports on the module are turned off:
UCS-A # scope fabric-interconnect A
UCS-A /fabric-interconnect # scope card 1
UCS-A /fabric-interconnect/card # scope beacon-led
UCS-A /fabric-interconnect/card/beacon-led # set admin-state Off
UCS-A /fabric-interconnect/card/beacon-led* # commit-buffer
UCS-A /fabric-interconnect/card/beacon-led #

Related Commands Command Description


scope beacon-led

show beacon-led

show beacon-led fsm status

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1033
Commands
set admin-vcon

set admin-vcon
To set up an administrative vCon (administrative virtual network interface connection) for the vHBA, use the
set admin-vcon command in vhba or vnic mode.

set admin-vcon {1 | 2 | any}

Syntax Description 1 Assigns the vHBA to virtual network interface connection 1.

2 Assigns the vHBA to virtual network interface connection 2.

any Assigns the vHBA to all virtual network interface connections.

Command Default None

Command Modes vHBA (/org/service-profile/vhba)


vNIC (/org/service-profile/vnic)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to set up an administrative vCon in vhba mode:
switch-A# scope org org100
switch-A /org # scope service-profile sp100
switch-A /org/service-profile # scope vhba vhba100
switch-A /org/service-profile/vhba # set admin-vcon any
switch-A /org/service-profile/vhba* # commit-buffer
switch-A /org/service-profile/vhba #

Related Commands Command Description


show vcon
show vhba

Cisco UCS Manager CLI Command Reference, Release 2.0


1034 OL-25718-02
Commands
set aes-128

set aes-128
To set up AES (Advanced Encryption Standard) 128-bit encryption, use the set aes-128 command.

set aes-128 {no | yes}

Syntax Description no Specifies no AES 128-bit encryption.

yes Specifies AES 128-bit encryption.

Command Default None

Command Modes SNMP user (/monitoring/snmp-user)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines SNMPv3, enabled on a UCS system by using the create snmp-user command, provides important security
features. One is authentication of packets, to prevent snooping by an unauthorized source. Use AES 128-bit
encryption to fully utilize the extended features of SNMPv3 on your UCS system.

Examples This example shows how to set up AES 128-bit encryption:


switch-A# scope monitoring
switch /monitoring # scope snmp-user SU10
switch /monitoring/snmp-user # set aes-128 yes
switch /monitoring/snmp-user* # commit-buffer
switch /monitoring/snmp-user #

Related Commands Command Description


show snmp
show snmp-user

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1035
Commands
set agent-policy

set agent-policy
To set up an agent policy, use the set agent-policy command.

set agent-policy policy-name

Syntax Description policy-name The policy name.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to associate the specified agent policy with the service profile you used to enter service
profile mode.
policy-name should be a unique set of numbers and letters that identifies the policy. The range of valid values
is 1 to 16.

Examples This example shows how to set up an agent policy:


switch-A# scope org org10
switch-A /org # scope service-profile servProf10
switch-A /org/service-profile # set agent-policy agentP10
switch-A /org/service-profile* # commit-buffer
switch-A /org/service-profile #

Related Commands Command Description


show association
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


1036 OL-25718-02
Commands
set alertgroups

set alertgroups
To enable alerts from predefined Call Home alert groups, use the set alertgroups command.

set alertgroups [ciscotac] [diagnostic] [environmental] [inventory] [license] [lifecycle] [linecard]


[supervisor] [syslogport] [system] [test]+

Syntax Description ciscotac Specifies the Cisco Technical Assistance Center (TAC) alert group.

diagnostic Specifies the diagnostic alert group.

environmental Specifies the environmental alert group.

inventory Specifies the inventory alert group.

license Specifies the license alert group.

lifecycle Specifies the lifecycle alert group.

linecard Specifies the line card alert group.

supervisor Specifies the supervisor alert group.

syslogport Specifies the syslog port alert group.

system Specifies the system alert group.

test Specifies the test alert group.

Command Default None

Command Modes Call Home profile (/monitoring/callhome/profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to select and enable a set of alert groups for a Call Home profile. An alert group is a
predefined subset of Call Home alerts. Different types of Call Home alerts are grouped into different alert
groups depending on their type.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1037
Commands
set alertgroups

Note When you enter the set alertgroups command, any previously configured alert group list within the Call
Home profile is replaced. To add more alert groups to an existing alert group list, use the add alertgroups
command. To remove alert groups from an existing alert group list, use the remove alertgroups command.

Examples This example shows how to configure the sending of Call Home alerts from the environmental and diagnostic
alert groups.
UCS-A /monitoring # scope callhome
UCS-A /monitoring/callhome # enter profile ProfileOne
UCS-A /monitoring/callhome/profile # set alertgroups environmental diagnostic
UCS-A /monitoring/callhome/profile* # create destination admin@example.com
UCS-A /monitoring/callhome/profile/destination* # commit-buffer
UCS-A /monitoring/callhome/profile/destination #

Related Commands Command Description


add alertgroups
remove alertgroups

Cisco UCS Manager CLI Command Reference, Release 2.0


1038 OL-25718-02
Commands
set all

set all
To specify the management logging threshold for all modules, use the set all command.

set all {crit| major| minor| warn| info| debug4| debug3| debug2| debug1| debug0}

Syntax Description crit Critical (highest) level

major Major level

minor Minor level

warn Warning level

info Informational level

debug4 Debug 4 level

debug3 Debug 3 level

debug2 Debug 2 level

debug1 Debug 1 level

debug0 Debug 0 (lowest) level

Command Default The default management logging threshold is info.

Command Modes Management logging (/monitoring/sysdebug/mgmt-logging)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the management logging threshold for all modules. The threshold options are
listed in order of decreasing urgency in the Syntax Description.

Examples This example shows how to set the management logging threshold to major for all modules:
switch-A# scope monitoring
switch-A /monitoring # scope sysdebug
switch-A /monitoring/sysdebug # scope mgmt-logging

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1039
Commands
set all

switch-A /monitoring/sysdebug/mgmt-logging # set all major


switch-A /monitoring/sysdebug/mgmt-logging* # commit-buffer
switch-A /monitoring/sysdebug/mgmt-logging #

Related Commands Command Description


show (mgmt-logging)

Cisco UCS Manager CLI Command Reference, Release 2.0


1040 OL-25718-02
Commands
set arch

set arch
To set processor architecture (arch), use the set arch command.

set arch {dual-core-opteron| intel-p4-c| opteron| pentium-4| turion-64| xeon| xeon-mp| any}

Syntax Description dual-core-opteron Specifies the dual-core Opteron processor.

intel-p4-c Specifies the Intel P4 C processor.

opteron Specifies the Opteron processor.

pentium-4 Specifies the Pentium 4 processor.

turion-64 Specifies the Turion 4 processor.

xeon Specifies the Xeon processor.

xeon-mp Specifies the Xeon MP processor.

any Specifies any processor.

Command Default None

Command Modes Processor (/org/server-qual/processor)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set processor architecture:

switch-A# scope org org3

switch-A /org # scope server-qual squal10

switch-A /org/server-qual # scope processor

switch-A /org/server-qual/processor # set arch xeon-mp

switch-A /org/server-qual/processor* # commit-buffer

switch-A /org/server-qual/processor #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1041
Commands
set arch

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


1042 OL-25718-02
Commands
set attribute

set attribute
To set an attribute, use the set attribute command.

set attribute attribute

Syntax Description attribute Attribute name. The range of valid values is 1 to 63.

Command Default None

Command Modes LDAP (/security/ldap)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to restrict database searches to records that contain the specified attribute.

Examples This example shows how to set an attribute:

switch-A#scope security

switch-A /security # scope ldap

switch-A /security/ldap # set attribute name

switch-A /security/ldap* # commit-buffer

switch-A /security/ldap #

Related Commands Command Description


show ldap
show tacacs

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1043
Commands
set auth

set auth
To set the authentication type for an SNMP user, use the set auth command.

set auth {md5 | sha}

Syntax Description md5 Specifies MD5 (Message Digest Algorithm 5) authentication.

sha Specifies SHA (Secure Hash Algorithm) authentication.

Command Default None

Command Modes SNMP user (/monitoring/snmp-user)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines SNMPv3, enabled on a UCS system by using the create snmp-user command, provides important security
features. One is authentication, to verify that a message is from a valid source. Use MD5 or SHA authentication
to fully utilize the extended features of SNMPv3 on your UCS system.

Examples This example shows how to set the SNMP user authentication type:
switch-A# scope monitoring
switch /monitoring # scope snmp-user SU10
switch /monitoring/snmp-user # set auth sha
switch /monitoring/snmp-user* # commit-buffer
switch /monitoring/snmp-user #

Related Commands Command Description


show snmp
show snmp-user

Cisco UCS Manager CLI Command Reference, Release 2.0


1044 OL-25718-02
Commands
set authentication console

set authentication console


To set up the authentication console, use the set authentication console command.

set authentication console {ldap| local| radius| tacacs}

Syntax Description ldap Specifies an LDAP authentication console.

local Specifies a local authentication console.

radius Specifies a RADIUS authentication console.

tacacs Specifies a TACACS authentication console.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set up the authentication console:

switch-A#scope security

switch-A /security # set authentication console ldap

switch-A /security* # commit-buffer

switch-A /security #

Related Commands Command Description


show authentication
show ldap

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1045
Commands
set authentication default

set authentication default


To set an authentication default, use the set authentication default command.

set authentication default {ldap| local| radius| tacacs}

Syntax Description ldap Specifies an LDAP authentication console.

local Specifies a local authentication console.

radius Specifies a RADIUS authentication console.

tacacs Specifies a TACACS authentication console.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set an authentication default:

switch-A#scope security

switch-A /security # set authentication default ldap

switch-A /security* # commit-buffer

switch-A /security #

Related Commands Command Description


show authentication
show ldap

Cisco UCS Manager CLI Command Reference, Release 2.0


1046 OL-25718-02
Commands
set authport

set authport
To set up an authentication port, use the set authport command.

set authport id

Syntax Description id Authentication port identification number. The range of valid values is 1 to 65535.

Command Default None

Command Modes Server (/security/radius/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the port used to communicate with a RADIUS server.

Examples This example shows how to set up an authentication port:

switch-A#scope security

switch-A /security # scope radius

switch-A /security/radius # scope server s100

switch-A /security/radius/server # set authport 100

switch-A /security/radius/server* # commit-buffer

switch-A /security/radius/server #

Related Commands Command Description


show ldap
show radius

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1047
Commands
set authorization

set authorization
To enable or disable authorization for an LDAP group rule, use the set authorization command.

set authorization {disable| enable}

Syntax Description disable Use this option to disable authorization for an LDAP group rule.

enable Use this option to enable authorization for an LDAP group rule.

Command Default None

Command Modes LDAP Group Rule (/security/ldap/server/ldap-group-rule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An LDAP server and an LDAP group rule must be created to use this command.

Examples This example shows how to enable authorization for an LDAP group rule.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope server Testing
Switch-A /security/ldap/server # scope ldap-group-rule
Switch-A /security/ldap/server/ldap-group-rule # set authorization enable
Switch-A /security/ldap/server/ldap-group-rule* # commit-buffer
Switch-A /security/ldap/server/ldap-group-rule #

Related Commands Command Description


create ldap-group-rule

show ldap-group-rule

Cisco UCS Manager CLI Command Reference, Release 2.0


1048 OL-25718-02
Commands
set auth-server-group

set auth-server-group
To set an authentication server group, use the set auth-server-group command.

set auth-server-group authentication server group

Syntax Description authentication server group The name of the authentication server group.

Command Default None

Command Modes Default Authentication (/security/default-auth)


Default Authentication under the Authentication Domain (security/auth-domain/default-auth)
Console Authentication (/security/console-auth)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication server group must be created to use this command.

Examples This example shows how to set the authentication server group for console authentication:
Switch-A # scope security
Switch-A /security # scope console-auth
Switch-A /security/console-auth # set auth-server-group Default
Switch-A /security/console-auth* # commit-buffer
Switch-A /security/console-auth #

Related Commands Command Description


scope auth-server-group
enter auth-server-group
create auth-server-group
delete auth-server-group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1049
Commands
set backup action

set backup action


To specify an action or actions that will trigger a backup of the system event log, use the set backup action
command.

set backup action [log-full] [none] [on-change-of-association] [on-clear] [timer]

Syntax Description log-full Specifies that the log is backed up when it is full.

none Specifies no action.

on-change-of-association Specifies that the log is backed up when the server changes associations.

on-clear Specifies that the log is backed up when it is cleared.

timer Specifies that the log is backed up at an interval.

Command Default None

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to specify an action or actions that will trigger a backup of the system event log.

Note When you enter the set backup action command, any previously configured list of actions is replaced.
To add more actions to an existing list, use the add backup action command. To remove actions from
an existing list, use the remove backup action command.

Examples This example shows how to back up the log when the log is full, when the log is cleared, and on an interval:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # set backup action log-full on-clear timer
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Cisco UCS Manager CLI Command Reference, Release 2.0


1050 OL-25718-02
Commands
set backup action

Related Commands Command Description


add backup action
remove backup action
set backup interval
show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1051
Commands
set backup clear-on-backup

set backup clear-on-backup


To specify whether to clear the system event log after a backup operation, use the set backup clear-on-backup
command in organization endpoint log policy mode.

set backup clear-n-backup {no| yes}

Syntax Description no The system event log is not cleared after a backup operation.

yes The system event log is cleared after a backup operation.

Command Default The system event log is not cleared after a backup operation.

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to specify whether to clear the system event log after a backup operation.

Examples This example shows how configure clearing of the system event log after a backup operation:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # set backup clear-on-backup yes
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Related Commands Command Description


show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


1052 OL-25718-02
Commands
set backup destination

set backup destination


To specify the destination for the system event log backup operation, use the set backup destination command
in organization endpoint log policy mode.

set backup destination url

Syntax Description url Specifies the URL where the system event log backup file will be stored.

Command Default None

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to specify the protocol, user, password, remote hostname, and remote path for the backup
operation. The url can be specified using the syntax of one of the following protocols:
• FTP— ftp:// hostname/path
• SCP— scp:// username@hostname/path
• SFTP— sftp:// username@hostname/path
• TFTP— tftp:// hostname:port-num/path

If the destination requires a username and password, use the URL format for the specific protocol, such as
ftp:// user:password@ hostname/path for FTP.

Note You can also configure the backup destination by using the set backup hostname , set backup password
, set backup protocol , set backup remote-path , set backup user commands.

Examples This example shows how configure an ftp destination with login for system event log backups:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # set backup destination
ftp://joe:password1@ftp.example.com/backups
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1053
Commands
set backup destination

Related Commands Command Description


show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


1054 OL-25718-02
Commands
set backup format

set backup format


To specify the format for the system event log backup file, use the set backup format command in
organization endpoint log policy mode.

set backup format{ascii| binary}

Syntax Description ascii Specifies that the backup file will be in ASCII format.

binary Specifies that the backup file will be in binary format.

Command Default ASCII

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to specify the format for the system event log backup file.

Examples This example shows how to specify a binary format for the system event log backup file:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # set backup format binary
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Related Commands Command Description


show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1055
Commands
set backup hostname

set backup hostname


To specify the host name or IP address of the system event log backup destination server, use the set backup
hostname command in organization endpoint log policy mode.

set backup hostname {hostname| ip-address}

Syntax Description hostname The host name of the backup destination server.

ip-address The IP address of the backup destination server.

Command Default None

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to specify the host name or IP address of the backup destination server.

Examples This example shows how to specify the host name of the backup destination server:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # set backup hostname ftp.example.com
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Related Commands Command Description


show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


1056 OL-25718-02
Commands
set backup interval

set backup interval


To specify the time interval between automatic backups of the system event log, use the set backup interval
command in organization endpoint log policy mode.

set backup interval {1-hour| 2-hours| 4-hours| 8-hours| 24-hours| never}

Syntax Description 1-hour Backups will occur at 1 hour intervals.

2-hour Backups will occur at 2 hour intervals.

4-hour Backups will occur at 4 hour intervals.

8-hour Backups will occur at 8 hour intervals.

24-hour Backups will occur at 24 hour intervals.

never Automatic backups are disabled.

Command Default None

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to enable or disable the automatic backup operation and to specify the time interval for
automatic backups. To disable automatic backups, specify the never keyword.

Examples This example shows how to specify automatic backups at 8 hour intervals:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # set backup interval 8-hours
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Related Commands Command Description


show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1057
Commands
set backup password

set backup password


To specify the password for the system event log backup destination server, use the set backup password
command in organization endpoint log policy mode.

set backup password password

Syntax Description password The login password for the backup destination server.

Command Default None

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to specify the password for connecting to the system event log backup destination server.
The password is not used when TFTP is the backup protocol.

Examples This example shows how to specify the password for connecting to the backup destination server:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # set backup password
Password:
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Related Commands Command Description


set backup user
show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


1058 OL-25718-02
Commands
set backup protocol

set backup protocol


To specify the file transfer protocol for the system event log backup, use the set backup protocol command
in organization endpoint log policy mode.

set backup protocol {ftp| scp| sftp| tftp}

Syntax Description ftp Specifies the FTP protocol for


backup file transfer.

scp Specifies the SCP protocol for


backup file transfer.

sftp Specifies the SFTP protocol for


backup file transfer.

tftp Specifies the TFTP protocol for


backup file transfer.

Command Default FTP

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to specify the file transfer protocol for the system event log backup.

Examples This example shows how to specify SFTP as the backup file transfer protocol:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # set backup protocol sftp
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Related Commands Command Description


show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1059
Commands
set backup remote-path

set backup remote-path


To specify the remote server path for system log file backups, use the set backup remote-path command
in organization endpoint log policy mode.

set backup remote-path remote-path

Syntax Description remote-path The remote path for backups.

Command Default None

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to specify the remote server path for system log file backups. The remote-path is a unique
set of up to 128 characters that identifies a path on the remote server. Do not use characters that are not allowed
in a URL.

Examples This example shows how to set the remote path for backups:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # set backup remote-path /test/sel/backups
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Related Commands Command Description


show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


1060 OL-25718-02
Commands
set backup user

set backup user


To specify a user name for the system event log backup destination server, use the set backup user command
in organization endpoint log policy mode.

set backup user user-name

Syntax Description user-name The login user name for the backup destination server.

Command Default None

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to specify a user name for connecting to the system event log backup destination server.
The user name can be up to 128 characters.

Examples This example shows how to specify a user name for connecting to the backup destination server:
switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # set backup user superUser
switch-A /org/ep-log-policy* # commit-buffer
switch-A /org/ep-log-policy #

Related Commands Command Description


set backup password
show backup
show ep-log-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1061
Commands
set basedn

set basedn
To set up a distinguished name, use the set basedn command.

set basedn basedn

Syntax Description basedn Distinguished name. The range of valid values is 1 to 127.

Command Default None

Command Modes LDAP (/security/ldap)


LDAP Server (/security/ldap/server)

Command History Release Modification


1.0(1) This command was introduced in the LDAP mode and the command option was
name .

1.4(1) This command was introduced in the LDAP server mode, and the command option
has been renamed as basedn

Usage Guidelines Use this command to restrict database searches to records that contain the specified distinguished name.

Examples This example shows how to set up a distinguished name:

switch-A#scope security

switch-A /security # scope ldap

switch-A /security/ldap # set basedn ldap

switch-A /security/ldap* # commit-buffer

switch-A /security/ldap #

Related Commands Command Description


show ldap
show tacacs

Cisco UCS Manager CLI Command Reference, Release 2.0


1062 OL-25718-02
Commands
set binddn

set binddn
To configure the distinguished name for the LDAP database superuser account, use the set binddn command.

set bindn bind-dist-name

Syntax Description bind-dist-name Distinguished name.

Command Default None

Command Modes LDAP Server (/security/ldap/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the distinguished name for the LDAP database superuser account. Enter a
name of up to 127 characters. If the name includes spaces, you must enclose the name in quotes (" ").

Examples This example shows how to configure the distinguished name:


switch-A# scope security
switch-A /security # scope ldap
switch-A /security/ldap # scope server MyServer
switch-A /security/ldap/server # set binddn "CN=John Smith,OU=Sales,DC=Example,DC=COM"
switch-A /security/ldap/server* # commit-buffer
switch-A /security/ldap/server #

Related Commands Command Description


show ldap
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1063
Commands
set bios-settings-scrub

set bios-settings-scrub
To specify whether the BIOS settings are cleared when the server is disassociated from a service profile, use
the set bios-settings-scrub command.

set bios-settings-scrub {no| yes}

Syntax Description no Disables BIOS settings scrub. The BIOS settings are preserved.

yes Enables BIOS settings scrub. The BIOS settings are reset to default.

Command Default BIOS settings scrub is disabled.

Command Modes Scrub policy (/org/scrub-policy)

Command History Release Modification


1.0(1) This command was introduced.

1.1(1) This command was deprecated.

1.3(1) This command was restored.

Usage Guidelines Use this command in a scrub policy to specify whether the BIOS settings in CMOS memory are cleared or
preserved when the server is disassociated from a service profile. The action taken is as follows:
• If enabled, erases all BIOS settings for the server and and resets them to the BIOS defaults for that server
type and vendor
• If disabled, preserves the existing BIOS settings on the server

Note This command is deprecated in some releases. With those releases, you can use the reset-cmos command
to manually reset the BIOS settings.

Examples This example shows how to specify in a scrub policy that the BIOS settings will be erased when the server is
disassociated:
switch-A# scope org org10
switch-A /org # scope scrub-policy scrub100
switch-A /org/scrub-policy # set bios-settings-scrub yes

Cisco UCS Manager CLI Command Reference, Release 2.0


1064 OL-25718-02
Commands
set bios-settings-scrub

switch-A /org/scrub-policy* # commit-buffer


switch-A /org/scrub-policy #

Related Commands Command Description


reset-cmos

show scrub-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1065
Commands
set blocksize

set blocksize
To set the block size, use the set blocksize command.

set blocksize {blocksize| unspecified}

Syntax Description blocksize Storage block size. The range of valid values is 0 to 4294967295.

unspecified Specifies an unspecified block size.

Command Default None

Command Modes Storage (/org/server-qual/storage)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the block size:

switch-A# scope org org3

switch-A /org # scope server-qual squal10

switch-A /org/server-qual # scope storage

switch-A /org/server-qual/storage # set blocksize 1000

switch-A /org/server-qual/storage* # commit-buffer

switch-A /org/server-qual/storage #

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


1066 OL-25718-02
Commands
set boot-option-retry-config retry

set boot-option-retry-config retry


To set the boot option retry configuration, use the set boot-option-retry-config retry command.

set boot-option-retry-config retry {disabled| enabled| platform-default}

Syntax Description disabled Use this option to disable the retry configuration.

enabled Use this option to enable the retry configuration.

platform-default Use this option to set the retry configuration to be the same as the platform
default.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


1.4(1) This command was introduced

Usage Guidelines A BIOS policy must be created to use this command.

Examples This example shows how to enable the retry configuration of the boot option.
UCS-A # scope org
UCS-A /org # scope bios-policy Sample
UCS-A /org/bios-policy # set boot-option-retry-config retry enable
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


create bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1067
Commands
set boot-policy

set boot-policy
To set the boot policy, use the set boot-policy command.

set boot-policy name

Syntax Description name Boot policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to associate the specified boot policy with the service profile you used to enter service
profile mode.

Examples This example shows how to set the boot policy:

switch-A# scope org org10

switch-A /org # scope service-profile servProf10

switch-A /org/service-profile # set boot-policy bootP10

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show association
show boot-definition

Cisco UCS Manager CLI Command Reference, Release 2.0


1068 OL-25718-02
Commands
set cap-policy

set cap-policy
To set a power capping policy, use the set cap-policy command.

set cap-policy {policy-driven-chassis-group-cap| manual-blade-level-cap}

Syntax Description policy-driven-chassis-group-cap Use this option to set a policy driven chassis group cap.

manual-blade-level-cap Use this option to set a manual blade level cap.

Command Default None

Command Modes Power capping management (/power-cap-mgmt)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to set the cap policy.


Switch-A # scope power-cap-mgmt
Switch-A /power-cap-mgmt # set cap-policy manual-blade-level-cap
Switch-A /power-cap-mgmt* # commit-buffer
Switch-A /power-cap-mgmt #

Related Commands Command Description


scope power-group
scope priority-weight

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1069
Commands
set cert

set cert
To enter a certificate in a keyring, use the set cert command.

set cert

Command Default None

Command Modes Keyring (/security/keyring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter a certificate into a keyring. When prompted, paste the text of the certificate at the
prompt, then type ENDOFBUF to finish.

Examples This example shows how to enter a certificate into a keyring:


switch-A# scope security
switch-A /security # scope keyring MyKR05
switch-A /security/keyring # set cert
Enter lines one at a time. Enter ENDOFBUF to finish. Press ^C to abort.
Keyring certificate:
>

Related Commands Command Description


show keyring

Cisco UCS Manager CLI Command Reference, Release 2.0


1070 OL-25718-02
Commands
set certchain

set certchain
To enter a list (or chain) of trustpoints, use the set certchain command.

set certchain[ certchain ]

Syntax Description certchain The name of a trustpoint. If this variable is omitted, you are prompted to enter
a name or names.

Command Default None

Command Modes Trustpoint (/security/trustpoint)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enter a list of one or more trustpoints defining a certification path to the root certificate
authority (CA). You can the enter up to 512 characters in the command line. If you do not specify trustpoints
in the command line, you are prompted to type or paste the information at the prompt, then type ENDOFBUF
to finish.

Examples This example shows how to enter a trustpoint certificate chain:


switch-A# scope security
switch-A /security # scope trustpoint MyTrust05
switch-A /security/trustpoint # set certchain
Enter lines one at a time. Enter ENDOFBUF to finish. Press ^C to abort.
Trustpoint Certificate Chain:
>

Related Commands Command Description


show trustpoint

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1071
Commands
set certificate

set certificate
To set up a certificate, use the set certificate command.

set certificate certificate-name

Syntax Description certificate-name The name of the certificate. The range of valid values is 1 to 512.

Command Default None

Command Modes Pending deletion (/system/vm-mgmt/vmware/pending-deletion)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to set the URL of the certificate:
switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # set certificate workspace:
switch-A /system/vm-mgmt/vmware* # commit-buffer
switch-A /system/vm-mgmt/vmware #

Cisco UCS Manager CLI Command Reference, Release 2.0


1072 OL-25718-02
Commands
set change-count

set change-count
To set the number of times a user password can be modified, use the set change-count command.

set change-count password change count

Syntax Description password change count Number of times the password can be changed. The value is a numeral
between 0 and 10.

Command Default None

Command Modes Password profile (/security/password-profile)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must be an administrator user or have aaa privileges to use this command.

Examples This example shows how to set the change count for a password to 6:
UCS-A # scope security
UCS-A /security # scope password-profile
UCS-A /security/password-profile # set change-count 6
UCS-A /security/password-profile* # commit-buffer
UCS-A /security/password-profile #

Related Commands Command Description


set change-during-interval

set change-interval

set history-count

set no-change-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1073
Commands
set change-during-interval

set change-during-interval
To enable or disable password modification during an interval, use the set change-during-interval command.

set change-during-interval {disable| enable}

Syntax Description disable Disables password modification during the interval

enable Enables password modification during the interval.

Command Default None

Command Modes Password profile (/security/password-profile)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must be an administrator user or have aaa privileges to use this command.

Examples This example shows how to enable password modification during the interval:
UCS-A # scope security
UCS-A /security # scope password-profile
UCS-A /security/password-profile # set change-during-interval enable
UCS-A /security/password-profile* # commit-buffer
UCS-A /security/password-profile #

Related Commands Command Description


set change-count

set change-interval

set history-count

set no-change-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


1074 OL-25718-02
Commands
set change-interval

set change-interval
To specify an interval for changing a password, use the set change-interval command.

set change-interval password change interval

Syntax Description password change interval Time duration in hours for changing a password. The value must be
between 1 and 745.

Command Default None

Command Modes Password profile (/security/password-profile)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must be administrator user or have aaa privileges to use this command.

Examples This example shows how to set the time duration for changing a password to 50 hours:
UCS-A # scope security
UCS-A /security # scope password-profile
UCS-A /security/password-profile # set change-interval 50
UCS-A /security/password-profile* # commit-buffer
UCS-A /security/password-profile #

Related Commands Command Description


set change-count

set change-during-interval

set history-count

set no-change-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1075
Commands
set cimxml port

set cimxml port


To set up a CIM (Common Information Model) XML port, use the set cimxml port command.

set cimxml port port

Syntax Description port Port number. The range of valid values is 1 to 65535.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set up a CIM XML port:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # set cimxml port 10

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show cimxml
show dns

Cisco UCS Manager CLI Command Reference, Release 2.0


1076 OL-25718-02
Commands
set clear-action

set clear-action
To specify whether all cleared fault messages will be retained or deleted, use the set clear-action command.

set clear-action {delete| retain}

Syntax Description delete Specifies that fault messages are deleted when cleared.

retain Specifies that fault messages are retained when cleared.

Command Default None

Command Modes Fault-policy (/monitoring/fault-policy)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to specify whether all cleared fault messages will be retained or deleted

Examples This example shows how to configure retention of cleared fault messages for 30 days:
switch-A# scope monitoring
switch-A /monitoring # scope fault policy
switch-A /monitoring/fault-policy # set clear-action retain
switch-A /monitoring/fault-policy* # set retention-interval 30 0 0 0
switch-A /monitoring/fault-policy* # commit-buffer
switch-A /monitoring/fault-policy #

Related Commands Command Description


set retention-interval
show fault policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1077
Commands
set clear password-history

set clear password-history


To enable or disable the option to clear the password history for a local user, use the set clear password
history command.

set clear password history {no| yes}

Syntax Description no Disables the option to clear password history for the local user.

yes Enables the option to clear password history for the local user.

Command Default None

Command Modes Local user (/security/local-user)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a local user before you use this command.
You must be an administrator user or have aaa privileges to use this command.

Examples This example shows how to enable the option for clearing password for a local user:
UCS-A # scope security
UCS-A /security # scope local-user sample
UCS-A /security/local-user # set clear password-history yes
UCS-A /security/local-user #

Related Commands Command Description


clear password-history
set password

Cisco UCS Manager CLI Command Reference, Release 2.0


1078 OL-25718-02
Commands
set cli suppress-field-spillover

set cli suppress-field-spillover


To select whether command output lines will wrap or truncate, use the set cli suppress-field-spillover
command.

set cli suppress-field-spillover {off| on}

Syntax Description off Command output lines wrap in the terminal window.

on Command output lines truncate at the end of the terminal window.

Command Default Command output lines wrap in the terminal window.

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to select whether command output lines will wrap or truncate to fit the width of the terminal
window.

Examples This example shows how to select whether command output lines will wrap or truncate:
Switch-A# scope monitoring
Switch-A /monitoring # set cli suppress-field-spillover on
Switch-A /monitoring # show fault
Severity Code Last Transition Time ID Description
--------- -------- ------------------------ -------- -----------
Warning F16520 2010-01-21T18:33:22.065 5785755 [FSM:STAGE:RETRY:]: detect
mezz cards in 1/6(FSM-STAGE:sam:dme:ComputeBladeDiscover:NicPresence)
Condition F77960 2010-01-21T18:32:31.255 1089623 [FSM:STAGE:REMOTE-ERROR]: R
esult: end-point-unavailable Code: unspecified Message: sendSamDmeAdapterInfo: i
dentify failed

Switch-A /monitoring # set cli suppress-field-spillover off


Switch-A /monitoring # show fault
Severity Code Last Transition Time ID Description
--------- -------- ------------------------ -------- -----------
Warning F16520 2010-01-21T18:33:22.065 5785755 [FSM:STAGE:RETRY:]: detect
Condition F77960 2010-01-21T18:32:31.255 1089623 [FSM:STAGE:REMOTE-ERROR]: R

Switch-A /monitoring #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1079
Commands
set cli suppress-field-spillover

Related Commands Command Description


set cli suppress-headers
set cli table-field-delimiter

Cisco UCS Manager CLI Command Reference, Release 2.0


1080 OL-25718-02
Commands
set cli suppress-headers

set cli suppress-headers


To display or suppress headers in command output tables, use the set cli suppress-headers command.

set cli suppress-headers {off| on}

Syntax Description off Table headers are displayed.

on Table headers are not displayed.

Command Default Table headers are displayed.

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to display or suppress headers in command output tables.

Examples This example shows how to suppress headers in command output tables:
Switch-A# scope monitoring
Switch-A /monitoring # show fsm task

FSM Task:
Item ID Completion FSM Flags
---------------- -------- ------------ ---------
Powercycle 1154858 Scheduled
BiosRecovery 1154860 Scheduled

Switch-A /monitoring # set cli suppress-headers on


Switch-A /monitoring # show fsm task

FSM Task:
Powercycle 1154858 Scheduled
BiosRecovery 1154860 Scheduled

Switch-A /monitoring #

Related Commands Command Description


set suppress field spillover
set suppress table field delimiter

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1081
Commands
set cli table-field-delimiter

set cli table-field-delimiter


To select the delimeter between fields in command output tables, use the set cli table-field-delimiter
command.

set cli table-field-delimiter {comma| none}

Syntax Description comma Add commas to separate fields in command output tables.

none Use spaces to separate fields in command output tables.

Command Default Spaces are used to separate fields in command output tables.

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to select the delimeter between fields in command output tables.

Examples This example shows how to select commas to separate fields in command output tables:
Switch-A# scope monitoring
Switch-A /monitoring # show fsm task

FSM Task:
Item ID Completion FSM Flags
---------------- -------- ------------ ---------
Powercycle 1154858 Scheduled
BiosRecovery 1154860 Scheduled

Switch-A /monitoring # set cli table-field-delimiter comma


Switch-A /monitoring # show fsm task

FSM Task:
,Item,ID,Completion,FSM Flags
----------------,--------,------------,---------
Powercycle,1154858,Scheduled,
BiosRecovery,1154860,Scheduled,

Switch-A /monitoring #

Cisco UCS Manager CLI Command Reference, Release 2.0


1082 OL-25718-02
Commands
set cli table-field-delimiter

Related Commands Command Description


set cli suppress field spillover
set cli suppress headers

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1083
Commands
set clock (memory)

set clock (memory)


To set the memory clock speed, use the set clock command.

set clock{number | unspec}

Syntax Description number Memory clock speed, in seconds. The range of valid values is 1 to 65535.

unspec Specifies unspecified speed.

Command Default None

Command Modes Memory (/org/server-qual/memory)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the memory clock speed:
switch-A# scope org org10
switch-A /org # scope server-qual sq10
switch-A /org/server-qual # scope memory
switch-A /org/server-qual/memory # set clock 10
switch-A /org/server-qual/memory* # commit-buffer
switch-A /org/server-qual/memory #

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


1084 OL-25718-02
Commands
set clock (system)

set clock (system)


To manually configure the system clock, use the set clock command.

set clock month date year hour minute second

Syntax Description month Enter the three-letter abbreviation for the month.

date Enter a date from 1 to 31.

year Enter the full year.

hour Enter the hour from 0 to 23.

minute Enter the minute from 0 to 59.

second Enter the seconds from 0 to 59.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.3(1) This command was introduced.

Examples This example shows how to manually set the system clock:
switch-A# scope system
switch-A /system # scope services
switch-A /system/services # set clock apr 14 2010 15 27 00
switch-A /system/services* # commit-buffer
switch-A /system/services #

Related Commands Command Description


set timezone

show clock

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1085
Commands
set cluster

set cluster
To set a cluster for a port profile, use the set cluster command.

set cluster cluster

Syntax Description cluster Name of the cluster. The name can include a maximum of 256 alphanumeric
characters.

Command Default None

Command Modes Client within a port-profile (/system/vm-mgmt/profile-set/port-profile/client)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a client within a port profile before you use this command.

Examples This example shows how to set the cluster for a port profile:
UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope profile-set
UCS-A /system/vm-mgmt/profile-set # scope port-profile sample
UCS-A /system/vm-mgmt/profile-set/port-profile # scope client test
UCS-A /system/vm-mgmt/profile-set/port-profile/client # set cluster Trial123
UCS-A /system/vm-mgmt/profile-set/port-profile/client* # commit-buffer
UCS-A /system/vm-mgmt/profile-set/port-profile/client #

Related Commands Command Description


set data-center

set descr

set folder

Cisco UCS Manager CLI Command Reference, Release 2.0


1086 OL-25718-02
Commands
set collection-interval

set collection-interval
To specify the interval at which statistics are collected from the system, use the set collection-interval
command.

set collection-interval {1minute| 2minutes| 30seconds| 5minutes}

Syntax Description 1minute Statistics are collected at an interval of one minute.

2minutes Statistics are collected at an interval of two minutes.

30seconds Statistics are collected at an interval of thirty seconds.

5minutes Statistics are collected at an interval of five minutes.

Command Default Statistics are collected at an interval of one minute.

Command Modes Statistics collection policy (/monitoring/stats-collection-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the interval at which statistics are collected from the system. You can specify
the collection interval separately for chassis, port, host, adapter, and server statistics.

Examples This example shows how to set the port statistics collection interval to five minutes:
switch-A# scope monitoring
switch-A /monitoring # scope stats-collection-policy port
switch-A /monitoring/stats-collection-policy # set collection-interval 5minutes
switch-A /monitoring/stats-collection-policy* # commit-buffer
switch-A /monitoring/stats-collection-policy #

Related Commands Command Description


set reporting-interval
show stats-collection-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1087
Commands
set communication-policy-ctrl

set communication-policy-ctrl
To set a communication policies control, use the create communication-policy-ctrl command.

create communication-policy-ctrlsource

Syntax Description source The source of the policy control. The source can be global or local.

Command Default By default, the policy control source is set to local.

Command Modes Policy control endpoint (/system/control-ep)

Command History Release Modification


2.1(1) This command was introduced.

Usage Guidelines A policy control endpoint must be created to use this command.

Examples This example shows how to set the communication policies control to global.
UCS-A # scope system
UCS-A /system # scope control-ep policy
UCS-A /system/control-ep # set communication-policy-ctrl source global
UCS-A /system/control-ep* # commit-buffer
UCS-A /system/control-ep #

Related Commands Command Description


create control-ep policy

set backup-control-ctrl

set datetime-policy-ctrl

set dns-policy-ctrl

set fault-policy-ctrl

set infra-pack-ctrl

set mep-policy-ctrl

set monitoring-policy-ctrl

Cisco UCS Manager CLI Command Reference, Release 2.0


1088 OL-25718-02
Commands
set communication-policy-ctrl

Command Description
set powermgmt-policy-ctrl

set psu-policy-ctrl

set registry-ip

set security-policy-ctrl

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1089
Commands
set community

set community
To specify the SNMP community access string for the SNMP trap destination, use the set community
command.

set community community

Syntax Description community Specifies the SNMPv1/v2c community string or the SNMPv3 username for the
trap destination. Enter up to 32 characters with no spaces.

Command Default None

Command Modes SNMP trap (/monitoring/snmp-trap)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the community access string to permit access to the Simple Network Management
Protocol (SNMP) trap destination. If SNMPv1/v2c is configured, the community argument is used as the
community string. If SNMPv3 is configured, it is used as the msgUserName value.

Examples This example shows how to set the SNMP community access string for the SNMP trap destination:
switch-A# scope monitoring
switch-A /monitoring # create snmp-trap 192.20.1.28
switch-A /monitoring/snmp-trap* # set community Community28
switch-A /monitoring/snmp-trap* # commit-buffer
switch-A /monitoring/snmp-trap #

Related Commands Command Description


show snmp-trap

Cisco UCS Manager CLI Command Reference, Release 2.0


1090 OL-25718-02
Commands
set comp-queue count

set comp-queue count


To configure the number of completion queue resources to allocate, use the set comp-queue count command.

set comp-queue count count

Syntax Description count Number of queue resources.

Command Default The completion queue count is 2.

Command Modes Ethernet adapter policy (/org/eth-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the number of completion queue resources to allocate. Configure a count
between 1 and 521. In general, the number of completion queues equals the number of transmit queues plus
the number of receive queues.

Examples This example shows how to configure the number of completion queue resources for an Ethernet policy:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set recv-queue count 100
switch-A /org/eth-policy* # set trans-queue count 100
switch-A /org/eth-policy* # set comp-queue count 200
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


set recv-queue count
set trans-queue count
show eth-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1091
Commands
set concur-tasks

set concur-tasks
To set a maximum number of concurrent tasks that can be processed by either the one-time or the periodic
schedule, use the set concur-tasks command.

set concur-tasks {concur-jobs| unlimited}

Syntax Description concur-jobs This option specifies the maximum number of concurrent tasks that the schedule
can process. The value must be a number between 0 - 65535.

unlimited This option indicates that the schedule can run any number of concurrent tasks.

Command Default None

Command Modes One-time occurrence of a schedule (/system/schedule/one-time)


Periodic occurrence of a schedule (/system/schedule/periodic)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A schedule, be it one-time or periodic, must be created to use this command.

Examples This example shows how to set the number of concurrent jobs for a one-time occurrence of a schedule to 23.
Switch-A # scope system
Switch-A /system # scope scheduler Default
Switch-A /system/schedule # scope occurrence one-time Testing
Switch-A /system/schedule/one-time # set concur jobs 23
Switch-A /system/schedule/one-time* # commit-buffer
Switch-A /system/schedule/one-time #

Related Commands Command Description


set date
set max-duration
set min-interval
show occurrence one-time
show occurrence periodic

Cisco UCS Manager CLI Command Reference, Release 2.0


1092 OL-25718-02
Commands
set console-redir-config baud-rate

set console-redir-config baud-rate


To set the serial port transmission speed of a serial port used for server management tasks, use the set
console-redir-config baud-rate command.

set console-redir-config baud-rate {115200| 57600| 38400| 19200| 9600| platform-default}

Syntax Description 115200 | 57600 | 38400 | 19200 | 9600 Specifies the serial port baud rate.

platform-default The BIOS uses the value for this


attribute contained in the BIOS
defaults for the server type and
vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines If a serial port can be used for management tasks, use this command to set the serial port transmission speed
so that it matches the rate of the remote terminal application.

Examples The following example shows how to create a BIOS policy specifying that serial port A is configured for
management tasks and operates at 19200 baud:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set console-redir-config console-redir serial-port-a
switch-A /org/bios-policy* # set console-redir-config baud-rate 19200
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1093
Commands
set console-redir-config console-redir

set console-redir-config console-redir


To specify whether a serial port can be used for server management tasks, use the set console-redir-config
console-redir command.

set console-redir-config console-redir {disabled| serial-port-a| serial-port-b| platform-default}

Syntax Description disabled Serial ports cannot be used for


management tasks.

serial-port-a Serial port A is configured for


management tasks.

serial-port-b Serial port B is configured for


management tasks.

platform-default The BIOS uses the value for this


attribute contained in the BIOS
defaults for the server type and
vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to specify whether a serial port can be used for server management tasks.

Examples The following example shows how to create a BIOS policy specifying that serial port A is configured for
management tasks:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set console-redir-config console-redir serial-port-a
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Cisco UCS Manager CLI Command Reference, Release 2.0


1094 OL-25718-02
Commands
set console-redir-config console-redir

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1095
Commands
set console-redir-config flow-control

set console-redir-config flow-control


To configure a flow control policy for the console redirection configuration, use the set console-redir-config
flow-control command.

set console-redir-config flow-control {none| platform-default| rts-cts}

Syntax Description none Use this option to not set a flow control policy.

platform-default Use this option to set the flow control policy to the platform default option.

rts-cts Use this option to set the flow control policy to RTS-CTS.

Command Default None

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A BIOS policy must be created to use this command.

Examples This example shows how to set the flow control policy of the console redirection configuration to RTS-CTS.
Switch-A # scope org
Switch-A /org # scope bios-policy sample
Switch-A /org/bios-policy # set console-redir-config flow-control rts-cts
Switch-A /org/bios-policy* # commit-buffer
Switch-A /org/bios-policy #

Related Commands Command Description


set console-redir-config baud-rate
set console-redir-config console-redir
set console-redir-config legacy-os-redir
set console-redir-config terminal-type

Cisco UCS Manager CLI Command Reference, Release 2.0


1096 OL-25718-02
Commands
set console-redir-config legacy-os-redir

set console-redir-config legacy-os-redir


To configure the legacy operating system redirection for the console redirection configuration, use the set
console-redir-config legacy-os-redir command.

set console-redir-config legacy-os-redir {disabled| enabled| platform-default}

Syntax Description disabled Use this option to disable the legacy OS redirection policy.

enabled Use this option to enable the legacy OS redirection policy.

platform-default Use this option to configure the platform default option.

Command Default None

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A BIOS policy must be configured to use this command.

Examples This example shows how to enable the legacy OS redirection for the console redirection configuration.
Switch-A # scope org
Switch-A /org # scope bios-policy sample
Switch-A /org/bios-policy # set console-redir-config legacy-os-redir enable
Switch-A /org/bios-policy* # commit-buffer
Switch-A /org/bios-policy #

Related Commands Command Description


set console-redir-config baud-rate
set console-redir-config console-redir
set console-redir-config flow-control
set console-redir-config terminal-type

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1097
Commands
set console-redir-config terminal-type

set console-redir-config terminal-type


To set a terminal type for the console redirection configuration, use the set console-redir-config terminal-type
command.

set console-redir-config terminal-type {pc-ansi| platform-default| vt-utf8| vt100| vt100-plus}

Syntax Description pc-ansi Use this option to set the terminal type to Pc Ansi.

platform-default Use this option to set the terminal type to the platform default.

vt-utf8 Use this option to set the terminal type to Vt Utf8.

vt100 Use this option to set the terminal type to Vt100.

vt100-plus Use this option to set the terminal type to Vt100 Plus.

Command Default None

Command Modes BIOS Policy (/org/bios-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A BIOS policy must be created to use this command.

Examples This example shows how to set the terminal type to platform default.
Switch-A # scope org
Switch-A /org # scope bios-policy sample
Switch-A /org/bios-policy # set console-redir-config terminal-type platform-default
Switch-A /org/bios-policy* # commit-buffer
Switch-A /org/bios-policy #

Related Commands Command Description


set console-redir-config baud-rate
set console-redir-config console-redir
set console-redir-config flow-control

Cisco UCS Manager CLI Command Reference, Release 2.0


1098 OL-25718-02
Commands
set console-redir-config terminal-type

Command Description
set console-redir-config legacy-os-redir

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1099
Commands
set contact

set contact
To configure a primary Call Home contact person for the customer organization, use the set contact command.

set contact contact

Syntax Description contact The name of the primary contact person.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to configure a primary Call Home contact person for the customer organization. The contact
name will be included in Call Home messages. Enter up to 255 characters. If the name includes spaces, you
must enclose your entry in quotes (" ").

Examples This example shows how to configure a primary contact name:


switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set contact "Jane Doe"
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


1100 OL-25718-02
Commands
set contract-id

set contract-id
To configure the customer contract ID for the monitored equipment, use the set contract-id command.

set contract-id contract-id

Syntax Description contract-id Customer contract identifier.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to configure the customer contract ID to be included in Call Home messages for the
monitored equipment. The ID can contain up to 512 characters.

Examples This example shows how to configure the customer contract ID:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set contract-id ExampleCorp1234
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1101
Commands
set core-export-target path

set core-export-target path


To specify the path to use when exporting the core file to the remote server, use the set core-export-target
path command.

set core-export-target path path

Syntax Description path Specifies a path on the remote server.

Command Default None

Command Modes System debug (/monitoring/sysdebug)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the path to use when exporting the core file to the remote server. The path can
be up to 512 characters.

Examples This example shows how to specify the remote server path for exporting the core file:
switch-A# scope monitoring
switch-A /monitoring # scope sysdebug
switch-A /monitoring/sysdebug # set core-export-target path /root/CoreFiles/core
switch-A /monitoring/sysdebug* # commit-buffer
switch-A /monitoring/sysdebug #

Related Commands Command Description


show core-export-target

Cisco UCS Manager CLI Command Reference, Release 2.0


1102 OL-25718-02
Commands
set core-export-target port

set core-export-target port


To specify the port number to use when exporting the core file by TFTP, use the set core-export-target port
command.

set core-export-target port port

Syntax Description port Specifies the port number to be used for the TFTP transfer.

Command Default The standard TFTP port number (69) is used.

Command Modes System debug (/monitoring/sysdebug)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the port number to use when exporting the core file by TFTP. The range of valid
values is 1 to 65535; the default is 69, the standard TFTP port number.

Examples This example shows how to specify the port number on the remote server for exporting the core file:
switch-A# scope monitoring
switch-A /monitoring # scope sysdebug
switch-A /monitoring/sysdebug # set core-export-target port 45000
switch-A /monitoring/sysdebug* # commit-buffer
switch-A /monitoring/sysdebug #

Related Commands Command Description


show core-export-target

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1103
Commands
set core-export-target server-description

set core-export-target server-description


To provide a description of the remote server that stores the core file, use the set core-export-target
server-description command.

set core-export-target server-description description

Syntax Description description A description of the remote server that stores the core file.

Command Default None

Command Modes System debug (/monitoring/sysdebug)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to provide a description of the remote server that stores the core file. The description can
be up to 256 characters. If your description includes spaces, special characters, or punctuation, you must begin
and end your description with quotation marks (" "). The quotation marks will not appear in the description
field of any show command output.

Examples This example shows how to provide a description of the remote server for exporting the core file:
switch-A# scope monitoring
switch-A /monitoring # scope sysdebug
switch-A /monitoring/sysdebug # set core-export-target server-description
CoreFile102.168.10.10
switch-A /monitoring/sysdebug* # commit-buffer
switch-A /monitoring/sysdebug #

Related Commands Command Description


show core-export-target

Cisco UCS Manager CLI Command Reference, Release 2.0


1104 OL-25718-02
Commands
set core-export-target server-name

set core-export-target server-name


To specify the name or IP address of the remote server that stores the core file, use the set core-export-target
server-name command.

set core-export-target server-name server-name

Syntax Description server-name The name or IP address of the remote server.

Command Default None

Command Modes System debug (/monitoring/sysdebug)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the name or IP address of the remote server that stores the core file. The server
name can be up to 255 characters.

Examples This example shows how to specify the remote server name for exporting the core file:
switch-A# scope monitoring
switch-A /monitoring # scope sysdebug
switch-A /monitoring/sysdebug # set core-export-target server-name 192.168.10.10
switch-A /monitoring/sysdebug* # commit-buffer
switch-A /monitoring/sysdebug #

Related Commands Command Description


show core-export-target

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1105
Commands
set correctible-memory-error-log-threshold-config

set correctible-memory-error-log-threshold-config
To specify whether the system uses continuous correctable error logging, use the set
correctible-memory-error-log-threshold-config command.

set correctible-memory-error-log-threshold-config correctable-memory-error-log-threshold {allerror|


regularlogscheme| platform-default}

Syntax Description allerror Whenever a corrected error occurs in the server platform, the BIOS generates
an SEL event immediately.

regularlogscheme The BIOS accumulates the threshold number of (currently 10) correctible errors
and generates one SEL event when number of errors exceeds threshold.

platform-default The BIOS uses the value for this attribute contained in the BIOS defaults for
the server type and vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to specify whether the system uses continuous correctable error logging.

Examples The following example shows how to create a BIOS policy specifying that an SEL event is generated
immediately when a correctable error occurs:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set correctible-memory-error-log-threshold-config
correctible-memory-error-log-threshold allerror
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1106 OL-25718-02
Commands
set cos

set cos
To set up CoS (Class of Service), use the set cos command.

set cos {cos| any}

Syntax Description cos Class of Service. The range of valid values is 0 to 6.

any Specifies any level of CoS.

Command Default None

Command Modes Ethernet classified (/eth-server/qos/eth-classified)


Fibre Channel QoS (/eth-server/qos/fc)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to set the priority of traffic. A higher value indicates more important traffic. Setting CoS
at 6 specifies the most important traffic.

Examples This example shows how to set up CoS:

switch-A# scope eth-server

switch-A /eth-server # scope qos

switch-A /eth-server/qos # scope eth-classified

switch-A /eth-server/qos/eth-classified # set cos 6

switch-A /eth-server/qos/eth-classified* # commit-buffer

switch-A /eth-server/qos/eth-classified #

Related Commands Command Description


show eth-best-effort
show eth-classified

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1107
Commands
set country

set country
To specify a country for a certificate request of a key ring, use the set country command.

set country Country name

Syntax Description Country name The country code corresponding to the country in which the company resides.
Enter two alphabetic characters

Command Default None

Command Modes Certificate Request (/security/keyring/certreq)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines You should create a certificate request before specifying the country details.

Examples The following example shows how to set the country information for a certificate request.
UCS-A # scope security
UCS-A /security # scope keyring test
UCS-A /security/keyring # create certreq
UCS-A /security/keyring/certreq* # set country US
UCS-A /security/keyring/certreq* # commit buffer
UCS-A /security/keyring/certreq #

Related Commands Command Description


set dns

set e-mail

set ip

set locality

set org-name

set org-unit-name

set state

Cisco UCS Manager CLI Command Reference, Release 2.0


1108 OL-25718-02
Commands
set country

Command Description
set subject-name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1109
Commands
set cpu-performance-config cpu-performance

set cpu-performance-config cpu-performance


To set the CPU performance profile for the server, use the set cpu-performance-config cpu-performance
command.

set cpu-performance-config cpu-performance {enterprise| high-throughput| hpc| platform-default}

Syntax Description enterprise Disables all prefetchers and data reuse.

high-throughput Enables all prefetchers, but data reuse is disabled.

hpc Enables all prefetchers and data reuse. This setting is also known as high
performance computing.

platform-default Sets the value for this attributed contained in the BIOS defaults for the
server type and vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines You must create a BIOS policy before you use this command.

Examples This example shows how to set the CPU performance profile of the server to the platform default option:
UCS-A # scope org test
UCS-A /org # scope bios-policy sample
UCS-A /org/bios-policy # set cpu-performance-config cpu-performance platform-default
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


create bios-policy

set intel-turbo-boost-config turbo-boost

Cisco UCS Manager CLI Command Reference, Release 2.0


1110 OL-25718-02
Commands
set cpu-performance-config cpu-performance

Command Description
set enhanced-intel-speedstep-config speed-step

set hyper-threading-config hyper-threading

set core-multi-processing-config multi-processing

set execute-disable bit

set intel-vt-config vt

set direct-cache-access-config access

set processor-c-state-config c-state

set processor-c1e-config c1e

set processor-c3-report-config processor-c3-report

set processor-c6-report-config processor-report

set max-variable-mtrr-setting-config processor-mtrr

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1111
Commands
set customer-id

set customer-id
To configure customer identifier (ID) information for Call Home messages, use the set customer-id command.

set customer-id customer-id

Syntax Description customer-id Customer identifier text information.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to configure customer identifier information to be included in Call Home messages for the
monitored equipment. Enter up to 512 characters.

Examples This example shows how to configure the customer ID:


switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set customer-id ExampleCorp
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


1112 OL-25718-02
Commands
set data-center

set data-center
To set up a data center, use the set data-center command.

set data-center datacenter-name

Syntax Description datacenter-name The name of the data center. The range of valid values is 1 to 16.

Command Default None

Command Modes Pending deletion (/system/vm-mgmt/vmware/pending-deletion)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to set up a data center:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope pending-deletion
switch-A /system/vm-mgmt/vmware/pending-deletion # set data-center dc1
switch-A /system/vm-mgmt/vmware/pending-deletion #

Related Commands Command Description


show data-center
show pending-deletion

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1113
Commands
set data-center-folder

set data-center-folder
To set up a data center folder, use the set data-center-folder command.

set data-center-folder datacenter-folder-name

Syntax Description datacenter-folder-name The name of the data center. The range of valid values is 1 to 16.

Command Default None

Command Modes Pending deletion (/system/vm-mgmt/vmware/pending-deletion)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to set up a data center folder:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope pending-deletion
switch-A /system/vm-mgmt/vmware/pending-deletion # set data-center-folder dcf1
switch-A /system/vm-mgmt/vmware/pending-deletion #

Related Commands Command Description


show data-center-folder
show pending-deletion

Cisco UCS Manager CLI Command Reference, Release 2.0


1114 OL-25718-02
Commands
set data-center (/client)

set data-center (/client)


To set a data center for a client within a port profile, use the set data-center command.

set data-center data-center

Syntax Description data-center Name of the data center. The value can include a maximum of 256
alphanumeric characters.

Command Default None

Command Modes Client within a port profile (/system/vm-mgmt/profile-set/port-profile/client)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines A client must be created within the port profile before you use this command.

Examples This example show how to set a data center for a client within the port profile mode:
UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope profile-set
UCS-A /system/vm-mgmt/profile-set # scope port-profile sample
UCS-A /system/vm-mgmt/profile-set/port-profile # scope client test
UCS-A /system/vm-mgmt/profile-set/port-profile/client # set data-center Trial13
UCS-A /system/vm-mgmt/profile-set/port-profile/client* # commit-buffer
UCS-A /system/vm-mgmt/profile-set/port-profile/client #

Related Commands Command Description


set cluster

set descr

set folder

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1115
Commands
set date

set date
To set specific parameters such as month, day, date and time for a one-time maintenance window, use the set
date command.

set date {apr| aug| dec| feb| jan| jul| jun| mar| may| nov| oct| sep} dayofmonth year hour minute

Syntax Description apr Use this option to specify the month April for the maintenance window.

aug Use this option to specify the month August for the maintenance window.

dec Use this option to specify the month December for the maintenance window.

feb Use this option to specify the month February for the maintenance window.

jan Use this option to specify the month January for the maintenance window.

jul Use this option to specify the month July for the maintenance window.

jun Use this option to specify the month June for the maintenance window .

mar Use this option to specify the month March for the maintenance window .

may Use this option to specify the month May for the maintenance window.

nov Use this option to specify the month November for the maintenance window.

oct Use this option to specify the month October for the maintenance window.

sep Use this option to specify the month September for the maintenance window.

dayofmonth Use this option to specify a day of the month when this maintenance window must
run. The range of valid values is between 1 - 31.

year Use this option to specify the year in which this maintenance window must run. The
range of valid values is between 1900 - 29999

hour Use this option to specify the hour in which this maintenance window must run. The
range of valid values is between 0 - 23 hours.

minute Use this option to specify the exact minute at which this maintenance window must
run. The range of valid values is between 0 - 59.

Command Default None

Command Modes One-time maintenance window (/system/scheduler/one-time)

Cisco UCS Manager CLI Command Reference, Release 2.0


1116 OL-25718-02
Commands
set date

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A scheduler policy and a one-time maintenance window must be created to use this command.

Examples This example shows how to set the parameters for the one-time maintenance window.
Switch-A # scope system
Switch-A /system # scope scheduler Sample
Switch-A /system/scheduler # scope maint-window one-time Trial
Switch-A /system/scheduler/one-time # set date nov 22 2010 3 45
Switch-A /system/scheduler/one-time* # commit-buffer
Switch-A /system/scheduler/one-time #

Related Commands Command Description


create maint-window one-time
show maint-window one-time
set max-duration
set min-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1117
Commands
set day

set day
To set a day of the week that the periodic maintenance window must run, use the set day command.

set day
set day {Friday| Monday| Saturday| Sunday| Thursday| Tuesday| Wednesday| even-day| every-day|
never| odd-day}

Syntax Description Friday Use this option to set Friday for the maintenance window.

Monday Use this option to set Monday for the maintenance window.

Saturday Use this option to set Saturday for the maintenance window.

Sunday Use this option to set Sunday for the maintenance window.

Thursday Use this option to set Thursday for the maintenance window.

Tuesday Use this option to set Tuesday for the maintenance window.

Wednesday Use this option to set Wednesday for the maintenance window.

even-day Use this option to set the maintenance window to run on every even day of
the week.

every-day Use this option to set the maintenance window to run every day of the week.

never Use this option to not set a day for the maintenance window to run.

odd-day Use this option to set the maintenance window to run on every odd day of
the week.

Command Default None

Command Modes Periodic maintenance window (/system/scheduler/periodic)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A scheduler policy and a periodic maintenance window must be created to use this command.

Cisco UCS Manager CLI Command Reference, Release 2.0


1118 OL-25718-02
Commands
set day

Examples This example shows how to set a day for a periodic maintenance window to run.
Switch-A # scope system
Switch-A /system # scope scheduler Sample
Switch-A /system/scheduler # scope maint-window periodic Testing
Switch-A /system/scheduler/periodic # set day Friday
Switch-A /system/scheduler/periodic* # commit-buffer
Switch-A /system/scheduler/periodic #

Related Commands Command Description


set concur-jobs
set hour
set max-duration
set min-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1119
Commands
set deescalating

set deescalating
To specify the class property threshold value for de-escalating an event, use the set escalating command.

set deescalating value

Syntax Description value The property value at which the event will be de-escalated. See the Usage Guidelines
for the required format.

Command Default None

Command Modes Statistics class property threshold value (/org/stats-threshold-policy/class/property/threshold-value)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the class property threshold value for de-escalating an event. The format of the
value argument varies depending on the class property threshold value being configured. To see the required
format, enter the set deescalating ? command.

Note You can specify both de-escalating and escalating class property threshold values.

Examples This example creates an above normal warning threshold of 50° C, de-escalating the warning at 49° C:
switch-A /org* # scope stats-threshold-policy ServStatsPolicy
switch-A /org/stats-threshold-policy* # create class cpu-stats
switch-A /org/stats-threshold-policy/class* # create property cpu-temp
switch-A /org/stats-threshold-policy/class/property* # set normal-value 48.5
switch-A /org/stats-threshold-policy/class/property* # create threshold-value above-normal
warning
switch-A /org/stats-threshold-policy/class/property/threshold-value* # set escalating 50.0
switch-A /org/stats-threshold-policy/class/property/threshold-value* # set deescalating
49.0
switch-A /org/stats-threshold-policy/class/property/threshold-value* # commit-buffer
switch-A /org/stats-threshold-policy/class/property/threshold-value #

Related Commands Command Description


set escalating

Cisco UCS Manager CLI Command Reference, Release 2.0


1120 OL-25718-02
Commands
set default-gw

set default-gw
To set a default gateway for an external static IP address, use the set default-gw command.

set default-gw default-gw

Syntax Description default-gw The IP address of the default gateway. It must be in the a.b.c.d format.

Command Default None

Command Modes External static IP address within CIMC (/chassis/server/cimc/ext-static-ip)


External static IP address within Service profile (/org/service-profile/ext-static-ip)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A service profile must be created to use this command.

Examples This example shows how to set a default gateway for a service profile.
Switch-A # scope org
Switch-A /org # scope service-profile sample
Switch-A /org/service-profile # scope ext-static-ip
Switch-A /org/service-profile/ext-static-ip # set default-gw 1.2.3.4
Switch-A /org/service-profile/ext-static-ip* # commit-buffer
Switch-A /org/service-profile/ext-static-ip #

Related Commands Command Description


set addr
set subnet

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1121
Commands
set default-net

set default-net
To set the current interface or VLAN as the default network, use the set default-net command.

set default-net {no| yes}

Syntax Description no Specifies that the current interface or VLAN is not the default network.

yes Specifies that the current interface or VLAN is the default network.

Command Default None

Command Modes Virtual NIC (/org/service-profile/vnic/eth-if)


Virtual NIC template (/org/vnic-templ/eth-if)
VMware port profile VLAN (/system/vm-mgmt/vmware/port-profiles/port-profile/vlan)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to set the current interface or VLAN as the default network.

Examples This example shows how to create an Ethernet interface and make the interface the default network:
switch-A# scope org org10
switch-A /org # scope service-profile sp10
switch-A /org/service-profile # scope vnic vn10
switch-A /org/service-profile/vnic # create eth-if if10
switch-A /org/service-profile/vnic/eth-if* # set default-net yes
switch-A /org/service-profile/vnic/eth-if* # commit-buffer
switch-A /org/service-profile/vnic/eth-if #

Related Commands Command Description


show eth-if
show vlan

Cisco UCS Manager CLI Command Reference, Release 2.0


1122 OL-25718-02
Commands
set defaultzoning

set defaultzoning
To enable or disable default zoning for a VSAN, use the set default-zoning command.

set defaultzoning {disabled| enabled}

Syntax Description disabled Use this option to disable default zoning.

enabled Use this option to enable default zoning.

Command Default None

Command Modes VSAN within Fibre Channel storage (/fc-storage/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A VSAN must be created to use this command.

Examples This example shows how to set the default zoning for VSAN.
Switch-A # scope fc-storage
Switch-A /fc-storage # scope vsan sample
Switch-A /fc-storage/vsan # set defaultzoning enabled
Switch-A /fc-storage/vsan* # commit-buffer
Switch-A /fc-storage/vsan #

Related Commands Command Description


set fcoe-vlan
set id

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1123
Commands
set descr

set descr
To set a description, use the set descr command.

set descr description

Syntax Description description Description. Enter up to 256 characters.

Command Default None

Command Modes Backup (/system/backup)


Statistics threshold policy under Ethernet server (/eth-server/stats-threshold-policy)
Virtual NIC template (/org/vnic-templ)
Statistics threshold policy under organization (/org/stats-threshold-policy)
MAC pool (/org/mac-pool)
Partition (/org/local-disk-config/partition)
Import configuration (/system/import-config)
Pooling policy (/org/pooling-policy)
VMM provider (/system/vm-mgmt/vmm-provider)
Service profile (/org/service-profile)
UUID suffix pool (/org/uuid-suffix-pool)
Pin group under Ethernet uplink (/eth-uplink/pin-group)
Fibre Channel policy (/org/fc-policy)
SoL (/org/service-profile/sol)
IP pool (/org/ip-pool)
Ethernet policy (/org/eth-policy)
Statistics threshold policy under Fibre Channel uplink (/fc-uplink/stats-threshold-policy)
Server discovery policy (/org/server-disc-policy)
Pin group under Fibre Channel uplink (/fc-uplink/pin-group)
PSU policy (/org/psu-policy)
Boot policy (/org/boot-policy)
Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)
Local disk configuration under organization (/org/local-disk-config)
Virtual HBA template (/org/vhba-templ)
Firmware management pack (/org/fw-mgmt-pack)

Cisco UCS Manager CLI Command Reference, Release 2.0


1124 OL-25718-02
Commands
set descr

Initiator (/org/wwn-pool/initiator)
Boot definition (/org/service-profile/boot-def)
Chassis discovery policy under organization (/org/chassis-disc-policy)
Automatic configuration policy (/org/autoconfig-policy)
SoL policy (/org/sol-policy)
Scrub policy (/org/scrub-policy)
Local disk configuration under service profile (/org/service-profile/local-disk-config)
Firmware host pack under organization (/org/fw-host-pack)
Port profile (/eth-uplink/port-profile)
WWN pool (/org/wwn-pool)
Server inherit policy under organization (/org/server-inherit-policy)
IPMI user (/org/ipmi-access-profile/ipmi-user)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines If your description includes spaces, special characters, or punctuation, you must begin and end your description
with quotation marks. The quotation marks will not appear in the description field of any show command
output

Examples This example shows how to set a description:

switch-A# scope org org10

switch-A /org # scope boot-policy boot100

switch-A /org/boot-policy # set descr bootOnce

switch-A /org/boot-policy* # commit-buffer

switch-A /org/boot-policy #

Related Commands Command Description


show boot-policy
show detail

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1125
Commands
set description

set description
To set the description of the VCenter server, use the set description command.

set description server-description

Syntax Description server-description The description of the server.

Command Default The description field is left empty.

Command Modes VCenter (/system/vm-mgmt/vmware/vcenter)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines The description of the VCenter server should be a unique set of numbers, letters, or a combination of numbers
and letters that identifies the server. The range of valid values is 1 to 256. If your description includes spaces,
special characters, or punctuation, you must begin and end your description with quotation marks. The quotation
marks will not appear in the description field of any show command output.

Examples This example shows how to set the description of the VCenter server:
switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter marComm
switch-A /system/vm-mgmt/vmware/vcenter # set description marketingVCenter
switch-A /system/vm-mgmt/vmware/vcenter* # commit-buffer
switch-A /system/vm-mgmt/vmware/vcenter #

Related Commands Command Description


show data-center
show vcenter

Cisco UCS Manager CLI Command Reference, Release 2.0


1126 OL-25718-02
Commands
set descr (vcon-policy)

set descr (vcon-policy)


To set up a description for a vCon policy (vNIC/vHBA placement profile), use the set descr command.

set descr policy-description

Syntax Description policy-description The description of the policy.

Command Default None

Command Modes vCon policy (/org/vcon-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Provides a description for the vNIC/vHBA placement profile. vCon policies determine the placement and
distribution of vNICs and vHBAs between the adapters for a server that has more than one adapter.
If your description includes spaces, special characters, or punctuation, you must begin and end your description
with quotation marks. The quotation marks will not appear in the description field of any show command
output.

Examples This example shows how to set up a description for a vCon policy:
switch-A# scope org /
switch-A /org # scope vcon-policy vcp100
switch-A /org # set descr "Control policy for vNIC 1 and 2"
switch-A /org* # commit-buffer
switch-A /org #

Related Commands Command Description


show vcon
show vcon-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1127
Commands
set destination org

set destination org


To specify the organization for which the server is to be used, use the set destination org command.
used

set destination org destination

Syntax Description destination Organization name.

Command Default None

Command Modes Server automatic configuration policy (/org/server-autoconfig-policy)


Server inherit policy (/org/server-inherit-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the organization for which the server is to be used.

Examples This example shows how to specify the organization for which the server is to be used:
server-A# scope org /
server-A /org* # create server-autoconfig-policy AutoConfigFinance
server-A /org/server-autoconfig-policy* # set destination org finance
server-A /org/server-autoconfig-policy* # commit-buffer
server-A /org/server-autoconfig-policy #

Related Commands Command Description


show server-autoconfig-policy
show server-inherit-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1128 OL-25718-02
Commands
set dhcp-vendor-id

set dhcp-vendor-id
To set the DHCP vendor ID for an automatic target interface, use the set dhcp-vendor-id command.

set dhcp-vendor-id dhcp-vendor-id

Syntax Description dhcp-vendor-id ID of the DHCP vendor. The value can include a maximum of 32 characters
and can be alphanumeric.

Command Default None

Command Modes Automatic target interface (/org/service-profile/vnic-iscsi/eth-if/auto-target-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an automatic target interface for the Ethernet interface of the iSCSI VNIC before you use
this command.

Examples This example shows how to set the DHCP vendor ID for the configured automatic target interface of an iSCSI
VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope auto-target-if
UCS-A /org/service-profile/vnic-iscsi/eth-if/auto-target-if # set dhcp-vendor-id sample_id
UCS-A /org/service-profile/vnic-iscsi/eth-if/auto-target-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/auto-target-if #

Related Commands Command Description


create auto-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1129
Commands
set direct-cache-access-config access

set direct-cache-access-config access


To configure access to the direct cache, use the set direct-cache-access-config access command.

set direct-cache-access-config access {disabled| enabled| platform-default}

Syntax Description disabled Use this option to disable direct cache access.

enabled Use this option to enable direct cache access.

platform-default Use this option to set the platform default choice as the direct cache
access policy.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A BIOS policy must be configured to use this command.

Examples This example shows how to enable direct cache access.


Switch-A # scope org
Switch-A /org # scope bios-policy sample
Switch-A /org/bios-policy # set direct-cache-access-config access enabled
Switch-A /org/bios-policy* # commit-buffer
Switch-A /org/bios-policy #

Related Commands Command Description


create bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1130 OL-25718-02
Commands
set direction

set direction
To set the direction for the monitor source session, use the set direction command.

set direction {both| receive| transmit}

Syntax Description both Use this option to set the direction of the session to include both, receive and
transmit.

receive Use this option to set the direction to only receive.

transmit Use this option to set the direction to only transmit.

Command Default None

Command Modes Monitor source session within fabric interface in Fibre Channel uplink (/fc-uplink/fabric/interface/mon-src)
Monitor source session within the Fibre Channel over Ethernet interface within Fibre Channel storage
(/fc-storage/fabric/fcoe/mon-src)
Monitor source session within the fabric interface of Ethernet uplink (/eth-uplink/fabric/interface/mon-src)
Monitor source session within VHBA of a service profile (/org/service-profile/vhba/mon-src)
Monitor source session within VNIC of a service profile (/org/service-profile/vnic/mon-src)
Monitor source session within external Ethernet interface of the adapter
(/chassis/server/adapter/ext-eth-if/mon-src)
Monitor source session within the Fibre Channel mode of a fabric (/fc-storage/fabric/fc/mon-src)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A monitor source session must be created to use this command.

Examples This example shows how to set the direction of the monitor source session to receive and transmit.
Switch-A # scope org
Switch-A /org # scope service-profile sample
Switch-A /org/service-profile # scope vnic test
Switch-A /org/service-profile/vnic # scope mon-src example
Switch-A /org/service-profile/vnic/mon-src # set direction both
Switch-A /org/service-profile/vnic/mon-src* # commit-buffer
Switch-A /org/service-profile/vnic/mon-src #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1131
Commands
set direction

Related Commands Command Description


create mon-src

Cisco UCS Manager CLI Command Reference, Release 2.0


1132 OL-25718-02
Commands
set diskless

set diskless
To set storage method, use the set diskless command.

set diskless {no| unspecified| yes}

Syntax Description no Use this option to not set the diskless method for storage.

unspecified Use this option to not specify a method for storage.

yes Use this option to specify the diskless method of storage.

Command Default None

Command Modes Storage within Server pool policy qualification (/org/server-qual/storage)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A server pool policy qualification must be created to use this command.

Examples This example shows how to set the diskless storage for a server pool policy qualification.
Switch-A # scope org
Switch-A /org # scope server-qual sample
Switch-A /org/server-qual # scope storage
Switch-A /org/server-qual/storage # set diskless yes
Switch-A /org/server-qual/storage* # commit-buffer
Switch-A /org/server-qual/storage #

Related Commands Command Description


set blocksize
set maxcap
set mincap
set numberofblocks
set perdiskcap
set units

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1133
Commands
set disk-scrub

set disk-scrub
To specify whether the local disks are erased when the server is disassociated from a service profile, use the
set disk-scrub command.

set disk-scrub {no| yes}

Syntax Description no Disables disk scrub. The disk contents are preserved.

yes Enables disk scrub. The disk contents are erased.

Command Default Disk scrub is disabled.

Command Modes Scrub policy (/org/scrub-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command in a scrub policy to specify whether the local disk contents are erased or preserved when
the server is disassociated from a service profile. The action taken is as follows:
• If enabled, destroys all data on any local drives
• If disabled, preserves all data on any local drives, including local storage configuration

Examples This example shows how to set disk scrub:


switch-A# scope org org3
switch-A /org # scope scrub-policy scrub101
switch-A /org/scrub-policy # set disk-scrub yes
switch-A /org/scrub-policy* # commit-buffer
switch-A /org/scrub-policy #

Related Commands Command Description


show server-inherit-policy
show scrub-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1134 OL-25718-02
Commands
set dns-policy-ctrl

set dns-policy-ctrl
To set the control for the DNS policy, use the create dns-policy-ctrl command.

create dns-policy-ctrl source

Syntax Description source The source of the policy control. The source can be global or local.

Command Default By default, the source is set to local.

Command Modes Control endpoint policy (/system/control-ep policy)

Command History Release Modification


2.1(1) This command was introduced.

Usage Guidelines A control endpoint policy must be configured to use this command.

Examples This example shows how to set the control for the DNS policy to global.
UCS-A # scope system
UCS-A /system # scope control-ep policy
UCS-A /system/control-ep # set dns-policy-ctrl source global
UCS-A /system/control-ep* # commit-buffer
UCS-A /system/control-ep #

Related Commands Command Description


set backup-policy-ctrl

set communication-policy-ctrl

set datetime-policy-ctrl

set fault-policy-ctrl

set infra-pack-ctrl

set mep-policy-ctrl

set monitoring-policy-ctrl

set powermgmt-policy-ctrl

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1135
Commands
set dns-policy-ctrl

Command Description
set psu-policy-ctrl

set registry-ip

set security-policy-ctrl

Cisco UCS Manager CLI Command Reference, Release 2.0


1136 OL-25718-02
Commands
set dns

set dns
To specify a Domain Name Server (DNS) for a certificate request of a key ring, use the set dns command.

set dns subject alternative name

Syntax Description subject alternative name The Domain Name Server. The name can include a maximum of
255 characters.

Command Default None

Command Modes Certificate Request (/security/keyring/certreq)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines You should create a certificate request before setting the DNS details.

Examples The following example shows how to set the DNS details for a certificate request.
UCS-A # scope security
UCS-A /security # scope keyring test
UCS-A /security/keyring # create certreq
UCS-A /security/keyring/certreq* # set dns bgl-samc-15
UCS-A /security/keyring/certreq* # commit buffer
UCS-A /security/keyring/certreq #

Related Commands Command Description


set country

set e-mail

set ip

set locality

set org-name

set org-unit-name

set state

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1137
Commands
set dns

Command Description
set subject-name

Cisco UCS Manager CLI Command Reference, Release 2.0


1138 OL-25718-02
Commands
set domain-name

set domain-name
To specify a domain name, use the set domain-name command.

set domain-name domain-name

Syntax Description domain-name The name of the domain.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify a domain name. Enter up to 255 characters.

Examples This example shows how to specify a domain name:


switch-A# scope system
switch-A /system # scope services
switch-A /system/services # set domain-name example.com
switch-A /system/services* # commit-buffer
switch-A /system/services #

Related Commands Command Description


show domain-name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1139
Commands
set drop

set drop
To specify whether the channel can drop packets, use the set drop command.

set drop {drop| no-drop}

Syntax Description drop The channel can drop packets.

no-drop The channel cannot drop packets.

Command Default None

Command Modes Ethernet classified (/eth-server/qos/eth-classified)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify whether the channel can drop packets. By default, the channel cannot drop
packets.

Note Only one system class can use the no-drop option.

Examples This example shows how to specify that the QoS bronze class channel can drop packets:
switch-A# scope eth-server
switch-A /eth-server # scope qos
switch-A /eth-server/qos # scope eth-classified bronze
switch-A /eth-server/qos/eth-classified # set drop drop
switch-A /eth-server/qos/eth-classified* # commit-buffer
switch-A /eth-server/qos/eth-classified #

Related Commands Command Description


show eth-classified

Cisco UCS Manager CLI Command Reference, Release 2.0


1140 OL-25718-02
Commands
set dvs

set dvs
To specify which port profile a DVS is applied to, use the set dvs command.

set dvs folder-name

Syntax Description folder-name The name of the folder. The range of valid values is 1 to 16.

Command Default None

Command Modes Client (/system/vm-mgmt/vmware/profile-set/port-profile/client)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to specify which port profile a DVS is applied to:
switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope profile-set
switch-A /system/vm-mgmt/vmware/profile-set # scope port-profile
switch-A /system/vm-mgmt/vmware/profile-set/port-profile # scope client cl100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile/client # set dvs dvs100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile/client* # commit-buffer
switch-A /system/vm-mgmt/vmware/profile-set/port-profile/client #

Related Commands Command Description


show client
show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1141
Commands
set dynamic-eth

set dynamic-eth
To configure the number of dynamic vNICs, use the set dynamic-eth command.

set dynamic-eth {dynamic-eth| off}

Syntax Description dynamic-eth Specifies the number of dynamic vNICs. Enter a value from 0 to 88.

off Dynamic vNICs are not available.

Command Default 54 dynamic vNICs are available.

Command Modes Dynamic vNIC connectivity policy (/org/dynamic-vnic-conn-policy)


Hypervisor connection (/org/service-profile/hv-conn)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the number of dynamic vNICs.

Examples This example shows how to configure 30 dynamic vNICs:


switch-A# scope org org30a
switch-A /org/ # scope dynamic-vnic-conn-policy test30a
switch-A /org/dynamic-vnic-conn-policy # set dynamic-eth 30
switch-A /org/dynamic-vnic-conn-policy* # commit-buffer
switch-A /org/dynamic-vnic-conn-policy #

Related Commands Command Description


show dynamic-vnic-conn-policy
show hv-conn

Cisco UCS Manager CLI Command Reference, Release 2.0


1142 OL-25718-02
Commands
set email

set email
To configure a primary contact email address, use the set email command.

set email email

Syntax Description email Email address.

Command Default None

Command Modes Callhome (/monitoring/callhome)


Local user (/security/local-user)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure a primary contact email address to be included in Call Home messages. Specify
the email address in the format <name>@<domain name>.
If an email address includes special characters, such as # (hash), spaces, or & (ampersand), the email server
may not be able to deliver email messages to that address. Cisco recommends that you use email addresses
which comply with RFC2821 and RFC2822 and include only 7bit ASCII characters.

Examples This example shows how to configure a primary contact email address:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set email admin@example.com
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


show callhome
show event

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1143
Commands
set e-mail (/keyring)

set e-mail (/keyring)


To specify an email address for a certificate request of a key ring, use the set e-mail command.

set e-mail E-mail name

Syntax Description E-mail name The e-mail address associated with the certificate request.

Command Default None

Command Modes Certificate Request (/security/keyring/certreq)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines You should create a certificate request before specifying the email address.

Examples The following example shows how to set the e-mail address for a certificate request.
UCS-A # scope security
UCS-A /security # scope keyring test
UCS-A /security/keyring # create certreq
UCS-A /security/keyring/certreq* # set e-mail test@abc.com
UCS-A /security/keyring/certreq* # commit buffer
UCS-A /security/keyring/certreq #

Related Commands Command Description


set dns

set country

set ip

set locality

set org-name

set org-unit-name

set state

Cisco UCS Manager CLI Command Reference, Release 2.0


1144 OL-25718-02
Commands
set e-mail (/keyring)

Command Description
set subject-name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1145
Commands
set enforce-vnic-name

set enforce-vnic-name
To select whether the vNIC name is enforced, use the set enforce-vnic-name command.

set enforce-vnic-name {no| yes}

Syntax Description no The vNIC name is not enforced.

yes The vNIC name is enforced.

Command Default The vNIC name is not enforced.

Command Modes Boot policy (/org/boot-policy)


Boot definition (/org/service-profile/boot-def)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enforce the vNIC name:


switch-A# scope org org3
switch-A /org # scope boot-policy bp112
switch-A /org/boot-policy # set enforce-vnic-name yes
switch-A /org/boot-policy* # commit-buffer
switch-A /org/boot-policy #

Related Commands Command Description


show boot-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1146 OL-25718-02
Commands
set enhanced-intel-speedstep-config

set enhanced-intel-speedstep-config
To specify whether Enhanced Intel SpeedStep Technology is enabled, use the set
enhanced-intel-speedstep-config command.

set enhanced-intel-speedstep-config speed-step {disabled| enabled| platform-default}

Syntax Description disabled The processor never dynamically adjusts its voltage or frequency.

enabled The processor utilizes Enhanced Intel SpeedStep Technology and enables all
supported processor sleep states to further conserve power.

platform-default The BIOS uses the value for this attribute contained in the BIOS defaults for
the server type and vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to specify whether the processor uses Enhanced Intel SpeedStep Technology that allows
the system to dynamically adjust processor voltage and core frequency, which can result in decreased average
power consumption and decreased average heat production. Contact your operating system vendor to make
sure the operating system supports this feature.

Examples The following example shows how to create a BIOS policy specifying that Enhanced Intel SpeedStep
Technology is enabled:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set enhanced-intel-speedstep-config speed-step enabled
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1147
Commands
set error-recovery fcp-error-recovery

set error-recovery fcp-error-recovery


To enable or disable Fibre Channel Protocol (FCP) error recovery, use the set error-recovery
fcp-error-recovery command.

set error-recovery fcp-error-recovery {disabled| enabled}

Syntax Description disabled FCP error recovery is disabled.

enabled FCP error recovery is enabled.

Command Default Disabled

Command Modes Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enable or disable Fibre Channel Protocol (FCP) error recovery.

Examples This example shows how to enable FCP error recovery:


switch-A# scope org
switch-A /org # enter fc-policy FcPolicy19
switch-A /org/fc-policy # set error-recovery fcp-error-recovery enabled
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


show error-recovery

Cisco UCS Manager CLI Command Reference, Release 2.0


1148 OL-25718-02
Commands
set error-recovery link-down-timeout

set error-recovery link-down-timeout


To configure a link down timeout, use the set error-recovery link-down-timeout command.

set error-recovery link-down-timeout link-down-timeout

Syntax Description link-down-timeout The timeout in milliseconds (msec).

Command Default 30000 msec (30 seconds)

Command Modes Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure a link down timeout. Enter a value between 0 and 240000 msec.

Examples This example shows how to configure a link down timeout of 60 seconds:
switch-A# scope org
switch-A /org # enter fc-policy FcPolicy19
switch-A /org/fc-policy # set error-recovery link-down-timeout 60000
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


show error-recovery

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1149
Commands
set error-recovery port-down-io-retry-count

set error-recovery port-down-io-retry-count


To configure the number of port down I/O retries, use the set error-recovery port-down-io-retry-count
command.

set error-recovery port-down-io-retry-count port-down-io-retry-count

Syntax Description port-down-io-retry-count The number of retries.

Command Default The number of retries is 8.

Command Modes Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the number of port down I/O retries. Enter a value between 0 and 255.

Examples This example shows how to configure 100 port down I/O retries:
switch-A# scope org
switch-A /org # enter fc-policy FcPolicy19
switch-A /org/fc-policy # set error-recovery port-down-io-retry-count 100
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


show error-recovery

Cisco UCS Manager CLI Command Reference, Release 2.0


1150 OL-25718-02
Commands
set error-recovery port-down-timeout

set error-recovery port-down-timeout


To configure a port down timeout, use the set error-recovery port-down-timeout command.

set error-recovery port-down-timeout port-down-timeout

Syntax Description port-down-timeout The timeout in milliseconds (msec).

Command Default 30000 msec (30 seconds)

Command Modes Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure a port down timeout. Enter a value between 0 and 240000 msec.

Examples This example shows how to configure a port down timeout of 60 seconds:
switch-A# scope org
switch-A /org # enter fc-policy FcPolicy19
switch-A /org/fc-policy # set error-recovery port-down-timeout 60000
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


show error-recovery

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1151
Commands
set escalating

set escalating
To specify the class property threshold value for escalating an event, use the set escalating command.

set escalating value

Syntax Description value The property value at which the event will be escalated. See the Usage Guidelines
for the required format.

Command Default None

Command Modes Statistics class property threshold value (/org/stats-threshold-policy/class/property/threshold-value)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the class property threshold value for escalating an event. The format of the
value argument varies depending on the class property threshold value being configured. To see the required
format, enter the set escalating ? command.

Note You can specify both de-escalating and escalating class property threshold values.

Examples This example creates an above normal warning threshold of 50° C:


switch-A /org* # scope stats-threshold-policy ServStatsPolicy
switch-A /org/stats-threshold-policy* # create class cpu-stats
switch-A /org/stats-threshold-policy/class* # create property cpu-temp
switch-A /org/stats-threshold-policy/class/property* # set normal-value 48.5
switch-A /org/stats-threshold-policy/class/property* # create threshold-value above-normal
warning
switch-A /org/stats-threshold-policy/class/property/threshold-value* # set escalating 50.0
switch-A /org/stats-threshold-policy/class/property/threshold-value* # commit-buffer
switch-A /org/stats-threshold-policy/class/property/threshold-value #

Related Commands Command Description


set deescalating

Cisco UCS Manager CLI Command Reference, Release 2.0


1152 OL-25718-02
Commands
set execute-disable bit

set execute-disable bit


To set the execute disable bit for a BIOS policy, use the set execute-disable bit command.

set execute-disable bit {disabled| enabled| platform-default}

Syntax Description disabled Use this option to disable the bit for a BIOS policy.

enabled Use this option to enable the bit for a BIOS policy.

platform-default Use this option to set the platform default option for a bit of the BIOS
policy.

Command Default Platform default

Command Modes BIOS Policy (/org/bios-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A BIOS policy must be created to use this command.

Examples This example shows how to set the bit for a BIOS Policy to the platform default option.
Switch-A # scope org Test
Switch-A /org # scope bios-policy Sample
Switch-A /org/bios-policy # set execute-disable bit platform-default
Switch-A /org/bios-policy* # commit-buffer
Switch-A /org/bios-policy #

Related Commands Command Description


create bios-policy

create org

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1153
Commands
set expiration

set expiration
To set the expiration date, use the set expiration command.

set expiration {never| {apr| aug| dec| feb| jan| jul| jun| mar| may| nov| oct| sep} day year}

Syntax Description never Specifies

apr Specifies April.

aug Specifies August.

dec Specifies December.

feb Specifies February.

jan Specifies January.

jul Specifies July.

jun Specifies June.

mar Specifies March.

may Specifies May.

nov Specifies November.

oct Specifies October.

sep Specifies September.

day Day.

year Year.

Command Default None

Command Modes Local user (/security/local-user)

Command History Release Modification


1.0(1) This command was introduced.

Cisco UCS Manager CLI Command Reference, Release 2.0


1154 OL-25718-02
Commands
set expiration

Usage Guidelines Use this command to set the date the user account expires.

Examples This example shows how to set the expiration date:

switch-A#scope security

switch-A /security # scope local-user lu1

switch-A /security/local-user # set expiration 30 nov

switch-A /security* # commit-buffer

switch-A /security #

Related Commands Command Description


show local-user
show remote-user

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1155
Commands
set expire-warn-interval

set expire-warn-interval
To set a password expiration warning interval, use the set expire-warn-interval command.

set expire-warn-interval password expiration warning interval

Syntax Description password expiration warning interval The password expiration warning interval in days. The value is
a numeral between 0 and 30.

Command Default None

Command Modes Password Profile (/security/password-profile)

Command History Release Modification


2.0 This command has been introduced.

Usage Guidelines None

Examples This example shows how to set the password expiration warning interval to 25 days.
UCS-A # scope security
UCS-A /security # scope password-profile
UCS-A /security/password-profile # set expire-warn-interval 25
UCS-A /security/password-profile* # commit-buffer
UCS-A /security/password-profile #

Related Commands Command Description


set change-count
set change-during-interval
set change-interval

set history-count

set no-change-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


1156 OL-25718-02
Commands
set ext-mgmt-ip-state

set ext-mgmt-ip-state
To set an external management IP address state for a service profile, use the set ext-mgmt-ip-state command.

set ext-mgmt-ip-state {none| pooled| static}

Syntax Description none This option does not set an external management IP state for the service profile.

pooled This option sets an external management pooled IP address state for the service
profile.

static This option sets an external management static IP address state for the service
profile.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A service profile must be created to use this command.

Examples This example shows how to set the external management IP address state as pooled for a service profile.
Switch-A # scope org
Switch-A /org # scope service-profile default
Switch-A /org/service-profile # set ext-mgmt-ip-state pooled
Switch-A /org/service-profile* # commit-buffer
Switch-A /org/service-profile #

Related Commands Command Description


create service-profile
scope ext-pooled-ip
scope ext-static-ip

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1157
Commands
set fabric

set fabric
To specify the fabric connection for a vHBA or vNIC template, use the set fabric command.

set fabric {a| a-b| b| b-a}

Syntax Description a Specifies fabric A.

a-b Specifies redundant operation with fabric A as primary.

b Specifies fabric A.

b-a Specifies redundant operation with fabric B as primary.

Command Default The interface connects to Fabric A.

Command Modes Virtual HBA template (/org/vhba-templ)


Virtual NIC template (/org/vnic-templ)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the fabric connection for a vHBA (virtual host bus adapter) or vNIC (virtual
network interface card) template. The redundant options are available only for vNICs.

Examples This example shows how to specify a fabric B connection for a vNIC template.
switch-A# scope org org10
switch-A /org # scope vnic-templ sp10
switch-A /org/vnic-templ # set fabric b
switch-A /org/vnic-templ* # commit-buffer
switch-A /org/vnic-templ #

Related Commands Command Description


show vhba-templ
show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


1158 OL-25718-02
Commands
set failover timeout

set failover timeout


To configure the availability time before the system resumes use of a recovered primary interface, use the
set failover timeout command.

set failover timeout timeout

Syntax Description timeout Number of seconds that the recovered interface must be available before it can
be used.

Command Default The failover timeout is 5 seconds.

Command Modes Ethernet adapter policy (/org/eth-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines After the primary interface of a vNIC has recovered from a failure, the system waits the duration of the failover
timeout before switching back from the secondary interface to the primary interface. Use this command to
set the failover timeout, specifying how long the primary interface must be available before the system resumes
using the primary interface. Enter a number of seconds between 0 and 600.

Examples This example shows how to configure a 60 second failover timeout for an Ethernet policy:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set failover timeout 60
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


show eth-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1159
Commands
set fc-if name

set fc-if name


To configure a name for the Fibre Channel interface, use the set fc-if name command.

set fc-if name name

Syntax Description name Interface name. The name can contain up to 32 characters.

Command Default None

Command Modes Virtual HBA (/org/service-profile/vhba)


Virtual HBA template (/org/vhba-templ)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure a name for the Fibre Channel interface in a vHBA (virtual host bus adapter).

Examples This example shows how to configure a name for the Fibre Channel interface in a vHBA template:
switch-A# scope org org10
switch-A /org # scope vhba-templ sp10
switch-A /org/vhba-templ # set fc-if name if10
switch-A /org/vhba-templ* # commit-buffer
switch-A /org/vhba-templ #

Related Commands Command Description


show vhba-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


1160 OL-25718-02
Commands
set fcoe-vlan

set fcoe-vlan
To enable FCoE for the specified VLAN, use the set fcoe-vlan command.

set fcoe-vlan {fcoe-vlan| default}

Syntax Description fcoe-vlan Specifies the VLAN number for enabling FCoE.

default FCoE is enabled on the default VLAN.

Command Default FCoE is enabled on the default VLAN.

Command Modes VSAN (/fc-uplink/vsan)


VSAN (/fc-uplink/fabric/vsan)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) The range of valid values was modified from 4048 - 4093 to 4049 - 4093.

Usage Guidelines Use this command to enable Fibre Channel over Ethernet (FCoE) for the specified VLAN or the default
VLAN. Valid ranges for the VLAN are 1 to 3967 and 4049 to 4093.

Examples This example enables FCoE for VLAN 1000:


switch-A# scope fc-uplink fc1000
switch-A /fc-uplink # scope vsan vsTest 1000 1000
switch-A /fc-uplink/vsan # set fcoe-vlan 1000
switch-A /fc-uplink/vsan* # commit-buffer
switch-A /fc-uplink/vsan #

Related Commands Command Description


show vsan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1161
Commands
set fcoe-storage-native-vlan

set fcoe-storage-native-vlan
To set a native VLAN identification number for the Fibre Channel storage device, use the set
fcoe-storage-native-vlan command.

set fcoe-storage-native-vlan fcoe-storage-native-vlan id

Syntax Description fcoe-storage-native-vlan id The unique identifier assigned to the VLAN used for Fibre Channel
connections. Valid ranges for the VLAN are 1 to 3967 and 4048 to 4093.

Command Default None

Command Modes Fibre Channel Storage (/fc-storage)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines FCoE VLANs in the SAN cloud and VLANs in the LAN cloud must have different IDs. Using the same ID
for an FCoE VLAN and a VLAN results in a critical fault and traffic disruption for all vNICs and uplink ports
using that FCoE VLAN.

Examples This example shows how to set a native VLAN identification number for the Fibre Channel storage device.
Switch-A # scope fc-storage
Switch-A /fc-storage # set fcoe-storage-native-vlan 44
Switch-A /fc-storage* # commit-buffer
Switch-A /fc-storage #

Related Commands Command Description


show

Cisco UCS Manager CLI Command Reference, Release 2.0


1162 OL-25718-02
Commands
set file size

set file size


To specify the size limit of the management logging file, use the set file size command.

set file size size

Syntax Description size Specifies the file size limit. The range is 1000000 (1M) to 10000000 (10M) bytes; the
default is 5242880 bytes.

Command Default The file size limit is 5242880 bytes.

Command Modes Management logging (/monitoring/sysdebug/mgmt-logging)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the size limit of the management logging file.

Examples This example shows how to specify the size limit of the management logging file:
switch-A# scope monitoring
switch-A /monitoring # scope sysdebug
switch-A /monitoring/sysdebug # scope mgmt-logging
switch-A /monitoring/sysdebug/mgmt-logging # set file size 10000000
switch-A /monitoring/sysdebug/mgmt-logging* # commit-buffer
switch-A /monitoring/sysdebug/mgmt-logging #

Related Commands Command Description


show (mgmt-logging)

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1163
Commands
set filter

set filter
To set up a filter, use the set filter command.

set filter name

Syntax Description name Filter name. The range of valid values is 1 to 63.

Command Default None

Command Modes LDAP (/security/ldap)


LDAP Server (/security/ldap/server)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was introduced in the LDAP server command mode
(/security/ldap/server).

Usage Guidelines Use this command to restrict database searches to records that contain the specified filter.

Examples This example shows how to set up a filter:

switch-A#scope security

switch-A /security # scope ldap

switch-A /security/ldap # set filter domainNames

switch-A /security/ldap* # commit-buffer

switch-A /security/ldap #

Related Commands Command Description


show ldap
show tacacs

Cisco UCS Manager CLI Command Reference, Release 2.0


1164 OL-25718-02
Commands
set firstname

set firstname
To set the first name, use the set firstname command.

set firstname name

Syntax Description name First name. The range of valid values is 1 to 16.

Command Default None

Command Modes Local user (/security/local-user)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the first name:

switch-A#scope security

switch-A /security # scope local-user lu1

switch-A /security/local-user # set firstname bob

switch-A /security/local-user* # commit-buffer

switch-A /security/local-user #

Related Commands Command Description


show local-user
show remote-user

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1165
Commands
set flap-interval

set flap-interval
To configure the length of time the system waits before changing a fault state, use the set flap-interval
command.

set flap-interval seconds

Syntax Description seconds Specifies the interval during which the fault state is not allowed to change again after
a state change. The range is 5 to 3600 seconds; the default is 10 seconds.

Command Default None

Command Modes Fault-policy (/monitoring/fault-policy)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Flapping occurs when a fault is raised and cleared several times in rapid succession. To prevent flapping, use
the set flap-interval command to freeze the fault state until the flapping interval has elapsed after the last
state change. If the fault is raised again during the flapping interval, it returns to the active state; otherwise,
the fault is cleared.

Examples This example shows how to configure the fault state flap interval to 10 seconds:
switch-A# scope monitoring
switch-A /monitoring # scope fault policy
switch-A /monitoring/fault-policy* # set flap-interval 10
switch-A /monitoring/fault-policy* # commit-buffer
switch-A /monitoring/fault-policy #

Related Commands Command Description


show fault policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1166 OL-25718-02
Commands
set flow-control-policy

set flow-control-policy
To set up a flow control policy, use the set flow-control-policy command.

set flow-control-policy name

Syntax Description name Flow control policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Port channel (/eth-uplink/fabric/port-channel)


Interface (/eth-uplink/fabric/interface)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set up a flow control policy:

switch-A# scope eth-uplink

switch-A /eth-uplink # scope fabric b

switch-A /eth-uplink/fabric # scope interface 1 2

switch-A /eth-uplink/fabric/interface # set flow-control-policy fcp110

switch-A /eth-uplink/fabric/interface* # commit-buffer

switch-A /eth-uplink/fabric/interface #

Related Commands Command Description


show interface
show port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1167
Commands
set folder

set folder
To set up a folder, use the set folder command.

set folder folder-name

Syntax Description folder-name The name of the folder. The range of valid values is 1 to 16.

Command Default None

Command Modes Pending deletion (/system/vm-mgmt/vmware/pending-deletion)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use data-center mode to perform the following tasks:


• Create and delete folders
• Show folder information

Examples This example shows how to enter data-center mode:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc1
switch-A /system/vm-mgmt/vmware/vcenter # scope data-center dc1
switch-A /system/vm-mgmt/vmware/vcenter/data-center #

Related Commands Command Description


show data-center
show vcenter

Cisco UCS Manager CLI Command Reference, Release 2.0


1168 OL-25718-02
Commands
set folder (/client)

set folder (/client)


To set a folder for a client within a port profile, use the set folder command.

set folder folder

Syntax Description folder Name of the folder. The name can include a maximum of 256 alphanumeric
characters.

Command Default None

Command Modes Client within a port profile (/system/vm-mgmt/profile-set/port-profile/client)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a client within a port profile before you use this command.

Examples This example shows how to set a folder for a client within the port profile command mode:
UCS-A # scope system
UCS-A /system # scope vm-mgmt
UCS-A /system/vm-mgmt # scope profile-set
UCS-A /system/vm-mgmt/profile-set # scope port-profile test
UCS-A /system/vm-mgmt/profile-set/port-profile # scope client sample
UCS-A /system/vm-mgmt/profile-set/port-profile/client # set folder Trial123
UCS-A /system/vm-mgmt/profile-set/port-profile/client* # commit-buffer
UCS-A /system/vm-mgmt/profile-set/port-profile/client #

Related Commands Command Description


set cluster

set data-center (/client)

set descr

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1169
Commands
set forged-transmit

set forged-transmit
To allow or disallow the forging of MAC addresses, use the set forged-transmit command.

set forged-transmit {allow| deny}

Syntax Description allow Specifies that the server is allowed to forge MAC addresses.

deny Specifies that the server is not allowed to forge MAC addresses.

Command Default Forged transmit is allowed.

Command Modes MAC security (org/nw-ctrl-policy/mac-security)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to allow or disallow the forging of MAC addresses by the server when sending frames.
When port security is enabled in the network, MAC address forging should be disabled for the vNICs. You
can include the set forged-transmit command in a network control policy and then apply the policy in a
vNIC service profile.

Examples This example shows how to create a network control policy that disables the forging of MAC addresses:
switch-A# scope org
switch-A /org # create nw-ctrl-policy testPolicy
switch-A /org/nw-ctrl-policy* # create mac-security
switch-A /org/nw-ctrl-policy/mac-security* # set forged-transmit deny
switch-A /org/nw-ctrl-policy/mac-security* # commit-buffer
switch-A /org/nw-ctrl-policy/mac-security #

Related Commands Command Description


show mac-security

show nw-ctrl-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1170 OL-25718-02
Commands
set format

set format
To configure the format of Call Home messages, use the set format command.

set format {fulltxt| shorttxt| xml}

Syntax Description fulltxt Specifies the long text format.

shorttxt Specifies the short text format.

xml Specifies the XML format. This is


the default format.

Command Default Messages are sent in XML format.

Command Modes Profile (/monitoring/callhome/profile)

Command History Release Modification


1.0(2) This command was introduced.

1.1(1) This command was modified to add the fulltxt keyword.

Usage Guidelines Use this command to configure the data format of Call Home messages. The following format options are
available:
• Full text— Provides a fully formatted message with detailed information that is suitable for human
reading.
• Short text—Provides a one or two line description of the fault that is suitable for printed reports or for
communication with mobile devices.
• XML— Provides the Adaptive Messaging Language (AML) XML data structure required for
communication with the Cisco Technical Assistance Center. The AML XML schema definition (XSD)
is published on the Cisco website. XML is the default format.

Examples This example shows how to configure Call Home messages for XML format:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # enter profile TestProfile
switch-A /monitoring/callhome/profile* # set format xml
switch-A /monitoring/callhome/profile* # commit-buffer
switch-A /monitoring/callhome/profile #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1171
Commands
set format

Related Commands Command Description


show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


1172 OL-25718-02
Commands
set from-email

set from-email
To configure an email address that will appear in the From field in Call Home email messages, use the set
from-email command.

set from-email from-email

Syntax Description from-email Email address.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to configure an email address that will appear in the From field in Call Home email
messages. Specify the email address in the format <name>@<domain name>. If no address is specified, the
contact email address is used.

Examples This example shows how to configure a From email address:


switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set from-email admin@example.com
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1173
Commands
set front-panel-lockout-config

set front-panel-lockout-config
To specify whether the power and reset buttons on the front panel are ignored by the server, use the set
front-panel-lockout-config command.

set front-panel-lockout-config front-panel-lockout {disabled| enabled| platform-default}

Syntax Description disabled The power and reset buttons on the front panel are active and can be used to
affect the server.

enabled The power and reset buttons are locked out. The server can only be reset or
powered on or off from the CIMC GUI.

platform-default The BIOS uses the value for this attribute contained in the BIOS defaults for
the server type and vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to specify whether the power and reset buttons on the front panel are ignored by the server.

Examples The following example shows how to create a BIOS policy specifying that the power and reset buttons on the
front panel are ignored by the server:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set front-panel-lockout-config front-panel-lockout enabled
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1174 OL-25718-02
Commands
set history-count

set history-count
To determine if users can use previously set passwords or not, use the set history-count command.

set history-count password history count

Syntax Description password history count Specifies the password history count. The value must be between 0
and 15.

Command Default By default, the password history check is disabled.

Command Modes Password profile (/security/password-profile)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must be an administrator to use this command.


Setting a value of 0 disables the password history checking feature.

Examples This example shows how to set the history count for the password to 15:
UCS-A # scope security
UCS-A /security # scope password-profile
UCS-A /security/password-profile # set history-count 15
UCS-A /security/password-profile* # commit-buffer
UCS-A /security/password-profile #

Related Commands Command Description


set change-count

set change-during-interval

set change-interval

set no-change-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1175
Commands
set host

set host
To set up a host, use the set host command.

set host host-name

Syntax Description host-name The name of the host. The range of valid values is 1 to 16.

Command Default None

Command Modes Pending deletion (/system/vm-mgmt/vmware/pending-deletion)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use data-center mode to perform the following tasks:


• Create and delete folders
• Show folder information

Examples This example shows how to enter data-center mode:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc1
switch-A /system/vm-mgmt/vmware/vcenter # scope data-center dc1
switch-A /system/vm-mgmt/vmware/vcenter/data-center #

Related Commands Command Description


show data-center
show vcenter

Cisco UCS Manager CLI Command Reference, Release 2.0


1176 OL-25718-02
Commands
set host-cos-control

set host-cos-control
To set the CoS control for a host, use the set host-cos-control command.

set host-cos-control{full| none}

Syntax Description full To set the CoS control to full for a host.

none To not set the CoS control for a host.

Command Default None

Command Modes Egress Policy (/org/qos-policy/egress-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A QoS policy must be created to use this command.

Examples This example shows how to set the CoS control to Full for a host.
Switch-A # scope org Test
Switch-A /org # scope qos-policy sample
Switch-A /org/qos-policy # scope egress-policy
Switch-A /org/qos-policy/egress-policy # set host-cos-control full
Switch-A /org/qos-policy/egress-policy* # commit-buffer
Switch-A /org/qos-policy/egress-policy #

Related Commands Command Description


show egress-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1177
Commands
set host-fw-policy

set host-fw-policy
To set the host firmware policy, use the set host-fw-policy command.

set host-fw-policy name

Syntax Description name Host firmware policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to associate the specified host firmware policy with the service profile you used to enter
service profile mode.

Examples This example shows how to set the host firmware policy:

switch-A# scope org org10

switch-A /org # scope service-profile servProf10

switch-A /org/service-profile # set host-fw-policy hostFP10

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show assoc
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


1178 OL-25718-02
Commands
set host-nwio-perf

set host-nwio-perf
To set the host net IO performance for a port-profile, use the set host-nwio-perf command.

set host-nwio-perf {high-performance| none}

Syntax Description high-performance To set the host net IO performance to high performance.

none To not set a performance limit for the host net IO.

Command Default None

Command Modes Port profile (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A port profile must be created to use this command.

Examples This example shows how to set the host net IO performance to high performance.
Switch-A # scope system
Switch-A /system # scope vm-mgmt
Switch-A /system/vm-mgmt # scope vmware
Switch-A /system/vm-mgmt/vmware # scope profile-set
Switch-A /system/vm-mgmt/vmware/profile-set # scope port-profile sample
Switch-A /system/vm-mgmt/vmware/profile-set/port-profile # set host-nwio-perf high-performance
Switch-A /system/vm-mgmt/vmware/profile-set/port-profile* # commit-buffer
Switch-A /system/vm-mgmt/vmware/profile-set/port-profile #

Related Commands Command Description


create port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1179
Commands
set hostname

set hostname
To set the server hostname, use the set hostname command.

set hostname host-name

Syntax Description host-name The host name fo the server.

Command Default None

Command Modes Callhome (/monitoring/callhome)


VCenter (/system/vm-mgmt/vmware/vcenter)

Command History Release Modification


1.0(2) This command was introduced for callhome mode.

1.1(1) This command was introduced for vcenter mode.

Usage Guidelines For callhome mode, the fully qualified domain name or IP address of the SMTP server. For vcenter mode,
the hostname or IP address of the VCenter server. Enter an IP address using the format X.X.X.X, or a host
name of up to 512 characters.

Examples This example shows how to set the SMTP server host name:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set hostname smtp.example.com
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


set port

show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


1180 OL-25718-02
Commands
set hostname

set hostname
To create a host name, use the set hostname command in server mode.

set hostname host-name

Syntax Description host-name The name of the server. The name can be a name or an IP address. The range of
valid values for a name is 1 to 255. The format for an IP address is N.N.N.N.

Command Default None

Command Modes VCenter (/system/vm-mgmt/vmware/vcenter)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to create a host name for the VCenter:
switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter marComm
switch-A /system/vm-mgmt/vmware/vcenter # set hostname marComm10
switch-A /system/vm-mgmt/vmware/vcenter* # commit-buffer
switch-A /system/vm-mgmt/vmware/vcenter #

Related Commands Command Description


show data-center
show vcenter

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1181
Commands
set hour

set hour
To set an hour for the periodic maintenance window, use the set hour command.

set hour {hour| every-hour}

Syntax Description hour Use this option to specify a specific hour at which this maintenance window must
run. The value must be between 0 - 24.

every-hour Use this option to configure the maintenance window to run every hour.

Command Default None

Command Modes Periodic maintenance window (/system/scheduler/periodic)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A scheduler policy and a periodic maintenance window must be created to use this command.

Examples This example shows how to set the hour for a periodic maintenance window.
Switch-A # scope system
Switch-A /system # scope scheduler default
Switch-A /system/scheduler # scope maint-window periodic Trial
Switch-A /system/scheduler/periodic # set hour every-hour
Switch-A /system/scheduler/periodic* # commit-buffer
Switch-A /system/scheduler/periodic #

Related Commands Command Description


set date
set concur-jobs
set max-duration
set min-interval
set minute

Cisco UCS Manager CLI Command Reference, Release 2.0


1182 OL-25718-02
Commands
set http port

set http port


To set up an HTTP port, use the set http port command.

set http port port

Syntax Description port Port identification number. The range of valid values is 1 to 65535.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Cisco recommends that you enable only the communication services that are required to interface with other
network applications.

Examples This example shows how to set up an HTTP port:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # set http port 100

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show cimxml
show http

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1183
Commands
set https cipher-suite-mode

set https cipher-suite-mode


To set the level of Cipher Suite security used by the Cisco UCS domain, use the set https cipher-suite-mode
command.

set https cipher-suite-mode {high-strength | medium-strength | low -strength | custom}

Syntax Description high-strength To set the level of Cipher Suite security to high-strength.

medium-strength To set the level of Cipher Suite security to medium-strength.

low -strength To set the level of Cipher Suite security to low-strength.

custom Allows you to specify a user-defined Cipher Suite specification.

Command Default By default, the option is to medium-strength.

Command Modes Services (/system/services)

Command History Release Modification


2.0(3) This command was introduced.

Usage Guidelines None

Examples This example shows how to enable HTTPS, set the port number to 443, set the key ring name to kring7984,
and set the Cipher Suite security level to high.
UCS-A # scope system
UCS-A /system # scope services
UCS-A /system/services # enable https
UCS-A /system/services* # set https port 443
Warning: When committed, this closes all the web sessions.
UCS-A /system/services* # set https keyring kring7984
UCS-A /system/services* # set https cipher-suite-mode high
UCS-A /system/services* # commit-buffer
UCS-A /system/services #

Related Commands Command Description


set https cipher-suite

Cisco UCS Manager CLI Command Reference, Release 2.0


1184 OL-25718-02
Commands
set https cipher-suite

set https cipher-suite


To set a custom level of Cipher Suite security for this Cisco UCS domain, use the set https cipher-suite
command.

set https cipher-suite cipher-suite-spec-string

Syntax Description cipher-suite-spec-string The customized Cipher suite string can contain up to 256 characters and
must conform to the OpenSSL Cipher Suite specifications.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


2.0(3) This command was introduced.

Usage Guidelines You cannot use any spaces or special characters except ! (exclamation point), + (plus sign), - (hyphen), and
: (colon) in the customized Cipher suite string.

Examples The following example shows how to specify a customized Cipher suite string.
UCS-A # scope system
UCS-A /system # scope services
UCS-A /system/services # enable https
UCS-A /system/services* # set https port 43
Warning: when committed, this closes all web sessions
UCS-A /system/services* # set https keyring kring789
UCS-A /system/services* # set https cipher-suite-mode custom
UCS-A /system/services* # set https cipher-suite
ALL:!ADH:!EXPORT56:!LOW:RC4+RSA:+CUSTOM:+EXP:+eNULL
UCS-A /system/services* # commit-buffer
UCS-A /system/services #

Related Commands Command Description


set https cipher-suite-mode

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1185
Commands
set https keyring

set https keyring


To set up an HTTPS keyring, use the set https keyring command.

set https keyring keyring

Syntax Description keyring Keyring name. The range of valid values is 1 to 16.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines When the HTTPS keyring is modified using the set https keyring command, all current HTTP and HTTPS
sessions will be closed without any warning.

Examples This example shows how to set up an HTTPS keyring:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # set https keyring kr100

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show http
show keyring

Cisco UCS Manager CLI Command Reference, Release 2.0


1186 OL-25718-02
Commands
set https port

set https port


To set up an HTTPS port, use the set https port command.

set https port port

Syntax Description port Port identification number. The range of valid values is 1 to 65535.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Cisco recommends that you enable only the communication services that are required to interface with other
network applications.

Examples This example shows how to set up an HTTP port:

switch-A#scope system

switch-A /system # scope services

switch-A /system/services # set https port 200

switch-A /system/services* # commit-buffer

switch-A /system/services #

Related Commands Command Description


show cimxml
show http

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1187
Commands
set hyper-threading-config

set hyper-threading-config
To specify whether Intel Hyper-Threading Technology is enabled, use the set hyper-threading-config
command.

set hyper-threading-config hyper-threading {disabled| enabled| platform-default}

Syntax Description disabled The processor does not permit the parallel execution of multiple threads.

enabled The processor allows the parallel execution of multiple threads.

platform-default The BIOS uses the value for this attribute contained in the BIOS defaults
for the server type and vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to specify whether the processor uses Intel Hyper-Threading Technology, which allows
multithreaded software applications to execute threads in parallel within each processor. Contact your operating
system vendor to make sure the operating system supports this feature.

Examples The following example shows how to create a BIOS policy specifying that Intel Hyper-Threading Technology
is enabled:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set hyper-threading-config hyper-threading enabled
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1188 OL-25718-02
Commands
set id

set id
To set an ID for a VSAN, use the set id command.

set id id

Syntax Description ID The ID for the VSAN. The range of valid values is 1 to 4093.

Command Default None

Command Modes VSAN (fc-storage/fabric/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A VSAN must be created to use this command.

Examples This example shows how to add an ID for a VSAN.


Switch-A # scope fc-storage
Switch-A /fc-storage # scope fabric a
Switch-A /fc-storage/fabric # scope vsan Test
Switch-A /fc-storage/fabric/vsan # set id 22
Switch-A /fc-storage/fabric/vsan * # commit-buffer
Switch-A /fc-storage/fabric/vsan #

Related Commands Command Description


create vsan

show vsan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1189
Commands
set identity dynamic-mac

set identity dynamic-mac


To configure a dynamic MAC address for a vNIC, use the set identity dynamic-mac command.

set identity dynamic-mac {dynamic-mac| derived}

Syntax Description dynamic-mac Specifies a unique MAC address in the form nn:nn:nn:nn:nn:nn.

derived Derive the MAC address from a pool, if available, or from a MAC address
burned into the hardware at manufacture.

Command Default The MAC address is derived.

Command Modes Virtual NIC (/org/service-profile/vnic)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to configure a dynamic MAC address for a virtual NIC (vNIC).
To specify a pool of MAC addresses for dynamic assignment, use the set identity mac-pool command.

Examples This example shows how to specify a dynamic MAC address for a vNIC:
server-A# scope org /
server-A /org # scope service-profile ServInst90
server-A /org/service-profile # scope vnic dynamic-prot-001
server-A /org/service-profile/vnic # set identity dynamic-mac 01:23:45:67:89:ab
server-A /org/service-profile/vnic* # commit-buffer
server-A /org/service-profile/vnic #

Related Commands Command Description


set identity mac-pool
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


1190 OL-25718-02
Commands
set identity dynamic-uuid

set identity dynamic-uuid


To configure how the server acquires a dynamic UUID, use the set identity dynamic-uuid command.

set identity dynamic-uuid {dynamic-uuid| derived}

Syntax Description dynamic-uuid Specifies a unique UUID in the form nnnnnnnn-nnnn-nnnn-nnnnnnnnnnnn.

derived Derive the UUID from a pool, if available, or from the UUID burned into the
hardware at manufacture.

Command Default The dynamic UUID is derived.

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to configure how the server acquires a dynamic universally unique identifier (UUID) in a
service profile.
To specify a pool of UUID suffixes for dynamic assignment, use the set identity uuid-suffix-pool command.

Examples This example shows how to specify a dynamic UUID for a service profile:
server-A# scope org /
server-A /org # scope service-profile ServInst90
server-A /org/service-profile # set identity dynamic-uuid 01234567-89ab-cdef-0123-456789abcdef
server-A /org/service-profile* # commit-buffer
server-A /org/service-profile #

Related Commands Command Description


set identity uuid-suffix-pool
show service-profile identity

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1191
Commands
set identity dynamic-wwnn

set identity dynamic-wwnn


To configure how the server acquires a dynamic WWNN, use the set identity dynamic-wwnn command.

set identity dynamic-wwnn {dynamic-wwnn| derived}

Syntax Description dynamic-wwnn Create a unique WWNN in the form hh:hh:hh:hh:hh:hh:hh:hh.

derived Derive the WWNN from a pool, if available, or from a WWNN burned into
the hardware at manufacture.

Command Default The dynamic WWNN is derived.

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to configure how the server acquires a dynamic world wide node name (WWNN) for
vHBAs in a service profile.
To specify a pool of WWN names for dynamic assignment, use the set identity wwnn-pool command.

Examples The following example shows how to configure a dynamic WWNN for vHBAs in a service profile
server-A# scope org /
server-A /org # scope service-profile ServInst90
server-A /org/service-profile # set identity dynamic-wwnn 01:23:45:67:89:ab:cd:ef
server-A /org/service-profile* # commit-buffer
server-A /org/service-profile #

Related Commands Command Description


set identity wwnn-pool
show service-profile identity

Cisco UCS Manager CLI Command Reference, Release 2.0


1192 OL-25718-02
Commands
set identity dynamic-wwpn

set identity dynamic-wwpn


To configure how the server acquires a dynamic WWPN, use the set identity dynamic-wwpn command.

set identity dynamic-wwpn {dynamic-wwpn| derived}

Syntax Description dynamic-wwpn Create a unique WWPN in the form hh:hh:hh:hh:hh:hh:hh:hh.

derived Derive the WWPN from a WWPN pool, if available, or from a WWPN burned
into the hardware at manufacture.

Command Default The dynamic WWPN is derived.

Command Modes Virtual HBA (/org/service-profile/vhba)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to configure how the server acquires a dynamic world wide port name (WWPN) for a
vHBA in a service profile.
To specify a pool of WWPNs for dynamic assignment, use the set identity wwpn-pool command.

Examples This example shows how to configure a dynamic WWPN for a vHBA in a service profile:
server-A# scope org /
server-A /org # scope service-profile ServInst90
server-A /org/service-profile # scope vhba vhba3
server-A /org/service-profile/vhba # set identity dynamic-wwpn 01:23:45:67:89:ab:cd:ef
server-A /org/service-profile/vhba* # commit-buffer
server-A /org/service-profile/vhba #

Related Commands Command Description


set identity wwpn-pool
show vhba

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1193
Commands
set identity mac-pool

set identity mac-pool


To specify a pool of MAC addresses for dynamic assignment, use the set identity mac-pool command.

set identity mac-pool mac-pool

Syntax Description mac-pool Name of a MAC address pool.

Command Default None

Command Modes Virtual NIC (/org/service-profile/vnic)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify an existing pool of MAC addresses for dynamic assignment to a vNIC in a
service profile.

Examples This example shows how to specify a dynamic MAC address pool for a vNIC in a service profile:
server-A# scope org /
server-A /org # scope service-profile ServInst90
server-A /org/service-profile # scope vnic dynamic-prot-001
server-A /org/service-profile/vnic # set identity mac-pool MyMacPool3
server-A /org/service-profile/vnic* # commit-buffer
server-A /org/service-profile/vnic #

Related Commands Command Description


create mac-pool
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


1194 OL-25718-02
Commands
set identity uuid-suffix-pool

set identity uuid-suffix-pool


To specify a pool of UUID suffixes for dynamic assignment, use the set identity uuid-suffix-pool command.

set identity uuid-suffix-pool uuid-suffix-pool

Syntax Description uuid-suffix-pool Name of a UUID suffix pool.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify an existing pool of universally unique identifier (UUID) suffixes for dynamic
assignment to vHBAs in a service profile.

Examples This example shows how to specify a UUID suffix pool for a service profile:
server-A# scope org /
server-A /org # scope service-profile ServInst90
server-A /org/service-profile # set identity uuid-suffix-pool MyUuidPool3
server-A /org/service-profile* # commit-buffer
server-A /org/service-profile #

Related Commands Command Description


create uuid-suffix-pool
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1195
Commands
set identity wwnn-pool

set identity wwnn-pool


To specify a pool of WWN names for dynamic assignment, use the set identity wwnn-pool command.

set identity wwnn-pool wwnn-pool

Syntax Description wwnn-pool Name of a WWNN pool.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify an existing pool of world wide node names (WWNN) for dynamic assignment
to vHBAs in a service profile.

Examples This example shows how to specify a WWNN pool for a service profile:
server-A# scope org /
server-A /org # scope service-profile ServInst90
server-A /org/service-profile # set identity wwnn-pool MyWwnnPool3
server-A /org/service-profile* # commit-buffer
server-A /org/service-profile #

Related Commands Command Description


create wwn-pool
show service-profile identity

Cisco UCS Manager CLI Command Reference, Release 2.0


1196 OL-25718-02
Commands
set identity wwpn-pool

set identity wwpn-pool


To specify a pool of world wide port names (WWPN) for dynamic assignment, use the set identity wwpn-pool
command.

set identity wwpn-pool wwpn-pool

Syntax Description wwpn-pool Name of a WWPN pool.

Command Default None

Command Modes Virtual HBA (/org/service-profile/vhba)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify an existing pool of world wide port names (WWPN) for dynamic assignment
to a vHBA in a service profile.

Examples This example shows how to specify a dynamic WWPN pool for a vHBA in a service profile:
server-A# scope org /
server-A /org # scope service-profile ServInst90
server-A /org/service-profile # scope vhba vhba3
server-A /org/service-profile/vhba # set identity wwpn-pool MyWwpnPool13
server-A /org/service-profile/vhba* # commit-buffer
server-A /org/service-profile/vhba #

Related Commands Command Description


create wwpn-pool
show vhba

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1197
Commands
set intel-turbo-boost-config

set intel-turbo-boost-config
To specify whether Intel Turbo Boost Technology is enabled, use the set intel-turbo-boost-config command.

set intel-turbo-boost-config turbo-boost {disabled| enabled| platform-default}

Syntax Description disabled The processor never increases its frequency automatically.

enabled The processor utilizes Turbo Boost Technology if required.

platform-default The BIOS uses the value for this attribute contained in the BIOS defaults
for the server type and vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to specify whether the processor uses Intel Turbo Boost Technology, which allows the
processor to automatically increase its frequency if it is running below power, temperature, or voltage
specifications.

Examples The following example shows how to create a BIOS policy specifying that Intel Turbo Boost Technology is
enabled:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set intel-turbo-boost-config turbo-boost enabled
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1198 OL-25718-02
Commands
set intel-vt-config

set intel-vt-config
To specify whether Intel Virtualization Technology is enabled, use the set intel-vt-config command.

set intel-vt-config vt {disabled| enabled| platform-default}

Syntax Description disabled The processor does not permit virtualization.

enabled The processor allows multiple operating systems in independent partitions.

platform-default The BIOS uses the value for this attribute contained in the BIOS defaults
for the server type and vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to specify whether the processor uses Intel Virtualization Technology, which allows a
platform to run multiple operating systems and applications in independent partitions.

Note If you change this option, you must power cycle the server before the setting takes effect.

Examples The following example shows how to create a BIOS policy specifying that Intel Virtualization Technology
is enabled:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set intel-vt-config vt enabled
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1199
Commands
set intel-vt-directed-io-config

set intel-vt-directed-io-config
To specify whether Intel Virtualization Technology for Directed I/O is enabled, use the set
intel-vt-directed-io-config command.

set intel-vt-directed-io-config {ats-support| coherency-support| interrupt-remapping| passthrough-dma|


vtd} {disabled| enabled| platform-default}

Syntax Description ats-support Specifies processor support for


Intel VT-d Address Translation
Services (ATS).

coherency-support Specifies processor support for


Intel VT-d Coherency.

interrupt-remapping Specifies processor support for


Intel VT-d Interrupt Remapping.

passthrough-dma Specifies processor support for


Intel VT-d Passthrough DMA.

vtd Specifies processor support for


Intel Virtualization Technology for
Directed I/O.

disabled Processor support for the feature is


disabled.

enabled Processor support for the feature is


enabled.

platform-default The BIOS uses the value for this


attribute contained in the BIOS
defaults for the server type and
vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Cisco UCS Manager CLI Command Reference, Release 2.0


1200 OL-25718-02
Commands
set intel-vt-directed-io-config

Usage Guidelines Use this command to configure processor support for Intel Virtualization Technology for Directed I/O.

Examples The following example shows how to create a BIOS policy specifying that Intel Virtualization Technology
for Directed I/O is enabled with Intel VT-d Interrupt Remapping:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set intel-vt-directed-io-config vtd enabled
switch-A /org/bios-policy* # set intel-vt-directed-io-config interrupt-remapping enabled
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1201
Commands
set interrupt coalescing-time

set interrupt coalescing-time


To configure the waiting time for interrupt coalescing, use the set interrupt coalescing-time command.

set interrupt coalescing-time coalescing-time

Syntax Description coalescing-time Enter a value between 1 and 65535 µsec. To turn off coalescing, enter 0
(zero).

Command Default The interrupt coalescing time is 125 µsec.

Command Modes Ethernet adapter policy (/org/eth-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the time to wait between interrupts or the idle period that must be encountered
before an interrupt is sent. The coalescing behavior is specified by the set interrupt coalescing-type command.

Examples This example shows how to configure an Ethernet policy with interrupt coalescing:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set interrupt coalescing-time 1000
switch-A /org/eth-policy* # set interrupt coalescing-type min
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


set interrupt coalescing-type
show eth-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1202 OL-25718-02
Commands
set interrupt coalescing-type

set interrupt coalescing-type


To configure the interrupt coalescing behavior, use the set interrupt coalescing-type command.

set interrupt coalescing-type {idle| min}

Syntax Description idle The system waits for a period of inactivity exceeding the coalescing time before
sending another interrupt event.

min The system waits for the coalescing time before sending another interrupt event.

Command Default The interrupt coalescing type is min.

Command Modes Ethernet adapter policy (/org/eth-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the interrupt coalescing behavior. The coalescing time period for waiting is
specified by the set interrupt coalescing-time command.

Examples This example shows how to configure an Ethernet policy with interrupt coalescing:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set interrupt coalescing-time 1000
switch-A /org/eth-policy* # set interrupt coalescing-type min
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


set interrupt coalescing-time
show eth-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1203
Commands
set interrupt count

set interrupt count


To configure the number of interrupt resources to allocate, use the set interrupt count command.

set interrupt count count

Syntax Description count Enter a value between 1 and 514.

Command Default The interrupt count is 4.

Command Modes Ethernet adapter policy (/org/eth-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the number of interrupt resources to allocate. In general, you should allocate
one interrupt resource for each completion queue.

Examples This example shows how to configure the interrupt resources of an Ethernet adapter policy:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set interrupt count 32
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


show eth-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1204 OL-25718-02
Commands
set interrupt mode

set interrupt mode


To configure the interrupt mode, use the set interrupt mode command.

set interrupt mode {intx| msi| msi-x}

Syntax Description intx Line interrupt

msi Message-Signaled Interrupt (MSI )

msi-x Extended Message-Signaled Interrupt

Command Default The interrupt mode is msi-x.

Command Modes Ethernet adapter policy (/org/eth-policy)


Fibre channel adapter policy (/org/fc-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to configure the interrupt mode of the Ethernet or fibre channel adapter. The mode options
are:
• intx—Line interrupt
• msi—Message-signaled interrupt
• msi-x—Extended message-signaled interrupt

Examples This example shows how to configure the interrupt mode of an Ethernet adapter policy:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy* # set interrupt mode msi
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


show eth-policy
show fc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1205
Commands
set interval-days

set interval-days
To configure the number of days between periodic Call Home inventory messages, use the set interval-days
command.

set interval-days days

Syntax Description days Number of days between inventory messages.

Command Default None

Command Modes Inventory (/monitoring/callhome/inventory)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to configure the number of days between periodic Call Home inventory messages. The
range is 0 to 30 days; the default is 7 days.

Examples This example shows how to enable the periodic sending of a Call Home inventory message at 17:30 hours
every 14 days:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # scope inventory
switch-A /monitoring/callhome/inventory # set send-periodically on
switch-A /monitoring/callhome/inventory* # set interval-days 14
switch-A /monitoring/callhome/inventory* # set timeofday-hour 17
switch-A /monitoring/callhome/inventory* # set timeofday-minute 30
switch-A /monitoring/callhome/inventory* # commit-buffer
switch-A /monitoring/callhome/inventory #

Related Commands Command Description


set send-periodically
set timeofday-hour
set timeofday-minute
show inventory

Cisco UCS Manager CLI Command Reference, Release 2.0


1206 OL-25718-02
Commands
set ip

set ip
To specify an IP address for a certificate request of a key ring, use the set ip command.

set ip certificate request ip address

Syntax Description certificate request ip address The IP address of the fabric interconnect associated with the
certificate request.

Command Default None

Command Modes Certificate Request (/security/keyring/certreq)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines You should create a certificate request before specifying the IP address.

Examples The following example shows how to set the IP address for a certificate request.
UCS-A # scope security
UCS-A /security # scope keyring test
UCS-A /security/keyring # create certreq
UCS-A /security/keyring/certreq* # set ip 1.2.3.4
UCS-A /security/keyring/certreq* # commit buffer
UCS-A /security/keyring/certreq #

Related Commands Command Description


set country

set dns

set email

set locality

set org-name

set org-unit-name

set state

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1207
Commands
set ip

Command Description
set subject-name

Cisco UCS Manager CLI Command Reference, Release 2.0


1208 OL-25718-02
Commands
set ipmi-access-profile

set ipmi-access-profile
To set the IPMI access profile, use the set ipmi-access-profile command.

set ipmi-access-profile name

Syntax Description name IPMI access profile name. The range of valid values is 1 to 16.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to associate the specified IPMI access profile with the service profile you used to enter
service profile mode.

Examples This example shows how to set the IPMI access profile:

switch-A# scope org org10

switch-A /org # scope service-profile servProf10

switch-A /org/service-profile # set ipmi-access-profile iaP10

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show association
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1209
Commands
set iqn-prefix

set iqn-prefix
To set prefix for an IQN pool, use the set iqn-prefix command.

set iqn-prefix IQN prefix

Syntax Description IQN prefix Name of the IQN prefix. The name can include a maximum of 150 characters,
and can be alphanumeric.

Command Default None

Command Modes IQN pool (/org/iqn-pool)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines An IQN pool must be created to use this command.

Examples This example shows how to create a prefix for an IQN pool.
UCS-A # scope org
UCS-A /org # scope iqn-pool Sample1
UCS-A /org/iqn-pool # set iqn-prefix test1
UCS-A /org/iqn-pool* # commit-buffer
UCS-A /org/iqn-pool #

Related Commands Command Description


create iqn-pool

show iqn-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


1210 OL-25718-02
Commands
set iscsi-adaptor-policy

set iscsi-adaptor-policy
To set an iSCSI adaptor policy for an iSCSI VNIC, use the set iscsi-adaptor-policy command.

set iscsi-adaptor-policy iscsi-adaptor-policy

Syntax Description iscsi-adaptor-policy Name of the iSCSI adaptor policy for the iSCSI VNIC. The name can include
a maximum of 16 characters and can be alphanumeric.

Command Default None

Command Modes iSCSI VNIC (/org/service-profile/vnic-iscsi)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a service profile, and an iSCSI VNIC for the service profile before you use this command.

Examples This example shows how to set the iSCSI adaptor policy for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi
UCS-A /org/service-profile/vnic-iscsi # set iscsi-adaptor-policy Trial
UCS-A /org/service-profile/vnic-iscsi* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi #

Related Commands Command Description


set auth-name

set identity

set iscsi-identity

set overlay-vnic-name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1211
Commands
set iscsi-identity initiator-name

set iscsi-identity initiator-name


To set an initiator name for the iSCSI VNIC, use the set iscsi-identity initiator-name command.

set iscsi-identity initiator-name initiator-name

Syntax Description initiator-name Name of the initiator for the iSCSI VNIC.

Command Default None

Command Modes iSCSI VNIC (/org/service-profile/vnic-iscsi)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a service profile and an iSCSI VNIC for the service profile before you use this command.

Examples This example shows how to set an initiator name for the iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi
UCS-A /org/service-profile/vnic-iscsi # set iscsi-identity initiator-name Admin
UCS-A /org/service-profile/vnic-iscsi* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi #

Related Commands Command Description


set auth-name

set identity

set iscsi-adaptor-policy

set overlay-vnic-name

Cisco UCS Manager CLI Command Reference, Release 2.0


1212 OL-25718-02
Commands
set iscsi-protocol-item boottotarget

set iscsi-protocol-item boottotarget


To set the boot to target configuration for an iSCSI policy, use the set iscsi-protocol-item boottotarget
command.

set iscsi-protocol-item boottotarget {yes| no}

Syntax Description yes Configures the iSCSI policy to boot to target.

no Configures the iSCSI policy to not boot to target.

Command Default None

Command Modes iSCSI Policy (/org/iscsi-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI policy before you use this command.

Examples This example shows how to set the iSCSI protocol to boot to target:
UCS-A # scope org test
UCS-A /org # scope iscsi-policy sample
UCS-A /org/iscsi-policy # set iscsi-protocol-item boottotarget yes
UCS-A /org/iscsi-policy* # commit-buffer
UCS-A /org/iscsi-policy #

Related Commands Command Description


set iscsi-protocol-item dhcp-timeout

set iscsi-protocol-item connection-timeout

set iscsi-protocol-item lun-busy-retrycount

set iscsi-protocol-item tcp-time-stamp

set iscsi-protocol-item hbamode

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1213
Commands
set iscsi-protocol-item connection-timeout

set iscsi-protocol-item connection-timeout


To set the time interval, in seconds, that Cisco UCS waits after which it assumes that the initial login has
failed and that the iSCSI adapter is unavailable, use the set iscsi-protocol-item connection-timeout command.

set iscsi-protocol-item connection-timeout connection-timeout

Syntax Description connection-timeout Connection timeout interval. The value is between 0 and 255 seconds.

Command Default The default value is 15 seconds.

Command Modes iSCSI Policy (/org/iscsi-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI policy before you use this command.
If you set the value to 0, then Cisco UCS uses the value set in the adapter firmware.

Examples This example shows how to set the iSCSI protocol connection timeout to 50 seconds:
UCS-A # scope org test
UCS-A /org # scope iscsi-policy sample
UCS-A /org/iscsi-policy # set iscsi-protocol-item connection timeout 50
UCS-A /org/iscsi-policy* # commit-buffer
UCS-A /org/iscsi-policy #

Related Commands Command Description


set iscsi-protocol-item dhcp-timeout

set iscsi-protocol-item lun-busy-retrycount

set iscsi-protocol-item tcp-time-stamp

set iscsi-protocol-item boottotarget

set iscsi-protocol-item hbamode

Cisco UCS Manager CLI Command Reference, Release 2.0


1214 OL-25718-02
Commands
set iscsi-protocol-item dhcp-timeout

set iscsi-protocol-item dhcp-timeout


To set an DHCP timeout interval for an iSCSI policy, use the set iscsi-protocol-profile dhcp-timeout
command.

set iscsi-protocol-item dhcp-timeout dhcp-timeout

Syntax Description dhcp-timeout DHCP timeout interval. The value must be between 60 and 300 seconds.

Command Default None

Command Modes iSCSI Policy (/org/iscsi-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI policy before you use this command.

Examples This example shows how to set the DHCP timeout for an iSCSI policy to 70 seconds:
UCS-A # scope org test
UCS-A /org # scope iscsi-policy sample
UCS-A /org/iscsi-policy # set iscsi-protocol-item dhcp-timeout 70
UCS-A /org/iscsi-policy* # commit-buffer
UCS-A /org/iscsi-policy #

Related Commands Command Description


set iscsi-protocol-item boottotarget

set iscsi-protocol-item connection-timeout

set iscsi-protocol-item hbamode

set iscsi-protocol-item lun-busy-retrycount

set iscsi-protocol-item tcp-time-stamp

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1215
Commands
set iscsi-protocol-item hbamode

set iscsi-protocol-item hbamode


To set an HBA mode for an iSCSI policy, use the set iscsi-protocol-item hbamode command.

set iscsi-protocol-item hbamode {yes| no}

Syntax Description yes To configure an HBA mode for the iSCSI policy.

no To clear the HBA mode for the iSCSI policy.

Command Default None

Command Modes iSCSI Policy (/org/iscsi-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines An iSCSI policy must be created to use this command.

Examples This example shows how to set an HBA mode for an iSCSI policy.
UCS-A # scope org test
UCS-A /org # scope iscsi-policy sample
UCS-A /org/iscsi-policy # set iscsi-protocol-item hbamode yes
UCS-A /org/iscsi-policy* # commit-buffer
UCS-A /org/iscsi-policy #

Related Commands Command Description


set iscsi-protocol-item dhcp-timeout

set iscsi-protocol-item connection-timeout

set iscsi-protocol-item lun-busy-retrycount

set iscsi-protocol-item tcp-time-stamp

set iscsi-protocol-item boottotarget

Cisco UCS Manager CLI Command Reference, Release 2.0


1216 OL-25718-02
Commands
set iscsi-protocol-item lun-busy-retrycount

set iscsi-protocol-item lun-busy-retrycount


To set the number of times to retry the connection in case of a failure during iSCSI LUN discovery, use the
set iscsi-protocol-profile lun-busy-retrycount command.

set iscsi-protocol-item lun-busy-retrycount lun-busy-retrycount

Syntax Description lun-busy-retrycount LUN busy retry count parameter for an iSCSI policy. The value must
be between 0 and 60.

Command Default None

Command Modes iSCSI policy (/org/iscsi-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI policy before you use this command.
If you enter the value as 0, then Cisco UCS uses the value set in the adapter firmware.

Examples This example shows how to set the LUN busy retry-count parameter to 50 for an iSCSI policy:
UCS-A # scope org test
UCS-A /org # scope iscsi-policy sample
UCS-A /org/iscsi-policy # set iscsi-protocol-item lun-busy-retrycount 50
UCS-A /org/iscsi-policy* # commit-buffer
UCS-A /org/iscsi-policy #

Related Commands Command Description


set iscsi-protocol-item boottotarget

set iscsi-protocol-item connection-timeout

set iscsi-protocol-item dhcp-timeout

set iscsi-protocol-item hbamode

set iscsi-protocol-item tcp-time-stamp

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1217
Commands
set iscsi-protocol-item tcp-time-stamp

set iscsi-protocol-item tcp-time-stamp


To set a TCP timestamp for an iSCSI policy, use the set iscsi-protocol-profile tcp-time-stamp command.

set iscsi-protocol-item tcp-time-stamp {no| yes}

Syntax Description no Specifies not setting the TCP timestamp for the iSCSI policy.

yes Specifies setting the TCP timestamp for the iSCSI policy.

Command Default By default, the TCP timestamp is disabled.

Command Modes iSCSI policy (/org/iscsi-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI policy before you use this command.
This option only applies to servers with the Cisco UCS NIC M51KR-B adapter.

Examples This example shows how to enable the TCP timestamp feature for an iSCSI policy:
UCS-A # scope org test
UCS-A /org # scope iscsi-policy sample
UCS-A /org/iscsi-policy # set iscsi-protocol-item tcp-time-stamp yes
UCS-A /org/iscsi-policy* # commit-buffer
UCS-A /org/iscsi-policy #

Related Commands Command Description


set iscsi-protocol-item boottotarget

set iscsi-protocol-item connection timeout

set iscsi-protocol-item dhcp-timeout

set iscsi-protocol-item hbamode

set iscsi-protocol-item lun-busy-retrycount

Cisco UCS Manager CLI Command Reference, Release 2.0


1218 OL-25718-02
Commands
set iscsi-targetname

set iscsi-targetname
To set an ISCSI target name for a static target interface, use the set iscsi-targetname command.

set iscsi-targetname name

Syntax Description Name The name of the ISCSI target.

Command Default None

Command Modes Static target interface (/org/service-profile/vnic-iscsi/eth-if/static-target-if)

Command History Release Modification


2.0(3) This command was introduced in this release.

Usage Guidelines An ISCSI VNIC must be created to use this command.

Examples This example shows how to set the ISCSI target name for a static target interface.
UCS-A # scope org
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # scope static-target-if 1
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if # set iscsi-targetname sample1
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi/eth-if/static-target-if #

Related Commands Command Description


create vnic-iscsi

create static-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1219
Commands
set iscsivnicname

set iscsivnicname
To set an iSCSI VNIC name for the iSCSI path, use the set iscsivnicname command.

set iscsivnicname iscsivnicname

Syntax Description iscsivnicname Name of the iSCSI VNIC path. The name can include a maximum of 16
alphanumeric characters.

Command Default None

Command Modes Path (/org/boot-policy/iscsi/path)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create an iSCSI path for a boot policy before you use this command.

Examples This example shows how to set the iSCSI VNIC name to the iSCSI path of the boot policy:
UCS-A # scope org test
UCS-A /org # scope boot-policy sample
UCS-A /org/boot-policy # scope iscsi
UCS-A /org/boot-policy/iscsi # scope path primary
UCS-A /org/boot-policy/iscsi/path # set iscsivnicname Trial
UCS-A /org/boot-policy/iscsi/path* # commit-buffer
UCS-A /org/boot-policy/iscsi/path #

Related Commands Command Description


create path

Cisco UCS Manager CLI Command Reference, Release 2.0


1220 OL-25718-02
Commands
set isnative

set isnative
To mark a member-port as a native VLAN, use the set isnative command.

set isnative {no| yes}

Syntax Description no Use this option to not set a member-port as the native VLAN.

yes Use this option to set a member-port as the native VLAN.

Command Default None

Command Modes Member port (eth-storage/fabric/vlan/member-port)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to set a member port as a native vlan.
Switch-A # scope eth-storage
Switch-A /eth-storage # scope fabric a
Switch-A /eth-storage/fabric # scope vlan test
Switch-A /eth-storage/fabric/vlan # scope member-port a 1 2
Switch-A /eth-storage/fabric/vlan/member-port # set isnative yes
Switch-A /eth-storage/fabric/vlan/member-port* # commit-buffer
Switch-A /eth-storage/fabric/vlan/member-port #

Related Commands Command Description


create member-port

scope member-port

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1221
Commands
set key (server)

set key (server)


To set the server key for connecting to an authentication server, use the set key command.

set key

Syntax Description
This command has no arguments or keywords.

Command Default None

Command Modes Server under TACACS (/security/tacacs/server)


Server under LDAP (/security/ldap/server)
Server under RADIUS (/security/radius/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines When you enter this command, you are prompted to type a key value twice. When you type the key on the
command line, it does not display.
The key can be up to 33 characters.

Examples This example shows how to set a key in server under LDAP mode:
switch-A#scope security
switch-A /security # scope ldap
switch-A /security/ldap # scope server 192.0.20.246
switch-A /security/ldap/server # set key
Enter the key:
Confirm the key:
switch-A /security/ldap/server* # commit-buffer
switch-A /security/ldap/server #

Related Commands Command Description


show ldap
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


1222 OL-25718-02
Commands
set key (extension-key)

set key (extension-key)


To set up the master extension key, use the set key command in extension-key mode.

set key key-name

Syntax Description key-name The name of the key. A unique set of numbers or letters that identifies the key.
The range of valid values is 1 to 33.

Command Default None

Command Modes Extension key (/system/vm-mgmt/extension-key)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to set up the master extension key:
switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope extension-key
switch-A /system/vm-mgmt/extension-key # set key K1
switch-A /system/vm-mgmt/extension-key* # commit-buffer

switch-A /system/vm-mgmt/extension-key #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1223
Commands
set lastname

set lastname
To set the user name last name, use the set lastname command.

set lastname name

Syntax Description name Last name. The range of valid values is 1 to 16.

Command Default None

Command Modes Local user (/security/local-user)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the user name last name:

switch-A#scope security

switch-A /security # scope local-user lu1

switch-A /security/local-user # set lastname foo

switch-A /security/local-user* # commit-buffer

switch-A /security/local-user #

Related Commands Command Description


show local-user
show remote-user

Cisco UCS Manager CLI Command Reference, Release 2.0


1224 OL-25718-02
Commands
set level

set level
To filter Call Home messages based on their level of urgency, use the set level command.

set level {disaster| fatal| critical| major| minor| warning| notification| normal| debug}

Syntax Description disaster Disaster level (8)

fatal Fatal level (7)

critical Critical level (6)

major Major level (5)

minor Minor level (4)

warning Warning level (3)

notification Notification level (2)

normal Normal level (1)

debug Debug level (0)

Command Default The default level is Normal.

Command Modes Profile (/monitoring/callhome/profile)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to filter Call Home messages based on their level of urgency. Select the minimum urgency
level for generating a Call Home message, with Disaster (8) being the highest urgency and Debug (0) being
the lowest. Any message with a level value lower than the configured urgency level is not sent.

Examples This example shows how to set a threshold urgency level of Critical for sending Call Home messages:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # enter profile TestProfile
switch-A /monitoring/callhome/profile* # set level critical

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1225
Commands
set level

switch-A /monitoring/callhome/profile* # commit-buffer


switch-A /monitoring/callhome/profile #

Related Commands Command Description


show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


1226 OL-25718-02
Commands
set link-aggregation-pref

set link-aggregation-pref
To set the link aggregation preference for the chassis connectivity policy for a fabric, use the set
link-aggregation-pref command.

set link-aggregation-pref {global| none| port-channel}

Syntax Description global Sets the link aggregation preference to global. This option sets the preference to
the chassis discovery policy.

none Sets the link aggregation preference to none. This option implies that no port
channels are required.

port-channel Sets the link aggregation preference to port-channel. This options implies that
port channels are required.

Command Default None

Command Modes Chassis connectivity policy (/org/chassis-conn-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines Port channels are supported only with the new IO module that is released with 2.0(1) release. If your
configuration includes IO modules of previous releases, then you cannot configure port channels.

Examples This example shows how to set the link aggregation preference for the chassis connectivity policy to
port-channel for fabric A:
UCS-A # scope org test
UCS-A /org # scope chassis-conn-policy 1 a
UCS-A /org/chassis-conn-policy # set link-aggregation-pref port-channel
UCS-A /org/chassis-conn-policy* # commit-buffer
UCS-A /org/chassis-conn-policy #

Related Commands Command Description


show chassis-conn-policy

scope chassis-conn-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1227
Commands
set link-aggregation-pref (/chassis-disc-policy)

set link-aggregation-pref (/chassis-disc-policy)


To set a link aggregation preference for the policy, use the set link-aggregation-pref command.

set link-aggregation-pref {none| port-channel}

Syntax Description none Sets no link aggregation preference for the policy.

port-channel Sets the link aggregation preference to port channel.

Command Default None

Command Modes Chassis disc policy (/org/chassis-disc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to set the link aggregation preference to port channel:
UCS-A # scope org test
UCS-A /org # scope chassis-disc-policy
UCS-A /org/chassis-disc-policy # set link-aggregation-pref port-channel
UCS-A /org/chassis-disc-policy* # commit-buffer
UCS-A /org/chassis-disc-policy #

Related Commands Command Description


show chassis-disc-policy

show org

Cisco UCS Manager CLI Command Reference, Release 2.0


1228 OL-25718-02
Commands
set local-disk-policy

set local-disk-policy
To set the local disk policy, use the set local-disk-policy command.

set local-disk-policy name

Syntax Description name Local disk policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0 This command was introduced.

Usage Guidelines Use this command to associate the specified local disk policy with the service profile you used to enter service
profile mode.

Examples This example shows how to set the local disk policy:

switch-A# scope org org10

switch-A /org # scope service-profile servProf10

switch-A /org/service-profile # set local-disk-policy ldiskP10

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show association
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1229
Commands
set locality

set locality
To specify a city or town in which the company that requested for the certificate resides, use the set locality
command.

set locality Locality Name

Syntax Description Locality name The name of the city or town in which the company that requested the certificate
resides. The name can include a maximum of 64 characters and can be
alphanumeric.

Command Default None

Command Modes Certificate Request (/security/keyring/certreq)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines You should create a certificate request before specifying the locality.

Examples The following example shows how to set the locality for a certificate request.
UCS-A # scope security
UCS-A /security # scope keyring test
UCS-A /security/keyring # create certreq
UCS-A /security/keyring/certreq* # set locality new york city
UCS-A /security/keyring/certreq* # commit buffer
UCS-A /security/keyring/certreq #

Related Commands Command Description


set country

set dns

set email

set locality

set org-name

set org-unit-name

Cisco UCS Manager CLI Command Reference, Release 2.0


1230 OL-25718-02
Commands
set locality

Command Description
set state

set subject-name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1231
Commands
set lun

set lun
To set a LUN name, use the set lun command.

set lun name

Syntax Description name LUN name. The range of valid values is 1 to 16.

Command Default None

Command Modes SAN image path (/org/boot-policy/storage/san-image/path)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set a LUN name:

switch-A# scope org org3

switch-A /org # scope boot-policy bp10a

switch-A /org/boot-policy # scope storage

switch-A /org/boot-policy/storage # scope san-image primary

switch-A /org/boot-policy/storage/san-image # scope path primary

switch-A /org/service-profile/storage/san-image/path # set lun lun100

switch-A /org/service-profile/path* # commit-buffer

switch-A /org/service-profile/path #

Related Commands Command Description


show path
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


1232 OL-25718-02
Commands
set lv-dimm-support-config

set lv-dimm-support-config
To specify whether the system prioritizes low voltage or high frequency memory operations, use the set
lv-dimm-support-config command.

set lv-dimm-support-config lv-ddr-mode {performance-mode| power-saving-mode| platform-default}

Syntax Description performance-mode The system prioritizes high frequency operations over low voltage
operations.

power-saving-mode The system prioritizes low voltage memory operations over high
frequency memory operations.

platform-default The BIOS uses the value for this attribute contained in the BIOS defaults
for the server type and vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to specify whether the system prioritizes low voltage or high frequency memory operations.
Selecting the power-saving-mode option may lower memory frequency in order to keep the voltage low.

Examples The following example shows how to create a BIOS policy that prioritizes high frequency operations over
low voltage operations:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set lv-dimm-support-config lv-ddr-mode performance-mode
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1233
Commands
set macaddress

set macaddress
To set a MAC address for an Ethernet target endpoint, use the set macaddress command.

set macaddress Target MAC address

Syntax Description Target MAC address The MAC address of the Ethernet target endpoint. It must be in the
AA:BB:CC:DD:EE:FF format.

Command Default None

Command Modes Ethernet target endpoint (/eth-storage/fabric/interface/eth-target)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An interface for a fabric, and an Ethernet target endpoint for the fabric interface must be created to use this
command.

Examples This example shows how to set the MAC address for an Ethernet target endpoint.
Switch-A # scope eth-storage
Switch-A /eth-storage # scope fabric a
Switch-A /eth-storage/fabric # scope eth-target Test
Switch-A /eth-storage/fabric/eth-target # set macaddress 00:0D:L1:56:89:DA
Switch-A /eth-storage/fabric/eth-target* # commit-buffer
Switch-A /eth-storage/fabric/eth-target #

Related Commands Command Description


create eth-target
scope eth-target
enter eth-target
show eth-target
delete eth-target

Cisco UCS Manager CLI Command Reference, Release 2.0


1234 OL-25718-02
Commands
set mac-aging

set mac-aging
To set up MAC aging, use the set mac aging command.

set mac-aging{number-of-days: number-of-hours: number -of-minutes: number-of-seconds| mode-default|


never}

Syntax Description mode-default The aging time default value for the configured Ethernet switching mode. For end-host
mode, the default aging time is 7200 seconds; for switch mode, the default aging
time is 300 seconds.

never If the aging time is set to never the system will not remove MAC addresses from the
table, regardless of how long they have been idle.

Command Default None

Command Modes Ethernet uplink (/eth-uplink)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines The MAC aging time must be set in the dd:hh:mm:ss format.

Examples This example shows how to set up MAC aging:


switch-A# scope eth-uplink
switch-A /eth-uplink # set mac-aging 11 11 59 59
switch-A /eth-uplink* # commit-buffer
switch-A /eth-uplink #

Related Commands Command Description


set mode (eth-uplink)

show eth-uplink

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1235
Commands
set mac-pool

set mac-pool
To specify a pool of MAC addresses for a vNIC template, use the set mac-pool command.

set mac-pool mac-pool

Syntax Description mac-pool Name of a MAC address pool.

Command Default None

Command Modes Virtual NIC template (/org/vnic-templ)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify an existing pool of MAC addresses for dynamic assignment to a vNIC (virtual
network interface card) template.

Examples This example shows how to specify the MAC address pool for a vNIC:
switch-A# scope org org10
switch-A /org # scope vnic-templ sp10
switch-A /org/vnic-templ # set mac-pool pool192
switch-A /org/vnic-templ* # commit-buffer
switch-A /org/vnic-templ #

Related Commands Command Description


show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


1236 OL-25718-02
Commands
set maint-policy

set maint-policy
To set a maintenance policy for a service profile, use the set maint-policy command.

set maint-policy maintenance policy name

Syntax Description maintenance policy name The name of the maintenance policy.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A maintenance policy and a service profile must be created before using this command.

Examples This example shows how to set the maintenance policy for a service profile.
Switch-A # scope org
Switch-A /org # scope service-profile sample
Switch-A /org/service-profile # set maint-policy default
Switch-A /org/service-profile* # commit-buffer
Switch-A /org/service-profile #

Related Commands Command Description


create maint-policy
scope maint-policy
enter maint-policy
show maint-policy
delete maint-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1237
Commands
set maxcap

set maxcap
To set the maximum capacity, use the set maxcap command.

set maxcap {max-cap| unspecified}

Syntax Description max-cap Maximum capacity. The range of valid values is 0 to


9223372036854775807.

unspecified Specifies unspecified capacity.

Command Default None

Command Modes Storage (/org/server-qual/storage)


Memory (/org/server-qual/memory)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the maximum capacity of the memory array.

Examples This example shows how to set the maximum capacity:

switch-A# scope org org3

switch-A /org # scope server-qual sq3

switch-A /org/server-qual # scope storage

switch-A /org/service-qual/storage # set maxcap 10000000

switch-A /org/service-qual/storage* # commit-buffer

switch-A /org/service-qual/storage #

Related Commands Command Description


show memory
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


1238 OL-25718-02
Commands
set maxcores

set maxcores
To set the maximum number of cores, use the set maxcores command.

set maxcores {max-cores| unspecified}

Syntax Description max-cores Maximum number of cores. The range of valid values is 0 to 65535.

unspecified Specifies an unspecified number of cores.

Command Default None

Command Modes Processor (/org/server-qual/processor)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the maximum number of processor cores.

Examples This example shows how to set the maximum number of cores:

switch-A# scope org org3

switch-A /org # scope server-qual squal10

switch-A /org/server-qual # scope processor

switch-A /org/server-qual/processor # set maxcores 100

switch-A /org/server-qual/processor* # commit-buffer

switch-A /org/server-qual/processor #

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1239
Commands
set max-duration

set max-duration
To set a maximum duration for a one-time or periodic maintenance window, use the set max-duration
command.

set max-duration {none| days hours minutes seconds}

Syntax Description none Use this option to not set any day for the maintenance window.

days Use this option to set a number of days for the maintenance window. The value
must be between 0 - 4294967294.

hours Use this option to set the hour for the maintenance window. The value must be
between 0 - 23.

minutes Use this option to set the minutes for the maintenance window. The value must be
between 0 - 59.

seconds Use this option to set the seconds for the maintenance window. The value must be
between 0 - 59.

Command Default None

Command Modes One-time maintenance window (/system/scheduler/one-time)


Periodic maintenance window (/system/scheduler/periodic)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A scheduler policy and a maintenance window must be created to use this command.

Examples This example shows how to set the maximum duration for a periodic maintenance window.
Switch-A # scope system
Switch-A /system # scope scheduler Default
Switch-A /system/scheduler # scope maint-window periodic Trial
Switch-A /system/scheduler/periodic # set max-duration 23 4 45 6
Switch-A /system/scheduler/periodic* # commit-buffer
Switch-A /system/scheduler/periodic #

Cisco UCS Manager CLI Command Reference, Release 2.0


1240 OL-25718-02
Commands
set max-duration

Related Commands Command Description


set concur-jobs
set hour
set date
set minute
set min-interval
set proc-cap

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1241
Commands
set max-field-size

set max-field-size
To configure the maximum data field size for the Fibre Channel interface, use the set max-field-size command.

set max-field-size max-field-size

Syntax Description max-field-size The maximum data field size. The range is 256 to 2112 bytes; the default
is 2048.

Command Default The maximum data field size is 2048 bytes.

Command Modes Virtual HBA (/org/service-profile/vhba)


Virtual HBA template (/org/vhba-templ)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the maximum data field size for the Fibre Channel interface in a vHBA (virtual
host bus adapter).

Examples This example shows how to configure the maximum data field size for the Fibre Channel interface in a vHBA
template:
switch-A# scope org org10
switch-A /org # scope vhba-templ sp10
switch-A /org/vhba-templ # set max-field-size 512
switch-A /org/vhba-templ* # commit-buffer
switch-A /org/vhba-templ #

Related Commands Command Description


show vhba-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


1242 OL-25718-02
Commands
set max-http-user-sessions

set max-http-user-sessions
To set the maximum number of HTTP user sessions on the system, use the set max-http-user-sessions
command.

set max-http-user-sessions max http user sessions

Syntax Description max http user sessions The maximum number of HTTP user sessions. The value must be a
numeral.

Command Default None

Command Modes Security (/security)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The value for this command must be a number. You cannot enter an alphanumeric string or enter special
characters.

Examples This example shows how to set the maximum number of HTTP user sessions to 20.
Switch-A # scope security
Switch-A /security # set max-http-user-session 20
Switch-A /security* # commit-buffer

Related Commands Command Description


set enforce-strong-password
set password
set remote-user
set sshkey

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1243
Commands
set maximum

set maximum
To set the maximum, use the set maximum command.

set maximum {maximum| unspecified}

Syntax Description maximum Maximum

unspecified Specifies unspecified maximum.

Command Default None

Command Modes Capacity qualification (/org/server-qual/adapter/cap-qual)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the maximum capacity for the selected adapter type.

Examples This example shows how to set the maximum:

switch-A# scope org org3

switch-A /org # scope server-qual sq100

switch-A /org/server-qual # scope adapter

switch-A /org/server-qual/adapter # scope cap-qual fcoe

switch-A /org/server-qual/adapter/cap-qual # set maximum 100

switch-A /org/server-qual/adapter/cap-qual # commit-buffer

switch-A /org/server-qual/adapter/cap-qual #

Related Commands Command Description


show adapter
show cap-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


1244 OL-25718-02
Commands
set max-ports

set max-ports
To set the maximum number of ports a port profile can use, use the set max-ports command.

set max-ports maximun-number

Syntax Description maximun-number The maximum number of ports. The range of valid values is 1 to 4096.

Command Default None

Command Modes Port profile (/system/vm-mgmt/vmware/profile-set/port-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines The maximum number of ports that can be associated with a single distributed virtual switch (DVS) is 4096.
If the DVS has only one associated port profile, that port profile can be configured with up to 4096 ports.
However, if the DVS has more than one associated port profile, the total number of ports associated with all
of those port profiles combined cannot exceed 4096.

Examples This example shows how to set the maximum number of ports a port profile can use:
switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope profile-set
switch-A /system/vm-mgmt/vmware/profile-set # scope port-profile
switch-A /system/vm-mgmt/vmware/profile-set/port-profile # set max-ports 100
switch-A /system/vm-mgmt/vmware/profile-set/port-profile* # commit-buffer
switch-A /system/vm-mgmt/vmware/profile-set/port-profile #

Related Commands Command Description


show client
show port-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1245
Commands
set processor-c1e-config c1e

set processor-c1e-config c1e


To set the processor C1e configuration, use the set processor-c1e-config c1e command.

set processor-c1e-config c1e {disabled| enabled| platform-default}

Syntax Description disabled Disables the processor C1e configuration.

enabled Enables the processor C1e configuration.

platform-default Sets the processor C1e configuration to the platform default option.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a BIOS policy before you use this command.

Examples This example shows how to set the processor C1e configuration to the platform default option:
UCS-A # scope org test
UCS-A /org # scope bios-policy sample
UCS-A /org/bios-policy # set processor-c1e-config c1e platform-default
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


set intel-turbo-boost-config turbo-boost

set enhanced-intel-speedstep-config speed-step

set hyper-threading-config hyper-threading

set core-multi-processing-config multi-processing

set execute-disable bit

Cisco UCS Manager CLI Command Reference, Release 2.0


1246 OL-25718-02
Commands
set processor-c1e-config c1e

Command Description
set intel-vt-config vt

set direct-cache-access-config access

set max-variable-mtrr-setting-config processor-mtrr

set processor-c-state-config c-state

set processor-c3-report-config processor-c3-report

set processor-c6-report-config processor-report

set cpu-performance-config cpu-config

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1247
Commands
set max-memory-below-4gb-config max-memory

set max-memory-below-4gb-config max-memory


To configure the maximum memory usage of a BIOS policy to be below 4GB, use the set
max-memory-below-4gb-config max-memory command.

set max-memory-below-4gb-config max-memory {disabled | enabled | platform-default}

Syntax Description disabled Disable the maximum memory configuration.

enabled Enable the maximum memory configuration.

platform-default Sets the memory configuration to the platform default option.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A BIOS policy must be configured in the organization command mode to use this command.

Examples This example shows how to enable the maximum memory configuration.
UCS-A # scope org Test
UCS-A /org # scope bios-policy sample
UCS-A /org/bios-policy # set max-memory-below-4gb-config max-memory enabled
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


show max-memory-below-4gb-config

Cisco UCS Manager CLI Command Reference, Release 2.0


1248 OL-25718-02
Commands
set max-variable-mtrr-setting-config processor-mtrr

set max-variable-mtrr-setting-config processor-mtrr


To set the maximum MTRR configuration for the processor, use the set max-variable-mtrr-setting-config
processor-mtrr command.

set max-variable-mtrr-setting-config processor-mtrr {8| auto-max| platform-default}

Syntax Description 8 Sets the maximum variable MTRR configuration of a processor to 8.

auto-max Sets the maximum variable MTRR configuration of a processor to the automatic
maximum limit.

platform-default Sets the maximum variable MTRR configuration of a processor to the platform
default option.

Command Default Platform Default

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a BIOS policy before you use this command.

Examples This example shows how to set the maximum variable MTRR setting to 8:
UCS-A # scope org test
UCS-A /org # scope bios-policy sample
UCS-A /org/bios-policy # set max-variable-mtrr-setting-config processor-mtrr 8
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


set intel-turbo-boost-config turbo-boost

set enhanced-intel-speedstep-config speed-step

set hyper-threading-config hyper-threading

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1249
Commands
set max-variable-mtrr-setting-config processor-mtrr

Command Description
set core-multi-processing-config multi-processing

set execute-disable bit

set intel-vt-config vt

set direct-cache-access-config access

set processor-c-state-config c-state

set processor-c1e-config c1e

set processor-c3-report-config processor-c3-report

set processor-c6-report-config processor-report

set cpu-performance-config cpu-config

Cisco UCS Manager CLI Command Reference, Release 2.0


1250 OL-25718-02
Commands
set maxprocs

set maxprocs
To set the maximum number of processors, use the set maxprocs command.

set maxprocs {maxprocs| unspecified}

Syntax Description max-procs Maximum number of processors. The range of valid values is 0 to 65535.

unspecified Specifies an unspecified number of processors.

Command Default None

Command Modes Processor (/org/server-qual/processor)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the maximum number of processors:

switch-A# scope org org3

switch-A /org # scope server-qual squal10

switch-A /org/server-qual # scope processor

switch-A /org/server-qual/processor # set maxprocs 10

switch-A /org/server-qual/processor* # commit-buffer

switch-A /org/server-qual/processor #

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1251
Commands
set maxsize

set maxsize
To configure a maximum destination message size for Call Home messages, use the set maxsize command.

set maxsize maxsize

Syntax Description maxsize Maximum message size in bytes.

Command Default None

Command Modes Profile (/monitoring/callhome/profile)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to configure a maximum destination message size for Call Home messages. The range is
0 to 5000000 bytes; the default is 1000000.
For full-text and xml messages, the maximum recommended size is 5000000. For short-text messages, the
maximum recommended size is 100000. For messages sent to CiscoTAC-1, the maximum message size must
be 5000000.

Examples This example shows how to set a maximum Call Home message size of 10000 bytes:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # enter profile TestProfile
switch-A /monitoring/callhome/profile* # set maxsize 10000
switch-A /monitoring/callhome/profile* # commit-buffer
switch-A /monitoring/callhome/profile #

Related Commands Command Description


set format

show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


1252 OL-25718-02
Commands
set maxthreads

set maxthreads
To set the maximum number of threads, use the set maxthreads command.

set maxthreads {maxthreads| unspecified}

Syntax Description max-threads Maximum number of threads. The range of valid values is 0 to 65535.

unspecified Specifies an unspecified number of threads.

Command Default None

Command Modes Processor (/org/server-qual/processor)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the maximum number of threads:

switch-A# scope org org3

switch-A /org # scope server-qual squal10

switch-A /org/server-qual # scope processor

switch-A /org/server-qual/processor # set maxthreads 10

switch-A /org/server-qual/processor* # commit-buffer

switch-A /org/server-qual/processor #

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1253
Commands
set member-of-attribute

set member-of-attribute
To set the member of attribute for an LDAP group rule, use the set member-of-attribute command.

set member-of-attribute group attribute

Syntax Description Group Attribute The name of the group attribute that the LDAP group rule must be set with.
The value can include a maximum of 63 characters.

Command Default None

Command Modes LDAP Group Rule (/security/ldap/server/ldap-group-rule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An LDAP server and an LDAP group rule must be created to use this command.

Examples This example shows how to set the member of attribute for an LDAP group rule.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope server Testing
Switch-A /security/ldap/server # scope ldap-group-rule
Switch-A /security/ldap/server/ldap-group-rule # set member-of-attribute Sample
Switch-A /security/ldap/server/ldap-group-rule* # commit-buffer
Switch-A /security/ldap/server/ldap-group-rule #

Related Commands Command Description


show ldap-group-rule

Cisco UCS Manager CLI Command Reference, Release 2.0


1254 OL-25718-02
Commands
set memory-mirroring-mode

set memory-mirroring-mode
To enable and configure memory mirroring, use the set memory-mirroring-mode command.

set memory-mirroring-mode mirroring-mode {intersocket| intrasocket| platform-default}

Syntax Description intersocket Memory is mirrored between two Integrated Memory Controllers (IMCs)
across CPU sockets.

intrasocket One IMC is mirrored with another IMC in the same socket.

platform-default The BIOS uses the value for this attribute contained in the BIOS defaults
for the server type and vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to enable and configure memory mirroring, which enhances system reliability by keeping
two identical data images in memory.

Examples The following example shows how to enable intersocket memory mirroring:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set memory-mirroring-mode mirroring-mode intersocket
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1255
Commands
set memory-ras-config

set memory-ras-config
To specify the memory reliability, availability and serviceability (RAS) configuration, use the set
memory-ras-config command.

set memory-ras-config ras-config {lockstep| maximum performance| mirroring| platform-default}

Syntax Description lockstep Minimizes memory access latency


for DIMM pairs.

maximum performance System performance is optimized.

mirroring System reliability is optimized by


using half the system memory as
backup.

platform-default The BIOS uses the value for this


attribute contained in the BIOS
defaults for the server type and
vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to specify the memory reliability, availability and serviceability (RAS) configuration.
If the DIMM pairs in the server have an identical type, size, and organization and are populated across the
SMI channels, you can enable lockstep mode to minimize memory access latency and provide better
performance. Lockstep is enabled by default for B400 servers.

Examples The following example shows how to configure lockstep mode:


switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set memory-ras-config ras-config lockstep
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Cisco UCS Manager CLI Command Reference, Release 2.0


1256 OL-25718-02
Commands
set memory-ras-config

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1257
Commands
set memory-sparing-mode sparing-mode

set memory-sparing-mode sparing-mode


To set the memory sparing mode for a BIOS policy, use the set memory-sparing-mode sparing-mode
command.

set memory-sparing-mode sparing-mode {dimm-sparing| platform-default| rank-sparing}

Syntax Description dimm-sparing Sets the mode to spare the DIMMs.

platform-default Sets the memory sparing mode to the platform default option.

rank-sparing Sets the mode to spare the rank.

Command Default Platform default

Command Modes BIOS Policy (/org/bios-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A BIOS policy must be configured in the Organization command mode to use this command.

Examples This example shows how to set the memory sparing mode to the platform default option.
UCS-A # scope org
UCS-A /org # scope bios-policy sample
UCS-A /org/bios-policy # set memory-sparing-mode sparing-mode platform-default
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


show memory-sparing-mode

Cisco UCS Manager CLI Command Reference, Release 2.0


1258 OL-25718-02
Commands
set message

set message
To set a message as the pre-login banner for the system, use the set message command.

set message

This command has no arguments or keywords.

Command Default None

Command Modes Pre-login Banner (/security/banner/pre-login-banner)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines None

Examples This example shows how to set a message as the pre-login banner message.
UCS-A # scope security
UCS-A /security # scope banner
UCS-A /security/banner # scope pre-login-banner
UCS-A /security/banner/pre-login-banner # set message
UCS-A /security/banner/pre-login-banner* # commit buffer
UCS-A /security/banner/pre-login-banner #

Related Commands Command Description


clear message

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1259
Commands
set mgmt-fw-policy

set mgmt-fw-policy
To set the management firmware policy, use the set mgmt-fw-policy command.

set mgmt-fw-policy name

Syntax Description name Management firmware policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to associate the specified management firmware policy with the service profile you used
to enter service profile mode.

Examples This example shows how to set the management firmware policy:

switch-A# scope org org10

switch-A /org # scope service-profile servProf10

switch-A /org/service-profile # set mgmt-fw-policy mfwP10

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show association
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


1260 OL-25718-02
Commands
set mgmt-if-mon-policy arp-deadline

set mgmt-if-mon-policy arp-deadline


To set a maximum time limit that the management interface must wait for an ARP responses, use the set
mgmt-if-mon-policy arp-deadline command.

set mgmt-if-mon-policy arp-deadline arp-deadline

Syntax Description arp-deadline The time limit or deadline that the management interface must wait for an ARP
response. The value must be a number.

Command Default None

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to set the maximum time limit to wait for an ARP response to 12.
Switch-A # scope monitoring
Switch-A /monitoring # set mgmt-if-mon-policy arp-deadline 12
Switch-A /monitoring* # commit-buffer
Switch-A /monitoring #

Related Commands Command Description


set mgmt-if-mon-policy arp-requests
set mgmt-if-mon-policy arp-target1
set mgmt-if-mon-policy arp-target2
set mgmt-if-mon-policy arp-target3
set mgmt-if-mon-policy max-fail-reports
set mgmt-if-mon-policy mii-retry-count
set mgmt-if-mon-policy mii-retry interval
set mgmt-if-mon-policy monitor-mechanism
set mgmt-if-mon-policy ping-deadline

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1261
Commands
set mgmt-if-mon-policy arp-deadline

Command Description
set mgmt-if-mon-policy ping-requests
set mgmt-if-mon-policy poll-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


1262 OL-25718-02
Commands
set mgmt-if-mon-policy monitor-mechanism

set mgmt-if-mon-policy monitor-mechanism


To set a monitoring mechanism for the management interface monitoring policy, use the set
mgmt-if-mon-policy monitor-mechanism command.

set mgmt-if-mon-policy monitor-mechanism {ping-arp-targets| ping-gateway| mii-status}

Syntax Description ping-arp-targets Use this option to monitor all ARP targets that are pinged.

ping-gateway Use this option to monitor all ping gateways.

mii-status Use this option to monitor all mii-status.

Command Default None

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to set the monitoring mechanism to monitor the ping gateway.
Switch-A # scope monitoring
Switch-A /monitoring # set mgmt-if-mon-policy monitor-mechanism ping-gateway
Switch-A /monitoring* # commit-buffer
Switch-A /monitoring #

Related Commands Command Description


set mgmt-if-mon-policy arp-deadline
set mgmt-if-mon-policy arp-requests
set mgmt-if-mon-policy arp-target1
set mgmt-if-mon-policy arp-target2
set mgmt-if-mon-policy arp-target3
set mgmt-if-mon-policy max-fail-reports
set mgmt-if-mon-policy mii-retry-counts

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1263
Commands
set mgmt-if-mon-policy monitor-mechanism

Command Description
set mgmt-if-mon-policy mii-retry-interval
set mgmt-if-mon-policy ping-deadline
set mgmt-if-mon-policy ping-requests
set mgmt-if-mon-policy poll-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


1264 OL-25718-02
Commands
set mgmt-if-mon-policy ping-requests

set mgmt-if-mon-policy ping-requests


To set the maximum number of ping requests that can be handled by the management interface, use the set
mgmt-if-mon-policy ping-requests command.

set mgmt-if-mon-policy ping-requests ping-requests

Syntax Description ping-requests The number of ping requests. It must be a number between 1 and 5.

Command Default None

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to set the ping requests to 5.


Switch-A # scope monitoring
Switch-A /monitoring # set mgmt-if-mon-policy ping-requests 5
Switch-A /monitoring* # commit-buffer
Switch-A /monitoring #

Related Commands Command Description


set mgmt-if-mon-policy poll-interval

set mgmt-if-mon-policy ping-deadline

show mgmt-if-mon-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1265
Commands
set mgmt-if-mon-policy poll-interval

set mgmt-if-mon-policy poll-interval


To set the polling interval for the management interface monitor settings, use the set mgmt-if-mon-policy
poll-interval command.

set mgmt-if-mon-policy poll-interval poll-interval

Syntax Description poll-interval The polling interval in seconds. The value must be a number between 99
and 300.

Command Default None

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to set the polling interval to 200 seconds.
Switch-A # scope monitoring
Switch-A /monitoring # set mgmt-if-min-policy poll-interval 200
Switch-A /monitoring* # commit-buffer
Switch-A /monitoring #

Related Commands Command Description


set mgmt-if-mon-policy ping-deadline

set mgmt-if-mon-policy ping-requests

show mgmt-if-mon-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1266 OL-25718-02
Commands
set mincap

set mincap
To set the minimum capacity, use the set mincap command.

set mincap {mincap| unspec}

Syntax Description min-cap Maximum capacity. The range of valid values is 0 to


9223372036854775807.

unspecified Specifies unspecified capacity.

Command Default None

Command Modes Storage (/org/server-qual/storage)


Memory (/org/server-qual/memory)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the minimum capacity of the memory array.

Examples This example shows how to set the minimum capacity:

switch-A# scope org org3

switch-A /org # scope server-qual sq3

switch-A /org/server-qual # scope storage

switch-A /org/service-qual/storage # set mincap 1000000

switch-A /org/service-qual/storage* # commit-buffer

switch-A /org/service-qual/storage #

Related Commands Command Description


show memory
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1267
Commands
set mincores

set mincores
To set the minimum number of cores, use the set mincores command.

set mincores {mincores| unspecified}

Syntax Description min-cores Minimum number of cores. The range of valid values is 0 to 65535.

unspecified Specifies an unspecified number of cores.

Command Default None

Command Modes Processor (/org/server-qual/processor)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the minimum number of processor cores.

Examples This example shows how to set the minimum number of cores:

switch-A# scope org org3

switch-A /org # scope server-qual squal10

switch-A /org/server-qual # scope processor

switch-A /org/server-qual/processor # set mincores 2

switch-A /org/server-qual/processor* # commit-buffer

switch-A /org/server-qual/processor #

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


1268 OL-25718-02
Commands
set min-interval

set min-interval
To set a minimum interval for a one-time or periodic maintenance window, use the set min-interval command.

set min-interval {none| hours minutes seconds}

Syntax Description none Use this option to not set an hour for the maintenance window.

hours Use this option to specify the number of hours for the maintenance window. The
value must be between 0 - 24.

minutes Use this option to specify the number of minutes for the maintenance window.
The value must be between 0 - 59.

seconds Use this option to specify the number of seconds for the maintenance window.

Command Default None

Command Modes One-time maintenance window (/system/scheduler/one-time)


Periodic maintenance window (/system/scheduler/periodic)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A scheduler policy and a maintenance window must be created to use this command.

Examples This example shows how to set a minimum interval for a one-time maintenance window.
Switch-A # scope system
Switch-A /system # scope scheduler default
Switch-A /system/scheduler # scope maint-window one-time Test
Switch-A /system/scheduler/one-time # set min-interval 1 22 30
Switch-A /system/scheduler/one-time* # commit-buffer
Switch-A /system/scheduler/one-time #

Related Commands Command Description


set concur-jobs
set date
set hour

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1269
Commands
set min-interval

Command Description
set max-duration
set proc-cap

Cisco UCS Manager CLI Command Reference, Release 2.0


1270 OL-25718-02
Commands
set minprocs

set minprocs
To set the minimum number of processors, use the set minprocs command.

set minprocs {min-procs| unspecified}

Syntax Description min-procs Minimum number of processors. The range of valid values is 0 to 65535.

unspecified Specifies an unspecified number of processors.

Command Default None

Command Modes Processor (/org/server-qual/processor)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the maximum number of processors:

switch-A# scope org org3

switch-A /org # scope server-qual squal10

switch-A /org/server-qual # scope processor

switch-A /org/server-qual/processor # set minprocs 1

switch-A /org/server-qual/processor* # commit-buffer

switch-A /org/server-qual/processor #

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1271
Commands
set minthreads

set minthreads
To set the minimum number of threads, use the set minthreads command.

set minthreads {min-threads| unspecified}

Syntax Description min-threads Minimum number of threads. The range of valid values is 0 to 65535.

unspecified Specifies an unspecified number of threads.

Command Default None

Command Modes Processor (/org/server-qual/processor)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the minimum number of threads:

switch-A# scope org org3

switch-A /org # scope server-qual squal10

switch-A /org/server-qual # scope processor

switch-A /org/server-qual/processor # set minthreads 1

switch-A /org/server-qual/processor* # commit-buffer

switch-A /org/server-qual/processor #

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


1272 OL-25718-02
Commands
set minute

set minute
To set a minute for the periodic maintenance window, use the set minute command.

set minute {minute| every-min}

Syntax Description minute To set a specific minute for the maintenance window. The range of valid values
is between 0 - 60.

every-min To set the maintenance window to run every minute.

Command Default None

Command Modes Periodic maintenance window (/system/scheduler/periodic)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A scheduler policy and a maintenance window must be created to use this command.

Examples This example shows how to set the minutes for the periodic maintenance window.
Switch-A # scope system
Switch-A /system # scope scheduler Default
Switch-A /system/scheduler # scope maint-window periodic Trial
Switch-A /system/scheduler/periodic # set minute 45
Switch-A /system/scheduler/periodic* # commit-buffer
Switch-A /system/scheduler/periodic #

Related Commands Command Description


set concur-jobs
set day
set hour
set max-duration
set min-interval
set proc-cap

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1273
Commands
set mode (eth-uplink)

set mode (eth-uplink)


To set the Ethernet switching mode, use the set mode command.

set mode {end-host| switch}

Syntax Description end-host Specifies end host Ethernet switching mode.

switch Specifies switch Ethernet switching mode.

Command Default None

Command Modes Ethernet uplink (/eth-uplink)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines The Ethernet switching mode determines how the switch behaves as a switching device between the servers.
End host mode allows the switch to act as an end host to the network, representing all server (hosts) connected
to it through vNICs and the network. Switch mode is the traditional Ethernet switching mode.

Examples This example shows how to set the Ethernet switching mode to end host mode:
switch-A# scope eth-uplink
switch-A /eth-uplink # set mode end-host
switch-A /eth-uplink* # commit-buffer
switch-A /eth-uplink #

Cisco UCS Manager CLI Command Reference, Release 2.0


1274 OL-25718-02
Commands
set mode (fc-uplink)

set mode (fc-uplink)


To set the Fibre Channel switching mode, use the set mode command.

set mode {end-host| switch}

Syntax Description end-host Specifies end host Fibre Channel switching mode.

switch Specifies switch Fibre Channel switching mode.

Command Default None

Command Modes Fibre Channel uplink (/fc-uplink)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The Fibre Channel switching mode determines how the switch behaves as a switching device between the
servers. End host mode allows the switch to act as an end host to the network, representing all server (hosts)
connected to it through vHBAs and the network. Switch mode is the traditional Fibre Channel switching
mode.

Examples This example shows how to set the Fibre Channel switching mode to end host mode:
switch-A# scope fc-uplink
switch-A /fc-uplink # set mode end-host
switch-A /fc-uplink* # commit-buffer
switch-A /fc-uplink #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1275
Commands
set mode (fw-pack)

set mode (fw-pack)


To set the firmware pack mode, use the set mode command.

set mode {one-shot| staged}

Syntax Description one-shot Specifies one shot.

staged Specifies staged.

Command Default None

Command Modes Firmware management pack (/org/fw-mgmt-pack)


Firmware host pack (/org/fw-host-pack)

Command History Release Modification


1.0(1) This command was introduced.

1.1(1) This command was removed.

Examples This example shows how to set the firmware pack mode:
switch-A# scope org /
switch-A /org # scope fw-host-pack Pack10
switch-A /org/fw-host-pack # set one-shot
switch-A /org/fw-host-pack* # commit-buffer
switch-A /org/fw-host-pack #

Cisco UCS Manager CLI Command Reference, Release 2.0


1276 OL-25718-02
Commands
set mode (local-disk)

set mode (local-disk)


To set the local disk policy mode, use the set mode command.

set mode {any-configuration| no-local-storage| no-raid| raid-0-striped| raid-1-mirrored|


raid-5-striped-parity| raid-6-striped-dual-parity| raid10-mirrored-and-striped}

Syntax Description any-configuration Specifies any configuration for the local disk.

no-local-storage Specifies no local storage.

no-raid Specifies no RAID configuration on the local disk.

raid-0-striped Specifies RAID 0 striping on the local disk.

raid-1-mirrored Specifies RAID 1 mirroring on the local disk.

raid-5-striped-parity Specifies RAID 5 striping with parity on the local disk.

raid-6-striped-dual-parity Specifies RAID 6 striping with dual parity on the local disk.

raid-10-mirrored-and-striped Specifies RAID 1 mirroring and striping on the local disk.

Command Default None

Command Modes Local disk configuration policy under organization (/org/local-disk-config-policy)


Local disk configuration under service profile (/org/service-profile/local-disk-config)

Command History Release Modification


1.0(1) This command was introduced.

1.3(1) The basic raid-mirrored and raid-striped keywords were removed and
more specific keywords were added.

Usage Guidelines The disk policy configures any optional SAS local drives that have been installed on a server through the
onboard RAID controller of the local drive. This policy enables you to set a local disk mode for all servers
that are associated with a service profile that includes the local disk configuration policy. The general disk
modes include the following:
• Any Configuration—For a server configuration that carries forward the local disk configuration without
any changes.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1277
Commands
set mode (local-disk)

• No Local Storage—For a diskless workstation or a SAN only configuration. If you select this option,
you cannot associate any service profile which uses this policy with a server that has a local disk.
• No RAID—For a server configuration that removes the RAID and leaves the disk MBR and payload
unaltered.
• RAID Mirrored—For a 2-disk RAID 1 server configuration.
• RAID Striped—For a 2-disk RAID 0 server configuration.

You must include this policy in a service profile, and that service profile must be associated with a server for
it to take effect.

Examples This example shows how to set the local disk configuration mode:
switch-A# scope org org10
switch-A /org # enter local-disk-config-policy DiskPolicy12
switch-A /org/local-disk-config-policy* # set mode raid-5-striped-parity
switch-A /org/local-disk-config-policy* # commit-buffer
switch-A /org/local-disk-config-policy #

Cisco UCS Manager CLI Command Reference, Release 2.0


1278 OL-25718-02
Commands
set model-regex

set model-regex
To filter model information with a regular expression, use the set model-regex command.

set model-regex regex

Syntax Description regex A regular expression of up to 256 characters.

Command Default None

Command Modes Adapter capacity qualification (org/server-qual/adapter/cap-qual)


CPU qualification (/org/server-qual/cpu)
Processor qualification (/org/server-qual/processor)

Command History Release Modification


1.0(1) This command was introduced.

1.3(1) The processor qualification mode was replaced by the CPU qualification
mode.

Usage Guidelines Use this command to implement a server pool qualification filter. You can filter adapter or CPU model
information with a regular expression that is compatible with the Perl language.

Examples The following example shows how to create a server pool qualification filter to select only Intel 2.27GHz
processors:
switch-A# scope org org120
switch-A /org # scope server-qual sq20
switch-A /org/server-qual # create cpu
switch-A /org/server-qual/cpu* # set model-regex Intel.*2.27GHz
switch-A /org/server-qual/cpu* # commit-buffer
switch-A /org/server-qual/cpu #

Related Commands Command Description


show cap-qual
show cpu

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1279
Commands
set module

set module
To specify the management logging threshold for a specific module, use the set module command.

set module module-name {crit| major| minor| warn| info| debug4| debug3| debug2| debug1| debug0}

Syntax Description module-name Name of a specific module

crit Critical (highest) level

major Major level

minor Minor level

warn Warning level

info Informational level

debug4 Debug 4 level

debug3 Debug 3 level

debug2 Debug 2 level

debug1 Debug 1 level

debug0 Debug 0 (lowest) level

Command Default The default management logging threshold is info.

Command Modes Management logging (/monitoring/sysdebug/mgmt-logging)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the management logging threshold for a specific module. The threshold options
are listed in order of decreasing urgency in the Syntax Description.

Cisco UCS Manager CLI Command Reference, Release 2.0


1280 OL-25718-02
Commands
set module

Examples This example shows how to specify the management logging threshold to major for a specific module:
switch-A# scope monitoring
switch-A /monitoring # scope sysdebug
switch-A /monitoring/sysdebug # scope mgmt-logging
switch-A /monitoring/sysdebug/mgmt-logging # set module test13 major
switch-A /monitoring/sysdebug/mgmt-logging* # commit-buffer
switch-A /monitoring/sysdebug/mgmt-logging #

Related Commands Command Description


show (mgmt-logging)

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1281
Commands
set modulus

set modulus
To select the key length in a keyring, use the set modulus command.

set modulus {mod1024| mod1536| mod2048| mod512}

Syntax Description mod1024 The key size is 1024 bits.

mod1536 The key size is 1536 bits.

mod2048 The key size is 2048 bits.

mod512 The key size is 512 bits.

Command Default The key size is 1024 bits.

Command Modes Keyring (/security/keyring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to select a key length in a keyring.

Examples This example shows how to select a key length of 1536 bits in a keyring:
switch-A# scope security
switch-A /security # scope keyring MyKR05
switch-A /security/keyring # set modulus mod1536
switch-A /security/keyring* # commit-buffer
switch-A /security/keyring #

Related Commands Command Description


show keyring

Cisco UCS Manager CLI Command Reference, Release 2.0


1282 OL-25718-02
Commands
set mtu

set mtu
To set an Maximum Transmission Unit (MTU), use the set mtu command.

set mtu {mtu| fc| normal}

Syntax Description mtu MTU. The range of valid values is 1538 to 9216.

fc Specifies Fibre Channel MTU.

normal Specifies normal MTU.

Command Default None

Command Modes Ethernet classified (/eth-server/qos/eth-classified)


Ethernet default (/eth-server/qos/eth-default)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set an MTU:

switch-A# scope eth-server

switch-A /eth-server # scope qos

switch-A /eth-server/qos # scope eth-classified

switch-A /eth-server/qos/eth-classified # set mtu fc

switch-A /eth-server/qos/eth-classified* # commit-buffer

switch-A /eth-server/qos/eth-classified #

Related Commands Command Description


show eth-best-effort
show eth-classified

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1283
Commands
set mtu (eth-best-effort)

set mtu (eth-best-effort)


To set the MTU (Maximum Transmission Unit), use the set mtu command.

set mtu {mtu| fc| normal}

Syntax Description mtu Specifies an MTU in bytes. The range is 1538 to 9216.

fc Specifies Fibre Channel MTU.

normal Specifies normal MTU.

Command Default None

Command Modes Ethernet best effort (/eth-server/qos/eth-best-effort)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Following are the MTU settings for fc and normal :
• fc —2240 octets or bytes
• normal —1528 octets or bytes

Examples This example shows how to set the MTU:


switch-A# scope eth-server
switch-A /eth-server # scope qos
switch-A /eth-server/qos # scope eth-best-effort
switch-A /eth-server/qos/eth-best-effort # set mtu fc
switch-A /eth-server/qos/eth-best-effort* # commit-buffer
switch-A /eth-server/qos/eth-best-effort #

Related Commands Command Description


show eth-best-effort
show eth-classified

Cisco UCS Manager CLI Command Reference, Release 2.0


1284 OL-25718-02
Commands
set mtu (vnic)

set mtu (vnic)


To set the MTU of a vNIC, use the set mtu command.

set mtu mtu

Syntax Description mtu The MTU. The range of valid values is 1500 to 9000.

Command Default The vNIC MTU is 1500.

Command Modes Virtual NIC service profile (/org/service-profile/vnic)


Virtual NIC template (/org/vnic-templ)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to set the MTU (Maximum Transmission Unit) of a vNIC (virtual network interface card).

Examples This example shows how to set the MTU for a vNIC:
switch-A# scope org org10
switch-A /org # scope vnic-templ sp10
switch-A /org/vnic-templ # set mtu 9000
switch-A /org/vnic-templ* # commit-buffer
switch-A /org/vnic-templ #

Related Commands Command Description


show vnic
show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1285
Commands
set multicast-optimize

set multicast-optimize
To optimize the class for sending multicast packets, use the set multicast-optimize command.

set multicast-optimize {no | yes}

Syntax Description no The class is not optimized for sending multicast packets.

yes The class is optimized for sending multicast packets.

Command Default None

Command Modes Ethernet classified (/eth-server/qos/eth-classified)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to optimize the class for sending multicast packets.

Examples This example shows how to optimize the QoS bronze class for sending multicast packets:
switch-A# scope eth-server
switch-A /eth-server # scope qos
switch-A /eth-server/qos # scope eth-classified bronze
switch-A /eth-server/qos/eth-classified # set multicast optimize yes
switch-A /eth-server/qos/eth-classified* # commit-buffer
switch-A /eth-server/qos/eth-classified #

Related Commands Command Description


show eth-classified

Cisco UCS Manager CLI Command Reference, Release 2.0


1286 OL-25718-02
Commands
set multicastoptimize (eth-best-effort)

set multicastoptimize (eth-best-effort)


To set multicast optimize, use the set multicastoptimize command in eth-best-effort mode.

set multicastoptimize {no | yes}

Syntax Description no Sets multicast optimize to disabled.

yes Sets multicast optimize to enabled.

Command Default None

Command Modes Ethernet classified (/eth-server/qos/eth-best-effort)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to enable multicast optimize:

switch-A# scope eth-server

switch-A /eth-server # scope qos

switch-A /eth-server/qos # scope eth-best-effort

switch-A /eth-server/qos/eth-eth-best-effort # set multicastoptimize yes

switch-A /eth-server/qos/eth-eth-best-effort* # commit-buffer

switch-A /eth-server/qos/eth-best-effort #

Related Commands Command Description


show eth-best-effort
show eth-classified

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1287
Commands
set name

set name
To set name, use the set name command.

set name name

Syntax Description name Name. The range of valid values is 1 to 16.

Command Default None

Command Modes Port channel (/eth-uplink/fabric/port-channel)


Server (/chassis/server)
System (/system)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was introduced in the Server (/chassis/server) and System
(/system) mode.

Examples This example shows how to set a name:

switch-A# scope eth-uplink

switch-A /eth-uplink # scope fabric a

switch-A /eth-uplink/fabric # scope port-channel 10

switch-A /eth-uplink/fabric/port-channel # set name pc10

switch-A /eth-uplink/fabric/port-channel* # commit-buffer

switch-A /eth-uplink/fabric/port-channel #

Related Commands Command Description


show member-port
show port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


1288 OL-25718-02
Commands
set native

set native
To set the VLAN as the native VLAN, use the set native command.

set native {no| yes}

Syntax Description no Specifies that the current VLAN is not the native VLAN.

yes Specifies that the current VLAN is the native VLAN.

Command Default None

Command Modes Ethernet uplink fabric VLAN (/eth-uplink/fabric/vlan)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to set the VLAN as the native VLAN.

Note Only one VLAN can exist as the native VLAN. If you set multiple VLANs as the native VLAN, the last
one to be set becomes the native VLAN.

Examples This example sets the current VLAN as the native VLAN:
switch-A# scope eth-uplink
switch-A /eth-uplink # scope fabric a
switch-A /eth-uplink/fabric # create vlan finance 3955
switch-A /eth-uplink/fabric/vlan* # set native
switch-A /eth-uplink/fabric/vlan* # commit-buffer
switch-A /eth-uplink/fabric/vlan #

Related Commands Command Description


show vlan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1289
Commands
set no-change-interval

set no-change-interval
To set a time interval during which users cannot modify their password, use the set no-change-interval
command.

set no-change-interval no-change-interval

Syntax Description no-change-interval Time, in hours, during which the password cannot be changed. The value
must be between 1 and 745.

Command Default None

Command Modes Password profile (/security/password-profile)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must be an administrator user or have aaa privileges to use this command.
The value must be lower than the value set for the set change-during-interval command.

Examples This example shows how to set the time duration during which a password cannot be modified to 40 hours:
UCS-A # scope security
UCS-A /security # scope password-profile
UCS-A /security/password-profile # set no-change-interval 40
UCS-A /security/password-profile* # commit-buffer
UCS-A /security/password-profile #

Related Commands Command Description


set change-count

set change-during-interval

set change-interval

set history-count

Cisco UCS Manager CLI Command Reference, Release 2.0


1290 OL-25718-02
Commands
set normal-value

set normal-value
To set a value for a property, use the set normal-value command.

set normal-value value

Syntax Description value The value of a property in a class. The range of valid values is 0 to
9223372036854775807.

Command Default None

Command Modes Ethernet uplink (/eth-uplink/stats-threshold-policy/class/property)


Fibre channel (/fc-uplink/stats-threshold-policy/class/property)
Ethernet server (/eth-server/stats-threshold-policy/class/property)
Organization (/org/stats-threshold-policy/class/property)

Command History Release Modification


1.0 This command was introduced.

Usage Guidelines You must have a class and a property created in order to execute the set normal-value command. The
command is used to set the value of the property you created.

Examples The following example shows how to set a value for the bytes-rx-delta property in fc-stats class:
switch-A#scope fc-uplink
switch-A /fc-uplink # scope stats-threshold-policy stp100

switch-A /fc-uplink/stats-threshold-policy # scope class fc-stats


switch-A /fc-uplink/stats-threshold-policy/class # scope property bytes-rx-delta
switch-A /fc-uplink/stats-threshold-policy/class/property # set normal-value 100000
switch-A /fc-uplink/stats-threshold-policy/class/property* # commit-buffer
switch-A /fc-uplink/stats-threshold-policy/class/property #

Related Commands Command Description


show class
show property

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1291
Commands
set notificationtype

set notificationtype
To set a notification method for the SNMP traps, use the set notificationtype command.

set notificationtype {informs| traps}

Syntax Description informs Use this option to configure SNMP to inform all notifications.

traps Use this option to configure SNMP to trap all notifications.

Command Default None

Command Modes SNMP Traps (/monitoring/snmp-trap)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An SNMP trap must be configured to use this command.

Examples This example shows how to set the notification to traps.


Switch-A # scope monitoring
Switch-A /monitoring # scope snmp-trap 10.10.10.10
Switch-A /monitoring/snmp-trap # set notificationtype traps
Switch-A /monitoring/snmp-trap* # commit-buffer
Switch-A /monitoring/snmp-trap #

Related Commands Command Description


create snmp-trap
create snmp-user

Cisco UCS Manager CLI Command Reference, Release 2.0


1292 OL-25718-02
Commands
set numa-config

set numa-config
To specify whether the BIOS supports NUMA, use the set numa-config command.

set numa-config numa-optimization {disabled| enabled| platform-default}

Syntax Description disabled The BIOS does not support NUMA.

enabled The BIOS supports NUMA.

platform-default The BIOS uses the value for this attribute contained in the BIOS defaults
for the server type and vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Use this command to specify whether the BIOS includes the ACPI tables that are required for operating
systems that support Non-Uniform Memory Access (NUMA). If you enable this option, the system must
disable Inter-Socket Memory interleaving on some platforms.

Examples The following example shows how to create a BIOS policy specifying that NUMA is supported:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set numa-config numa-optimization enabled
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1293
Commands
set numberofblocks

set numberofblocks
To set the number of blocks, use the set numberofblocks command.

set numberofblocks {number| unspecified}

Syntax Description number Number of storage blocks. The range of valid values is 0 to
9223372036854775807.

unspecified Specifies an unspecified number of blocks.

Command Default None

Command Modes Storage (/org/server-qual/storage)

Command History Release Modification


1.0(1) This command was introduced.

Examples The following example shows how to set the number of blocks:

switch-A# scope org org120

switch-A /org # scope server-qual sq20

switch-A /org/server-qual # scope storage

switch-A /org/server-qual/storage # set numberofblocks 100000

switch-A /org/server-qual/storage* # commit-buffer

switch-A /org/server-qual/storage #

Related Commands Command Description


show memory
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


1294 OL-25718-02
Commands
set nw-control-policy

set nw-control-policy
To set a network control policy name , use the set nw-control-policy command.

set nw-control-policy policy-name

Syntax Description policy-name The name of the policy. The range of valid values is 1 to 16.

Command Default None

Command Modes vNIC (/org/service-profile/vnic)


Port channel within Ethernet storage (/eth-storage/fabric/port-channel)
Fabric interface within Ethernet storage (/eth-storage/fabric/interface)

Command History Release Modification


1.1(1) This command was introduced.

2.0(1) This command was introduced in the Ethernet storage command mode.

Examples This example shows how to set a network control policy name:
UCS-A# scope org org3
UCS-A /org # scope service-profile sp3
UCS-A /org/service-profile # scope vnic vnic3
UCS-A /org/service-profile/vnic # set nw-control-policy ncp3
UCS-A /org/service-profile/vnic* # commit-buffer
UCS-A /org/service-profile/vnic #

Related Commands Command Description


show eth-if
show service-profile
show nw-control-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1295
Commands
set offload large-receive

set offload large-receive


To enable or disable offloading of large packet reassembly, use the set offload large-receive command.

set offload large-receive {disabled| enabled}

Syntax Description disabled The CPU processes all large packets.

enabled The hardware reassembles all segmented packets before sending them to
the CPU.

Command Default Enabled

Command Modes Ethernet adapter policy (/org/eth-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enable or disable offloading of large packet reassembly. Enabling this option may reduce
CPU utilization and increase inbound throughput.

Examples This example shows how to enable the offloading of large packet reassembly:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set offload large-receive enabled
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


show eth-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1296 OL-25718-02
Commands
set offload tcp-rx-checksum

set offload tcp-rx-checksum


To enable or disable the offloading of packet checksum validation, use the set offload tcp-rx-checksum
command.

set offload tcp-rx-checksum {disabled| enabled}

Syntax Description disabled The CPU validates all packet checksums.

enabled The CPU sends all packet checksums to the hardware for validation.

Command Default Enabled

Command Modes Ethernet adapter policy (/org/eth-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enable or disable the offloading of packet checksum validation. Enabling this option
may reduce CPU utilization.

Examples This example shows how to enable the offloading of packet checksum validation:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set offload tcp-rx-checksum enabled
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


show eth-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1297
Commands
set offload tcp-segment

set offload tcp-segment


To enable or disable the offloading of large TCP packet segmentation, use the set offload tcp-segment
command.

set offload tcp-segment {disabled| enabled}

Syntax Description disabled The CPU segments large TCP packets.

enabled The CPU sends large TCP packets to the hardware to be segmented.

Command Default Enabled

Command Modes Ethernet adapter policy (/org/eth-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enable or disable the offloading of large TCP packet segmentation. Enabling this option
may reduce CPU overhead and increase throughput rate.

Examples This example shows how to enable the offloading of large TCP packet segmentation:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set offload tcp-segment enabled
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


show eth-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1298 OL-25718-02
Commands
set offload tcp-tx-checksum

set offload tcp-tx-checksum


To enable or disable the offloading of transmit checksum calculations, use the set offload tcp-tx-checksum
command.

set offload tcp-tx-checksum {disabled| enabled}

Syntax Description disabled The CPU calculates all packet checksums.

enabled The CPU sends all packets to the hardware so that the checksum can be
calculated.

Command Default Enabled

Command Modes Ethernet adapter policy (/org/eth-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enable or disable the offloading of transmit checksum calculations. Enabling this option
may reduce CPU overhead.

Examples This example shows how to enable the offloading of transmit checksum calculations:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set offload tcp-tx-checksum enabled
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


show eth-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1299
Commands
set onboard-scu-storage-support

set onboard-scu-storage-support
To set the onboard SCU storage support for a BIOS policy, use the set onboard-scu-storage-support command.

set onboard-scu-storage-support {enabled | disabled | platform-default}

Syntax Description enabled Enables onboard SCU storage support for the BIOS policy.

disabled Disables onboard SCU storage support for the BIOS policy.

platform-default Sets the onboard SCU storage support to the platform default option.

Command Default By default, this option is to platform default.

Command Modes BIOS Policy (/org/bios-policy)

Command History Release Modification


2.0(3) This command was introduced.

Usage Guidelines A BIOS policy must be created to use this command.

Examples This example shows how to disable the onboard SCU storage support option for a BIOS policy.
UCS-A # scope org
UCS-A /org # scope bios-policy sample
UCS-A /org/bios-policy # set onboard-scu-storage-support disable
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


create bios-policy

show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1300 OL-25718-02
Commands
set order (device boot order)

set order (device boot order)


To set the boot order for a device, use the set order command in lan, storage, and vmedia modes.

set order {1 | 2 | 3 | 4}

Syntax Description 1 Specifies first in the boot order.

2 Specifies second in the boot order.

3 Specifies third in the boot order.

4 Specifies fourth in the boot order.

Command Default None

Command Modes LAN (/org/boot-policy/lan)


Storage (/org/boot-policy/storage)
Virtual media (/org/boot-policy/virtual-media)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the LAN boot order:
switch-A# scope org org3
switch-A /org # scope boot-policy bp3
switch-A /org/service-profile # scope lan

switch-A /org/service-profile/vhba # set order 1


switch-A /org/service-profile/vhba* # commit-buffer
switch-A /org/service-profile/vhba #

Related Commands Command Description


show lan
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1301
Commands
set order (vhba pci scan order)

set order (vhba pci scan order)


To set the PCI scan order for a vHBA, use the set order command in vhba mode.

set order {order| unspecified}

Syntax Description order The order. The range of valid values is 0 to 99.

unspecified Specifies that the order is unspecified.

Command Default None

Command Modes Virtual HBA (/org/service-profile/vhba)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the PCI scan order:
switch-A# scope org org10

switch-A /org # scope service-profile sp2

switch-A /org/service-profile # scope vhba vhba1

switch-A /org/service-profile/vhba # set order 1

switch-A /org/service-profile/vhba* # commit-buffer

Related Commands Command Description


show service-profile
show vhba

Cisco UCS Manager CLI Command Reference, Release 2.0


1302 OL-25718-02
Commands
set order (vnic relative order)

set order (vnic relative order)


To set the relative order for a vNIC, use the set order command.

set order {order| unspecified}

Syntax Description order The order. The range of valid values is 0 to 99.

unspecified Specifies that the order is unspecified.

Command Default None

Command Modes Virtual NIC (/org/service-profile/vnic)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the relative order:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # scope vnic vnic1

switch-A /org/service-profile/vnic # set order 1

switch-A /org/service-profile/vnic* # commit-buffer

switch-A /org/service-profile/vnic #

Related Commands Command Description


show service-profile
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1303
Commands
set org-unit-name

set org-unit-name
To specify the name of the organizational unit requesting the certificate, use the set org-unit-name command.

set org-unit-name Organizational unit name

Syntax Description Organizational unit name The name of the organizational unit requesting the certificate. The name
can include a maximum of 64 characters and can be alphanumeric.

Command Default None

Command Modes Certificate Request (/security/keyring/certreq)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines You should create a certificate request before specifying the organizational unit details.

Examples The following example shows how to set the organizational unit information for a certificate request.
UCS-A # scope security
UCS-A /security # scope keyring test
UCS-A /security/keyring # create certreq
UCS-A /security/keyring/certreq* # set org-unit-name Testing
UCS-A /security/keyring/certreq* # commit buffer
UCS-A /security/keyring/certreq #

Related Commands Command Description


set country

set dns

set e-mail

set ip

set locality

set org-name

set state

Cisco UCS Manager CLI Command Reference, Release 2.0


1304 OL-25718-02
Commands
set org-unit-name

Command Description
set subject-name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1305
Commands
set org-name

set org-name
To specify the name of the organization requesting the certificate, use the set org-name command.

set org-name Organization name

Syntax Description Organization name The name of the organization requesting the certificate. The name can include
a maximum of 64 characters and can be alphanumeric.

Command Default None

Command Modes Certificate Request (/security/keyring/certreq)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines You should create a certificate request before specifying the organization details.

Examples The following example shows how to set the organization information for a certificate request.
UCS-A # scope security
UCS-A /security # scope keyring test
UCS-A /security/keyring # create certreq
UCS-A /security/keyring/certreq* # set org-name Cisco
UCS-A /security/keyring/certreq* # commit buffer
UCS-A /security/keyring/certreq #

Related Commands Command Description


set country

set dns

set e-mail

set ip

set locality

set org-unit-name

set state

Cisco UCS Manager CLI Command Reference, Release 2.0


1306 OL-25718-02
Commands
set org-name

Command Description
set subject-name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1307
Commands
set out-of-band

set out-of-band
To configure out-of-band access to a fabric interconnect, use the set out-of-band command.

set out-of-band {ip oob-ip| netmask oob-netmask| gw oob-gw}+

Syntax Description ip oob-ip Specifies the IP address for out-of-band access.

netmask oob-netmask Specifies the IP netmask for out-of-band access.

gw oob-gw Specifies the IP gateway address for out-of-band access.

Command Default None

Command Modes Fabric interconnect (/fabric-interconnect)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure out-of-band access to a fabric interconnect.

Note Changing the out-of-band access configuration may disconnect the current CLI session.

Examples This example shows how to configure out-of-band access for fabric A:
switch-A# scope fabric-interconnect a
switch-A /fabric-interconnect # set out-of-band ip 192.20.1.28
Warning: When committed, this change may disconnect the current CLI session
switch-A /fabric-interconnect* # set out-of-band netmask 255.255.248.0
Warning: When committed, this change may disconnect the current CLI session
switch-A /fabric-interconnect* # set out-of-band gw 192.20.1.1
Warning: When committed, this change may disconnect the current CLI session
switch-A /fabric-interconnect* # commit-buffer
switch-A /fabric-interconnect #

Related Commands Command Description


show fabric-interconnect

Cisco UCS Manager CLI Command Reference, Release 2.0


1308 OL-25718-02
Commands
set overlay-vnic-name

set overlay-vnic-name
To set an overlay VNIC name for the iSCSI VNIC, use the set overlay-vnic-name command.

set overlay-vnic-name overlay-vnic-name

Syntax Description overlay-vnic-name Name of the overlay VNIC. The name can include a maximum of 16
alphanumeric characters.

Command Default None

Command Modes iSCSI VNIC (/org/service-profile/vnic-iscsi)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a service profile and an iSCSI VNIC for the service profile before you use this command.

Examples This example shows how to set the overlay name for an iSCSI VNIC:
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # set overlay-vnic-name Testing
UCS-A /org/service-profile/vnic-iscsi* # commit-buffer
UCS-A /org/service-profile/vnic-iscsi #

Related Commands Command Description


set auth-name

set identity

set iscsi-adaptor-policy

set iscsi-identity

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1309
Commands
set password

set password
To set up a password, use the set password command.

set password

This command has no arguments or keywords.

Command Default None

Command Modes IPMI user (/org/ipmi-access-profile/ipmi-user)


Backup (/system/backup)
Import configuration (/system/import-config)
Local user (/security/local-user)
Security (/security)
Download task (/firmware/download-task)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines The password must be a minimum of eight characters.


After entering the set password command, you are prompted to enter and confirm the password. For security
purposes, the password that you type does not appear in the CLI.

Examples This example shows how to set up a password for the security command mode:

switch-A#scope security

switch-A /security # set password

Enter the password:


Confirm the password:
switch-A /security* # commit-buffer

switch-A /security #

Related Commands Command Description


set password (auth-profile)

set password (snmp-user)

Cisco UCS Manager CLI Command Reference, Release 2.0


1310 OL-25718-02
Commands
set password

Command Description
show local-user
show remote-user

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1311
Commands
set password (auth-profile)

set password (auth-profile)


To set a password for a user associated with an iSCSI authentication profile, use the set password command.

set password

This command has no arguments or keywords.

Command Default None

Command Modes iSCSI Authentication Profile (/org/iscsi-auth-profile)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines An iSCSI authentication profile and a user ID for the profile must be created to use this command.

Examples This example shows how to set the password for a user ID associated with an ISCSI authentication profile.
UCS-A # scope org test
UCS-A /org # create auth-profile sample
UCS-A /org/auth-profile* # set user-id exampleuser
UCS-A /org/auth-profile* # set password
Enter password:
Confirm password:
UCS-A /org/auth-profile* # commit-buffer
UCS-A /org/auth-profile #

Related Commands Command Description


create auth-profile

set user-id

Cisco UCS Manager CLI Command Reference, Release 2.0


1312 OL-25718-02
Commands
set password (snmp-user)

set password (snmp-user)


To set up a SNMPv3 password, use the set password command in snmp-user mode.

set password

This command has no arguments or keywords.

Command Default None

Command Modes SNMP user (/monitoring/snmp-user)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Password must be a minimum 8 characters.


No text appears when you enter your password at the Enter a password: prompt or the Confirm the
password: prompt. This is default behavior and cannot be changed.

Examples This example shows how to set up a SNMPv3 password:

switch-A# scope monitoring

switch /monitoring # scope snmp-user SU10

switch /monitoring/snmp-user # set password

Enter a password:
Confirm the password:
switch /monitoring/snmp-user* # commit-buffer

switch /monitoring/snmp-user #

Related Commands Command Description


show snmp
show snmp-user

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1313
Commands
set path

set path
To specify the absolute path to the file on the remote server, use the set path command.

set path path

Syntax Description path Sspecifies the absolute path to the file on the remote server.

Command Default None

Command Modes Firmware download task (/firmware/download-task)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the absolute path to the file on the remote server.
If you use SCP as the file transfer protocol, the absolute path is always required. If you use any other protocol,
you may not need to specify a remote path if the file resides in the default download folder.

Examples This example shows how to specify the remote server path in which the firmware download file resides:
switch-A# scope firmware
switch-A /firmware # scope download-task ucs-k9-bundle.1.1.0.279.bin
switch-A /firmware/download-task # set path /firmware/bin/1.1
switch-A /firmware/download-task #

Related Commands Command Description


show download-task

Cisco UCS Manager CLI Command Reference, Release 2.0


1314 OL-25718-02
Commands
set peak

set peak
To set a peak for a power group, use the set peak command.

set peak {peak| unbounded}

Syntax Description peak Use this option to set a peak for the power group. The value must be a numeral.

unbounded Use this option to not set a peak for the power group.

Command Default None

Command Modes Power group (/power-cap-mgmt/power-group)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A power group must be created to use this command.

Examples This example shows how to set a peak for a power group.
Switch-A # scope power-cap-mgmt
Switch-A /power-cap-mgmt # scope power-group testing
Switch-A /power-cap-mgmt/power-group # set peak 5
Switch-A /power-cap-mgmt/power-group* # commit-buffer
Switch-A /power-cap-mgmt/power-group #

Related Commands Command Description


create power-group
set realloc

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1315
Commands
set per-user

set per-user
To set a maximum number of HTTP and HTTPS sessions allowed for each user, use the set per-user command.

set per-user max sessions per user

Syntax Description max sessions per user The maximum number of HTTP and HTTPS sessions allowed for a user.
The value must be a number between 1 and 256.

Command Default By default, the value of maximum allowed sessions for each user is set to 32.

Command Modes Web Session Limits (/system/services/web-session-limits)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The maximum number of allowed sessions must be a number between 1 and 256.

Examples This example shows how to set the maximum allowed number of sessions per user to 250.
Switch-A # scope system
Switch-A /system # scope services
Switch-A /system/services # scope web-session-limits
Switch-A /system/services/web-session-limits # set per-user 250
Switch-A /system/services/web-session-limits* # commit-buffer
Switch-A /system/services/web-session-limits #

Related Commands Command Description


scope web-session-limits

set total

Cisco UCS Manager CLI Command Reference, Release 2.0


1316 OL-25718-02
Commands
set perdiskcap

set perdiskcap
To set per-disk capacity, use the set perdiskcap command.

set perdiskcap {number| unspecified}

Syntax Description number Capacity number. The range of valid values is 0 to 9223372036854775807.

unspecified Specifies an unspecified amount of capacity.

Command Default None

Command Modes Storage (/org/server-qual/storage)

Command History Release Modification


1.0(1) This command was introduced.

Examples The following example shows how to set the per-disk capacity:

switch-A# scope org org120

switch-A /org # scope server-qual sq20

switch-A /org/server-qual # scope storage

switch-A /org/server-qual/storage # set perdiskcap 110000

switch-A /org/server-qual/storage* # commit-buffer

switch-A /org/server-qual/storage #

Related Commands Command Description


show memory
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1317
Commands
set pers-bind

set pers-bind
To disable or enable persistent binding, use the set pers-bind command.

set pers-bind {disabled| enabled}

Syntax Description disabled Specifies binding disabled.

enabled Specifies binding enabled.

Command Default Persistent binding is disabled.

Command Modes Virtual HBA (/org/service-profile/vhba)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to disable or enable persistent binding to Fibre Channel targets.

Examples This example shows how to disable or enable persistent binding:


switch-A# scope org org30a
switch-A /org # scope service-profile sp101
switch-A /org/service-profile # scope vhba vhba17
switch-A /org/service-profile/vhba # set pers-bind enabled
switch-A /org/service-profile/vhba* # commit-buffer
switch-A /org/service-profile/vhba #

Related Commands Command Description


show vhba
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


1318 OL-25718-02
Commands
set phone

set phone
To set the phone user name, use the set phone command.

set phone name

Syntax Description name Name of the user. The range of valid values is 1 to 512.

Command Default None

Command Modes Local user (/security/local-user)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the phone user name:

switch-A# scope security

switch-A /security # scope local-user admin10

switch-A /security/local-user # set phone admin10

switch-A /security/local-user* # commit-buffer

switch-A /security/local-user #

Related Commands Command Description


show local-user
show user-sessions

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1319
Commands
set phone-contact

set phone-contact
To configure a primary contact phone number for the customer organization, use the set phone-contact
command.

set phone-contact phone-contact

Syntax Description phone-contact Phone number.

Command Default None.

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to configure a primary contact phone number to be included in Call Home messages. Enter
up to 512 characters.

Examples This example shows how to configure a primary contact phone number:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set phone-contact +1-011-408-555-1212
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


1320 OL-25718-02
Commands
set pid-regex

set pid-regex
To set a PID regular expression (regex), use the set pid-regex command.

setpid-regexpid-regex

Syntax Description pid-regex The PID regular expression. It can include a maximum of 256 characters and
can be alphanumeric.

Command Default None

Command Modes Physical Qualification (/org/server-qual/physical-qual)


Adapter Capacity Qualification (/org/server-qual/adapter/cap-qual)
CPU (/org/server-qual/cpu)

Command History Release Modification


1.0(1) This command was introduced.

1.3(1) The processor qualification mode was replaced by the CPU qualification
mode.

Usage Guidelines You must create a server qualification and a physical qualification before you use this command in the Physical
Qualification command mode.
You must create an adapter qualification and an adapter capacity qualification in the Server Qualification
command mode before you use this command.

Examples This example shows how to set the PID regex for a physical qualification:
UCS-A # scope org org100
UCS-A /org # scope server-qual sample
UCS-A /org/server-qual # scope physical-qual
UCS-A /org/server-qual/physical-qual # set pid-regex Trial123
UCS-A /org/server-qual/physical-qual* # commit-buffer
UCS-A /org/server-qual/physical-qual #

Related Commands Command Description


show physical-qual

show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1321
Commands
set pid-regex

Command Description
show cap-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


1322 OL-25718-02
Commands
set pin-group

set pin-group
To set the pin group, use the set pin-group command.

set pin-group name

Syntax Description name Pin group name. The name can contain 1 to 16 characters.

Command Default None

Command Modes Dynamic connection policy (/org/dynamic-conn-policy)


Hypervisor connectivity (/org/service-profile/hv-conn)
Virtual HBA (/org/service-profile/vhba)
Virtual HBA template (/org/vhba-templ)
Virtual NIC (/org/service-profile/vnic)
Virtual NIC template (/org/vnic-templ)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the pin group to use for the vNIC.

Examples This example shows how to set the pin group:


switch-A# scope org org10
switch-A /org # scope service-profile sp10
switch-A /org/service-profile # scope vnic vnic20
switch-A /org/service-profile/vnic # set pin-group pg1
switch-A /org/service-profile/vnic* # commit-buffer
switch-A /org/service-profile/vnic #

Related Commands Command Description


show eth-if
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1323
Commands
set pingroupname

set pingroupname
To set a pin group name for the fabric interface, use the set pingroupname command.

set pingroupname pin group name

Syntax Description pin group name The name of the pin group name.

Command Default None

Command Modes Interface (/eth-storage/fabric/interface)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An interface for the fabric must be created to use this command.
The name of the pin group for the interface can be alphanumeric and can include special characters.

Examples This example shows how to set the pin group name for the fabric interface
Switch-A # scope eth-storage
Switch-A /eth-storage # scope fabric b
Switch-A /eth-storage/fabric # scope interface 2 3
Switch-A /eth-storage/fabric/interface # set pingroupname sample
Switch-A /eth-storage/fabric/interface* # commit-buffer

Related Commands Command Description


set adminspeed
set portmode
set prio
set user-label

Cisco UCS Manager CLI Command Reference, Release 2.0


1324 OL-25718-02
Commands
set pool

set pool
To set a pool, use the set pool command.

set pool name

Syntax Description name Pool name. The range of valid values is 1 to

Command Default None

Command Modes Pooling policy (/org/pooling-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to add a pool to your pooling policy. Only one pool can be set for each pooling policy.

Examples This example shows how to set a pool:

switch-A# scope org org3

switch-A /org # scope pooling-policy pp100

switch-A /org/pooling-policy # set pool pool100

switch-A /org/pooling-policy* # commit-buffer

switch-A /org/pooling-policy #

Related Commands Command Description


show mac-pool
show pooling-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1325
Commands
set port

set port
To set the port number, use the set port command.

set port number

Syntax Description number Port number. The range of valid values is 1 to 65535.

Command Modes Callhome (/monitoring/callhome)


SNMP trap (/monitoring/snmp-trap)
Server under LDAP (/security/ldap/server)
Server under TACACS (/security/tacacs/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines In Call Home configuration, use this command to specify the port used to communicate with the SMTP server.
The default SMTP port number is 25.
In LDAP configuration, use this command to specify the port used to communicate with the LDAP server.
The default LDAP server port number is 389.

Examples This example shows how to set the SMTP server port number in the Call Home configuration:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set port 25
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #
This example shows how to set the LDAP server port number in the LDAP configuration:
switch-A#scope security
switch-A /security # scope ldap
switch-A /security/ldap # scope server s100
switch-A /security/ldap/server # set port 100
switch-A /security/ldap/server* # commit-buffer
switch-A /security/ldap/server #

Related Commands Command Description


show callhome
show ldap

Cisco UCS Manager CLI Command Reference, Release 2.0


1326 OL-25718-02
Commands
set port

Command Description
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1327
Commands
set port io-throttle-count

set port io-throttle-count


To specify the number of IO operations that can be pending in the vHBA at one time, use the set port
io-throttle-count command.

set port io-throttle-count io-throttle-count

Syntax Description io-throttle-count The range is 256 to 4096; the default is 512;

Command Default Up to 16 pending IO operations are supported.

Command Modes Fibre Channel policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the number of IO operations that can be pending in the vHBA at one time.

Examples This example shows how to specify a limit of 64 pending IO operations:


switch-A# scope org /
switch-A /org # scope fc-policy fcPolicy13
switch-A /org/fc-policy # set port io-throttle-count 64
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


show port (fc-policy)

Cisco UCS Manager CLI Command Reference, Release 2.0


1328 OL-25718-02
Commands
set port max-luns

set port max-luns


To specify the maximum number of LUNs supported per target, use the set port max-luns command.

set port max-luns max-luns

Syntax Description max-luns Specifies the maximum number of LUNs. The range is 1 to 1024 LUNs; the
default is 256.

Command Default A maximum of 256 LUNs is supported per target.

Command Modes Fibre Channel policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the maximum number of logical unit numbers (LUNs) supported per target.

Examples This example shows how to specify a maximum of 512 LUNs per target:
switch-A# scope org /
switch-A /org # scope fc-policy fcPolicy13
switch-A /org/fc-policy # set port max-luns 512
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


show port (fc-policy)

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1329
Commands
set port-f-logi retries

set port-f-logi retries


To configure the number of Fibre Channel port fabric login (FLOGI) retries, use the set port-f-logi retries
command.

set port-f-logi retries {retries| infinite}

Syntax Description retries Number of FLOGI retries.

infinite Retry FLOGI until successful.

Command Default The number of retries is 1000.

Command Modes Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the number of Fibre Channel port fabric login (FLOGI) retries. You can
configure a number between 0 and 4294967295, or you can use the infinite keyword to retry until successful.

Examples This example shows how to configure 10000 FLOGI retries:


switch-A# scope org
switch-A /org # enter fc-policy FcPolicy19
switch-A /org/fc-policy # set port-f-logi retries 10000
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


set port-f-logi timeout
show port-f-logi

Cisco UCS Manager CLI Command Reference, Release 2.0


1330 OL-25718-02
Commands
set port-f-logi timeout

set port-f-logi timeout


To configure the Fibre Channel port fabric login (FLOGI) timeout, use the set port-f-logi timeout command.

set port-f-logi timeout timeout

Syntax Description timeout The number of milliseconds (msec) to wait for the login to succeed.

Command Default The timeout is 2000 msec.

Command Modes Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the Fibre Channel port fabric login (FLOGI) timeout. You can configure a
number between 1000 and 255000.milliseconds.

Examples This example shows how to configure an FLOGI timeout of 20 seconds:


switch-A# scope org
switch-A /org # enter fc-policy FcPolicy19
switch-A /org/fc-policy # set port-f-logi timeout 20000
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


set port-f-logi retries
show port-f-logi

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1331
Commands
set portmode

set portmode
To set a port mode for the fabric interface, use the set portmode command.

set portmode {access| trunk}

Syntax Description access Use this option to set the port mode to access.

trunk Use this option to set the port mode to trunk.

Command Default None

Command Modes Interface (/eth-storage/fabric/interface)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An interface for the fabric must be created to use this command.

Examples This example shows how to set the port mode to access for the fabric interface.
Switch-A # scope eth-storage
Switch-A /eth-storage # scope fabric b
Switch-A /eth-storage/fabric # scope interface 2 3
Switch-A /eth-storage/fabric/interface # set portmode access
Switch-A /eth-storage/fabric/interface* # commit-buffer

Related Commands Command Description


create interface
set adminspeed
set pingroupname
set prio
set user-label

Cisco UCS Manager CLI Command Reference, Release 2.0


1332 OL-25718-02
Commands
set port-p-logi retries

set port-p-logi retries


To configure the number of Fibre Channel port-to-port login (PLOGI) retries, use the set port-p-logi retries
command.

set port-p-logi retries retries

Syntax Description retries Number of PLOGI retries.

Command Default The number of retries is 3.

Command Modes Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the number of Fibre Channel port-to-port login (PLOGI) retries. You can
configure a number between 0 and 255.

Examples This example shows how to configure 100 PLOGI retries:


switch-A# scope org
switch-A /org # enter fc-policy FcPolicy19
switch-A /org/fc-policy # set port-p-logi retries 100
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


set port-p-logi timeout
show port-p-logi

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1333
Commands
set port-p-logi timeout

set port-p-logi timeout


To configure the Fibre Channel port-to-port login (PLOGI) timeout, use the set port-p-logi timeout command.

set port-p-logi timeout timeout

Syntax Description timeout The number of milliseconds (msec) to wait for the login to succeed.

Command Default The timeout is 2000 msec.

Command Modes Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the Fibre Channel port-to-port login (PLOGI) timeout. You can configure a
number between 1000 and 255000.milliseconds.

Examples This example shows how to configure a PLOGI timeout of 20 seconds:


switch-A# scope org
switch-A /org # enter fc-policy FcPolicy19
switch-A /org/fc-policy # set port-p-logi timeout 20000
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


set port-p-logi retries
show port-p-logi

Cisco UCS Manager CLI Command Reference, Release 2.0


1334 OL-25718-02
Commands
set post-error-pause-config port-error-pause

set post-error-pause-config port-error-pause


To specify the POST error pause configuration, use the set post-error-pause-config port-error-pause
command.

set post-error-pause-config post-error-pause {disabled| enabled| platform-default}

Syntax Description disabled To disable the POST error pause configuration.

enabled To enable the POST error pause configuration.

platform-default To set the POST error pause configuration to the platform default option.

Command Default Platform default

Command Modes BIOS Policy (/org/bios-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A BIOS policy for an organization must be created to use this command.

Examples This example shows how to enable the POST error pause configuration for a BIOS policy.
UCS-A # scope org Test
UCS-A /org # scope bios-policy sample
UCS-A /org/bios-policy # set post-error-pause-config post-error-pause enable
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


create bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1335
Commands
set power-budget committed

set power-budget committed


To manage the committed power usage level of a server, use the set power-budget committed command.

set power-budget committed{disabled| watts}

Syntax Description disabled No power usage limitations are


imposed on the server.

watts Specifies the maximum number of


watts that the server can use. The
range is between 100 and 1,100
watts.

Command Default No power usage limitations are imposed on the server (disabled).

Command Modes Server (/chassis/server)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to manage the committed power usage level of a server.

Examples The following example limits the power usage level of a server to 1000 watts and commits the transaction:
UCS-A# scope server 2/4
UCS-A /chassis/server # set power-budget committed 1000
UCS-A /chassis/server* # commit-buffer
UCS-A /chassis/server #

Related Commands Command Description


set mb-power-stats

show power-budget

Cisco UCS Manager CLI Command Reference, Release 2.0


1336 OL-25718-02
Commands
set power-control-policy

set power-control-policy
To set the power control policy for a service profile, use the set power-control-policy command.

set power-control-policy power-control-policy

Syntax Description power-control-policy The name of the power control policy.

Command Default None

Command Modes Service Profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A service profile and a power control policy must be created to use this command.

Examples This example shows how to set the power control policy for a service profile.
Switch-A # scope org
Switch-A /org # scope service-profile Default
Switch-A /org/service-profile # set power-control-policy Test
Switch-A /org/service-profile* # commit-buffer
Switch-A /org/service-profile #

Related Commands Command Description


create power-control-policy
scope power-control-policy
enter power-control-policy
show power-control-policy
delete power-control-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1337
Commands
set preserve-pooled-values

set preserve-pooled-values
To preserve pool-derived identities in a backup, use the set preserve-pooled-values command.

set preserve-pooled-values {no| yes}

Syntax Description no Pool-derived identities are not preserved.

yes Pool-derived identities are preserved.

Command Default Pool-derived identities are not preserved.

Command Modes System backup (/system/backup)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to preserve pool-derived vHBA WWPN, vNIC MAC, WWNN and UUID identities in a
backup.

Examples This example specifies that pool-derived identities are preserved in a backup:
server-A# scope system
server-A /system # create backup ftp: full-state enabled
Password:
server-A /system/backup* # set preserve-pooled-values yes
server-A /system/backup* # commit-buffer
server-A /system/backup #

Related Commands Command Description


show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


1338 OL-25718-02
Commands
set prio

set prio
To set the QoS (Quality of Service) priority level, use the set prio command.

policy mode
set prio {auto| on}

egress-policy mode
set prio {best-effort | bronze | fc | gold | platinum | silver}

Syntax Description auto Sets priority to automatic.

on Enables priority.

best-effort Sets priority to the best effort level.

bronze Sets priority to the the bronze level.

fc Sets priority to the Fibre Channel


level.

gold Sets priority to the gold level.

platinum Sets priority to the platinum level.

silver Sets priority to the silver level.

Command Default For policy mode, the default is Auto.


For egress-policy mode, the default is Best Effort.

Command Modes Policy (/eth-uplink/flow-control/policy)


Egress policy (/org/qos-policy/egress-policy)

Command History Release Modification


1.0(1) This command was introduced for policy mode.

1.1(1) This command was introduced for egress-policy mode.

Usage Guidelines Following are the ratings of the different priorities:

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1339
Commands
set prio

• Best effort—All unmatched


• Bronze—1
• FC—3
• Gold—4
• Platinum—5
• Silver—2

Examples This example shows how to set priority in policy mode:

switch-A# scope eth-uplink

switch-A /eth-uplink # scope flow-control

switch-A /eth-uplink/flow-control # scope policy

switch-A /eth-uplink/flow-control/policy # set prio on

switch-A /eth-uplink/flow-control/policy* # commit-buffer

switch-A /eth-uplink/flow-control/policy #

Related Commands Command Description


show policy
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1340 OL-25718-02
Commands
set priority

set priority
To set a priority for a power control policy, use the set priority command.

set priority {Admin priority| no-cap}

Syntax Description Admin priority Use this option to set an administrator priority on the power control policy.
The value must be a number between 1 - 10.

no-cap Use this option to not set a capping on the power control policy.

Command Default None

Command Modes Power control policy (/org/power-control-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A power control policy must be created to use this command.

Examples This example shows how to set an administrator priority on a power control policy.
Switch-A # scope org
Switch-A /org # scope power-control-policy Sample
Switch-A /org/power-control-policy # set priority 2
Switch-A /org/power-control-policy* # commit-buffer
Switch-A /org/power-control-policy #

Related Commands Command Description


create power-control-policy
scope power-control-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1341
Commands
set privilege

set privilege
To configure administrative or read-only privileges for an IPMI endpoint user, use the set privilege command.

set privilege {admin| readonly}

Syntax Description admin The user has administrative privileges.

readonly The user has read-only privileges.

Command Default None.

Command Modes IPMI user (/org/ipmi-access-profile/ipmi-user)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure administrative or read-only privileges for an IPMI endpoint user.

Examples This example shows how to configure read-only privileges for an IPMI endpoint user:
server-A# scope org /
server-A /org # scope ipmi-access-profile ReadOnly
server-A /org/ipmi-access-profile # scope ipmi-user bob
server-A /org/ipmi-access-profile/ipmi-user # set privilege readonly
server-A /org/ipmi-access-profile/ipmi-user* # commit-buffer
server-A /org/ipmi-access-profile/ipmi-user #

Related Commands Command Description


show ipmi-user

Cisco UCS Manager CLI Command Reference, Release 2.0


1342 OL-25718-02
Commands
set priv-password

set priv-password
To set up a privacy password, use the set priv-password command.

set priv-password

This command has no arguments or keywords.

Command Default None

Command Modes SNMP user (/monitoring/snmp-user)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Password must be a minimum 8 characters.


No text appears when you enter your password at the Enter a password: prompt or the Confirm the
password: prompt. This is default behavior and cannot be changed.

Examples This example shows how to set up a privacy password:


switch-A# scope monitoring
switch /monitoring # scope snmp-user SU10
switch /monitoring/snmp-user # set priv-password
Enter a password:
Confirm the password:
switch /monitoring/snmp-user* # commit-buffer
switch /monitoring/snmp-user #

Related Commands Command Description


show snmp
show snmp-user

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1343
Commands
set proc-cap

set proc-cap
To set a maximum number of jobs that can be executed by a maintenance window, use the set proc-cap
command.

set proc-cap {number of jobs| none}

Syntax Description number of jobs The maximum number of jobs that can be executed by the maintenance window.
The value must be between 0 - 4294967294.

none To not set a maximum number of jobs for a maintenance window.

Command Default None

Command Modes One-time maintenance window (/system/scheduler/one-time)


Periodic maintenance window (/system/scheduler/periodic)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A scheduler policy and a maintenance window must be created to use this command.

Examples This example shows how to set a maximum number of jobs that can be executed by a periodic maintenance
window.
Switch-A # scope system
Switch-A /system # scope scheduler default
Switch-A /system/scheduler # scope maint-window periodic Trial
Switch-A /system/scheduler/periodic # set proc-cap 3456
Switch-A /system/scheduler/periodic* # commit-buffer
Switch-A /system/scheduler/periodic #

Related Commands Command Description


set concur-jobs
set hour
set date
set max-duration
set min-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


1344 OL-25718-02
Commands
set proc-cap

Command Description
set minute

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1345
Commands
set processor-c-state-config c-state

set processor-c-state-config c-state


To set the processor C-state configuration, use the set processor-c-state-config c-state command.

set processor-c-state-config c-state {disabled| enabled| platform-default}

Syntax Description disabled Disables the processor C-state configuration.

enabled Enables the processor C-state configuration.

platform default Sets the processor C-state configuration to the platform


default option.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a BIOS policy before you use this command.

Examples This example shows how to set the processor C-state configuration to the platform default option:
UCS-A # scope org test
UCS-A /org # scope bios-policy sample
UCS-A /org/bios-policy # set processor-c-state-config c-state platform-default
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


set intel-turbo-boost-config turbo-boost

set enhanced-intel-speedstep-config speed-step

set hyper-threading-config hyper-threading

set core-multi-processing-config multi-processing

set execute-disable bit

Cisco UCS Manager CLI Command Reference, Release 2.0


1346 OL-25718-02
Commands
set processor-c-state-config c-state

Command Description
set intel-vt-config vt

set direct-cache-access-config access

set max-variable-mttr--setting-config processor-mtrr

set processor-c1e-config c1e

set processor-c3-report-config processor-c3-report

set processor-c6-report-config processor-report

set cpu-performance-config cpu-config

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1347
Commands
set processor-c3-report-config

set processor-c3-report-config
To specify whether the processor sends a C3 report to the operating system, use the set
processor-c3-report-config command.

set processor-c3-report-config processor-c3-report {acpi-c2| acpi-c3| disabled| platform-default}

Syntax Description acpi-c2 The processor sends the C3 report


using the ACPI C2 format.

acpi-c3 The processor sends the C3 report


using the ACPI C3 format.

disabled The processor does not send a C3


report.

platform-default The BIOS uses the value for this


attribute contained in the BIOS
defaults for the server type and
vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to specify whether the processor sends the C3 report to the operating system.

Examples The following example shows how to create a BIOS policy that sends a C3 report to the operating system
using the ACPI C3 format:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set processor-c3-report-config processor-c3-report acpi-c3
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Cisco UCS Manager CLI Command Reference, Release 2.0


1348 OL-25718-02
Commands
set processor-c3-report-config

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1349
Commands
set processor-c6-report-config

set processor-c6-report-config
To specify whether the processor sends a C6 report to the operating system, use the set
processor-c6-report-config command.

set processor-c6-report-config processor-report {disabled| enabled| platform-default}

Syntax Description disabled The processor does not send a C6


report.

enabled The processor sends a C6 report.

platform-default The BIOS uses the value for this


attribute contained in the BIOS
defaults for the server type and
vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to specify whether the processor sends the C6 report to the operating system.

Examples The following example shows how to create a BIOS policy that sends a C6 report to the operating system:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set processor-c6-report-config processor-report enabled
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1350 OL-25718-02
Commands
set protect

set protect
To specify whether the local disk is protected or not, use the set protect command.

set all {yes| no}

Syntax Description yes Local disk is protected.

no Local disk is not protected.

Command Default Yes

Command Modes Local disk configuration policy within organization (/org/local-disk-config-policy)


Local disk configuration policy within a service-profile (/org/service-profile/local-disk-config-policy)

Command History Release Modification


1.0(1) This command was introduced for a local disk configuration policy within the
Organization mode.

1.4(1) This command was introduced for a local disk configuration policy for a service
profile within the Organization mode.

Usage Guidelines Use this command to specify whether the local disk is protected or not.

Examples This example shows how to set the enable local disk protection in a local disk configuration policy called
DiskPolicy7:
switch-A# scope org
switch-A /org # scope local-disk-config-policy DiskPolicy7
switch-A /org/local-disk-config-policy # set protect yes
switch-A /org/local-disk-config-policy* # commit-buffer
switch-A /org/local-disk-config-policy #

Related Commands Command Description


show (local-disk-config-policy)

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1351
Commands
set protocol

set protocol
To specify a file transfer protocol, use the set protocol command.

set protocol {ftp| scp| sftp| tftp}

Syntax Description ftp Specifies the File Transfer Protocol


(FTP) for file transfer.

scp Specifies the Secure Copy Protocol


(SCP) for file transfer.

sftp Specifies the Secure File Transfer


Protocol (SFTP) for file transfer.

tftp Specifies the Trivial File Transfer


Protocol (TFTP) for file transfer.

Command Default None

Command Modes Configuration import (/system/import-config)


System backup (/system/backup)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify a file transfer protocol.

Examples This example specifies SFTP as the file transfer protocol for importing a configuration file:
server-A# scope system
server-A /system # scope import-config host35
server-A /system/import-config # set protocol sftp
server-A /system/import-config* # commit-buffer
server-A /system/import-config #

Related Commands Command Description


show backup
show import-config

Cisco UCS Manager CLI Command Reference, Release 2.0


1352 OL-25718-02
Commands
set pubnwname

set pubnwname
To set a primary VLAN for a fabric VLAN, use the set pubnwname command.

set pubnwname pubnwname

Syntax Description pubnwname The name of the primary VLAN.

Command Default None

Command Modes VLAN (/eth-uplink/fabric/vlan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A VLAN must be created within the fabric to use this command.

Examples This example shows how to set a primary VLAN for a fabric VLAN.
Switch-A # scope eth-uplink
Switch-A /eth-uplink # scope fabric a
Switch-A /eth-uplink/fabric # scope vlan 200
Switch-A /eth-uplink/fabric/vlan # set pubnwname sample
Switch-A /eth-uplink/fabric/vlan* # commit-buffer
Switch-A /eth-uplink/fabric/vlan #

Related Commands Command Description


create vlan
scope vlan
set native
set sharing
set vlan-id

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1353
Commands
set qos-policy

set qos-policy
To set the QoS policy, use the set qos-policy command.

set qos-policy name

Syntax Description name QoS policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Port profile (/eth-uplink/port-profile)


Virtual HBA (/org/service-profile/vhba)
Virtual HBA template (/org/vhba-templ)
Virtual NIC (/org/service-profile/vnic)
Virtual NIC template (/org/vnic-templ)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the QoS policy to use for the vNIC.

Examples This example shows how to set the QoS policy:

switch-A# scope org org30

switch-A /org # scope vnic-templ vnict10

switch-A /org/vnic-templ # set qos-policy qp10

switch-A /org/vnic-templ* # commit-buffer

switch-A /org/vnic-templ #

Related Commands Command Description


show eth-if
show qos-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1354 OL-25718-02
Commands
set qualifier

set qualifier
To set a qualifier, use the set qualifier command.

set qualifier name

Syntax Description name Qualifier name. The range of valid values is 1 to 16.

Command Default None

Command Modes Server inherit policy (/org/server-inherit-policy)


Server discovery policy (/org/server-disc-policy)
Pooling policy (/org/pooling-policy)
Chassis discovery policy (/org/chassis-disc-policy)
Automatic configuration policy (/org/autoconfig-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to add a qualifier to your policy. Only one qualifier can be set for each policy.

Examples This example shows how to set a qualifier:

switch-A# scope org org3

switch-A /org # scope server-disc-policy sdp100

switch-A /org/server-disc-policy # set qualifier q100

switch-A /org/server-disc-policy* # commit-buffer

switch-A /org/server-disc-policy #

Related Commands Command Description


show pooling policy
show server-disc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1355
Commands
set quiet-boot-config

set quiet-boot-config
To configure the BIOS display during Power On Self-Test (POST), use the set quiet-boot-config command.

set quiet-boot-config quiet-boot {disabled| enabled| platform-default}

Syntax Description disabled The BIOS displays the logo screen.

enabled The BIOS does not display any messages during boot.

platform-default The BIOS uses the value for this attribute contained in the BIOS defaults
for the server type and vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to configure the BIOS display during Power On Self-Test (POST).

Examples The following example shows how to create a BIOS policy that enables quiet boot mode:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set quiet-boot-config quiet-boot enabled
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1356 OL-25718-02
Commands
set rate

set rate
To set the QoS (Quality of Service) rate and burst, use the set rate command.

set rate {rate rate-number burst burst-number | line-rate burst-number}

Syntax Description rate Sets the rate.

rate-number The rate number, in bits.

burst Sets the burst.

burst-number The burst number, in bits.

line-rate Sets rate to line rate.

Command Default The default is line rate and 10240.

Command Modes Egress policy (/org/qos-policy/egress-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines The rate number, in bits. The range of valid values is 0 to 10000000. The burst number, in bits. The range of
valid values is 0 to 65535.

Examples This example shows how to set the rate and burst:
switch-A# scope org
switch-A /org # scope qos-policy qp10
switch-A /org/qos-policy # scope egress-policy
switch-A /org/qos-policy/egress-policy # set rate rate 10000 burst 1000
switch-A /org/qos-policy/egress-policy* # commit-buffer
switch-A /org/qos-policy/egress-policy #

Related Commands

Related Commands Command Description


show egress-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1357
Commands
set rate

Command Description
show qos-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1358 OL-25718-02
Commands
set realloc

set realloc
To set a reallocation for a power group, use the set realloc command.

set realloc {chassis | none}

Syntax Description chassis Use this option to set the reallocation of a power group to a chassis.

none Use this option to not set a reallocation for the power group.

Command Default None

Command Modes Power group (/power-cap-mgmt/power-group)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A power group must be created to use this command.

Examples This example shows how to set a reallocation for a power group.
UCS-A # scope power-cap-mgmt
UCS-A /power-cap-mgmt # scope power-group testing
UCS-A /power-cap-mgmt/power-group # set reallocation chassis
UCS-A /power-cap-mgmt/power-group* # commit-buffer
UCS-A /power-cap-mgmt/power-group #

Related Commands Command Description


create power-group
set peak

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1359
Commands
set realm

set realm
To set a realm for the default authentication mechanism, use the set realm command.

set realm {ldap| local| radius| tacacs}

Syntax Description ldap Use this option to set the realm as LDAP.

local Use this option to set the realm as local.

radius Use this option to set the realm as RADIUS.

tacacs Use this option to set the realm as TACACS.

Command Default None

Command Modes Default authentication (/security/auth-domain/default-auth)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication domain must be created to use this command.

Examples This example shows how to set the realm of the default authentication mechanism to LDAP.
Switch-A # scope security
Switch-A /security # scope auth-domain Sample
Switch-A /security/auth-domain # scope default-auth
Switch-A /security/auth-domain/default-auth # set realm ldap
Switch-A /security/auth-domain/default-auth* # commit-buffer
Switch-A /security/auth-domain/default-auth #

Related Commands Command Description


set auth-server-group
create auth-domain

Cisco UCS Manager CLI Command Reference, Release 2.0


1360 OL-25718-02
Commands
set realm

set realm
To set a realm for the security method, use the set realm command.

set realm {ldap| local| none| radius| tacacs}

Syntax Description ldap Use this option to set the realm as LDAP.

local Use this option to set the realm as local.

none Use this option to not set a realm.

radius Use this option to set the realm as RADIUS

tacacs Use this option to set the realm as TACACS.

Command Default None

Command Modes Default authentication (/security/default-auth)


Console authentication (/security/console-auth)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to set the realm as LDAP for console authentication.
Switch-A # scope security
Switch-A /security # scope console-auth
Switch-A /security/console-auth # set realm LDAP
Switch-A /security/console-auth* # commit-buffer
Switch-A /security/console-auth #

Related Commands Command Description


scope security
scope console-auth
scope default-auth

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1361
Commands
set reboot-on-update

set reboot-on-update
To set reboot on updates, use the set reboot-on-update command.

set reboot-on-update {no| yes}

Syntax Description no Specifies no reboot on updates.

yes Specifies reboot on updates.

Command Default None

Command Modes Boot policy (/org/boot-policy)


Boot definition (/org/service-profile/boot-def)
BIOS policy (/org/bios-policy)

Command History Release Modification


1.0(1) This command was introduced.

2.0(1) This command was introduced in the BIOS policy command mode
(/org/bios-policy)

Examples This example shows how to set reboot on updates:

UCS-A # scope org org3


UCS-A /org # scope boot-policy bp112
UCS-A /org/boot-policy # set reboot-on-update yes
UCS-A /org/boot-policy* # commit-buffer
UCS-A /org/boot-policy #

Related Commands Command Description


show boot-policy
show storage
show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1362 OL-25718-02
Commands
set reboot-policy

set reboot-policy
To specify a reboot policy for all service profiles that include a specific maintenance policy that is associated
with a server, use the set reboot-policy command.

set reboot-policy immediate timer-automatic user-ack

Syntax Description immediate (Optional) The server reboots as soon as the change is made to the service
profile.

timer-automatic (Optional) The server reboots at a scheduled time. The time must be set using
the set scheduler command.

user-ack (Optional) You must explicitly acknowledge the changes to the service profile
by using the apply pending-changes command.

Command Default None

Command Modes Maintenance Policy (/org/maint-policy)

Command History Release Modification


1.4(1) This command has been renamed as set reboot-policy.

Usage Guidelines If you set the reboot policy to timer-automatic, then you must schedule the reboot cycle by using the set
scheduler command.
If you set the reboot policy to user-ack, then you must explicitly acknowledge changes made to the service
profile by using the apply pending-changes command.

Examples This example shows how to set the reboot policy to immediate.
Switch-A # scope org Test
Switch-A /org # scope maint-policy Sample
Switch-A /org/maint-policy # set reboot-policy immediate
Switch-A /org/maint-policy* # commit-buffer
Switch-A /org/maint-policy #

Related Commands Command Description


create maint-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1363
Commands
set reboot-policy

Command Description
create service-profile

apply pending-changes

set scheduler

Cisco UCS Manager CLI Command Reference, Release 2.0


1364 OL-25718-02
Commands
set receive

set receive
To set recieve, use the set receive command.

set receive {off| on}

Syntax Description off Specifies recieve off.

on Specifies recieve on.

Command Default None

Command Modes Flow control policy (/eth-uplink/flow-control/policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify flow control receive options.
When you specify off, pause requests from the network are ignored and traffic flow continues as normal.
When you specify on, pause requests are honored and all traffic is halted on that uplink port until the network
cancels the pause request

Examples This example shows how to set recieve:

switch-A# scope eth-uplink

switch-A /eth-uplink # scope flow-control

switch-A /eth-uplink/flow-control # scope policy fcpolicy110

switch-A /eth-uplink/flow-control/policy # set recieve on

switch-A /eth-uplink/flow-control/policy* # commit-buffer

switch-A /eth-uplink/flow-control/policy #

Related Commands Command Description


show stats-threshold-policy
show policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1365
Commands
set recv-queue count

set recv-queue count


To configure the number of receive queue resources to allocate, use the set recv-queue count command.

set recv-queue count count

Syntax Description count Number of queue resources.

Command Default The receive queue count is 1.

Command Modes Ethernet adapter policy (/org/eth-policy)


Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the number of receive queue resources to allocate. Enter a number between
1 and 256.

Examples This example shows how to configure the number of receive queue resources for an Ethernet policy:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set recv-queue count 100
switch-A /org/eth-policy* # set trans-queue count 100
switch-A /org/eth-policy* # set comp-queue count 200
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


set comp-queue count
set recv-queue ring-size
show eth-policy
show fc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1366 OL-25718-02
Commands
set recv-queue ring-size

set recv-queue ring-size


To configure the number of descriptors in the receive queue, use the set recv-queue ring-size command.

set recv-queue ring-size ring-size

Syntax Description ring-size Number of descriptors.

Command Default The receive queue ring size is 512.

Command Modes Ethernet adapter policy (/org/eth-policy)


Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the number of descriptors in the receive queue. Enter a number between 64
and 4096.

Examples This example shows how to configure the receive queue ring size for an Ethernet policy:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set recv-queue count 100
switch-A /org/eth-policy* # set recv-queue ring-size 1024
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


set recv-queue count
show eth-policy
show fc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1367
Commands
set redundancy

set redundancy
To set up power supply redundancy, use the set redundancy command.

set redundancy {grid | n-plus-1 | non-redund}

Syntax Description grid Specifies grid redundancy.

n-plus-1 Specifies n+1 redundancy.

non-redund Specifies no redundancy.

Command Default None

Command Modes Power supply unit policy (/org/psu-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines In the non-redundant scheme, all installed power supplies are turned on and load balanced evenly. Smaller
configurations, requiring less than 2500W, can be powered by a single power supply. However, a single power
supply does not provide redundancy. More common configurations require two or more power supplies (if
requirements are between 2500 and 5000 watts peak) in non-redundant mode.
In the n+1 scheme implies, the chassis contains the total number of power supplies to satisfy non-redundancy,
plus one additional power supply for redundancy. All the power supplies that are participating in n+1
redundancy are turned on, and equally share the power load for the chassis. If any additional power supplies
are installed, UCS Manager recognizes these unnecessary power supplies and turns them off.
If a power supply should fail, the surviving supply(s) can provide power to the chassis. In addition, UCS
Manager turns on any turned-off power supplies, to bring the system back to n+1 status.
To provide n+1 protection, the following number of power supplies are recommended:
• Chassis requires less than 2500W—Two power supplies
• Chassis requires greater than 2500W—Three power supplies

Adding an additional power supply to either of these configurations will provide an extra level of protection.
UCS Manager turns on the extra power supply in the event of a failure, and restores n+1 protection.
The grid redundant configuration is used when you have two power sources to power a chassis, or you require
greater than n+1 redundancy. If one source fails, which causes a loss of power to one or two power supplies,
the surviving power supplies on the other power circuit continue to provide power to the chassis.

Cisco UCS Manager CLI Command Reference, Release 2.0


1368 OL-25718-02
Commands
set redundancy

A common reason for using grid redundancy is if the rack power distribution is such that power is provided
by two PDUs and you want the grid redundancy protection in the case of a PDU failure.
To provide grid redundancy or greater than n+1 protection, the following number of power supplies are
recommended:
• Chassis requires less than 2500W—Two power supplies
• Chassis requires greater than 2500W—Four power supplies

Examples This example shows how to set up power supply redundancy:


switch-A# scope org
switch-A /org # scope psu-policy
switch-A /org/psu-policy # set redundancy n-plus-1
switch-A /org/psu-policy* # commit-buffer
switch-A /org/psu-policy #

Related Commands Command Description


show psu
show psu-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1369
Commands
set refresh-period

set refresh-period
To specify the maximum amount of time allowed between refresh requests for a user, use the set refresh-period
command.

set refresh-period seconds

Syntax Description seconds Specify an integer between 60 and 172800.

Command Default By default, the maximum amount of time is set to 600 seconds.

Command Modes Authentication domain (/security/auth-domain)

Command History Release Modification


2.0(3) This command was introduced.

Usage Guidelines None

Examples This example shows how to set the maximum amount of time allowed between refresh requests for a user to
500 seconds.
UCS-A # scope security
UCS-A /security # scope auth-domain sample
UCS-A /security/auth-domain # set refresh-period 500
UCS-A /security/auth-domain # set session-timeout 14400
UCS-A /security/auth-domain* # commit-buffer
UCS-A /security/auth-domain #

Related Commands Command Description


set session-timeout

Cisco UCS Manager CLI Command Reference, Release 2.0


1370 OL-25718-02
Commands
set regenerate

set regenerate
To regenerate the keys in the default keyring, use the set regenerate command.

set regenerate {no| yes}

Syntax Description no Do not regenerate the keys.

yes Regenerate the keys.

Command Default None

Command Modes Keyring (/security/keyring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to regenerate the RSA keys in the default keyring. This command is accepted only in the
default keyring.

Examples This example shows how to regenerate the keys in the default keyring:
switch-A# scope security
switch-A /security # scope keyring default
switch-A /security/keyring # set regenerate yes
switch-A /security/keyring* # commit-buffer
switch-A /security/keyring #

Related Commands Command Description


show keyring

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1371
Commands
set remote-file

set remote-file
To specify the name of a file to be transfered, use the set remote-file command.

set remote-file
set remote-file remote-file

Syntax Description remote-file Specifies the file name.

Command Default None

Command Modes Configuration import (/system/import-config)


System backup (/system/backup)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the name of a file to be transfered.

Examples This example specifies the name of a remote configuration file for importing:
server-A# scope system
server-A /system # scope import-config host35
server-A /system/import-config # set remote-file MyConfig13.cfg
server-A /system/import-config* # commit-buffer
server-A /system/import-config #

Related Commands Command Description


show backup
show import-config

Cisco UCS Manager CLI Command Reference, Release 2.0


1372 OL-25718-02
Commands
set reply-to-email

set reply-to-email
To configure an email address that will appear in the Reply-To field in Call Home email messages, use the
set reply-to-email command.

set reply-to-email reply-to-email

Syntax Description reply-to-email Email address.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to configure an email address that will appear in the Reply-To field in Call Home email
messages. Enter up to 512 characters. Specify the email address in the format <name>@<domain name>. If
no address is specified, the contact email address is used.

Examples This example shows how to configure a Reply-To email address:


switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set reply-to-email admin@example.com
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


set from-email
show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1373
Commands
set reporting-interval

set reporting-interval
To specify the interval at which collected statistics are reported, use the set reporting-interval command.

set reporting-interval {15minutes| 30minutes| 60minutes}

Syntax Description 15minutes Statistics are reported at an interval of 15 minutes.

30minutes Statistics are reported at an interval of 30 minutes.

60minutes Statistics are reported at an interval of 60 minutes.

Command Default Statistics are reported at an interval of 15 minutes.

Command Modes Statistics collection policy (/monitoring/stats-collection-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the interval at which collected statistics are reported. You can specify the reporting
interval separately for chassis, port, host, adapter, and server statistics.

Examples This example shows how to set the port statistics reporting interval to thirty minutes:
switch-A# scope monitoring
switch-A /monitoring # scope stats-collection-policy port
switch-A /monitoring/stats-collection-policy # set reporting-interval 30minutes
switch-A /monitoring/stats-collection-policy* # commit-buffer
switch-A /monitoring/stats-collection-policy #

Related Commands Command Description


set collection-interval
show stats-collection-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1374 OL-25718-02
Commands
set resume-ac-on-power-loss-config

set resume-ac-on-power-loss-config
To configure how the server behaves when power is restored after an unexpected power loss, use the set
resume-ac-on-power-loss-config command.

set resume-ac-on-power-loss-config resume-action {stay-off| last-state| reset| platform-default}

Syntax Description stay-off The server remains off until


manually powered on.

last-state The server is powered on and the


system attempts to restore its last
state.

reset The server is powered on and


automatically reset.

platform-default The BIOS uses the value for this


attribute contained in the BIOS
defaults for the server type and
vendor.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)


Platform BIOS defaults (/system/server-defaults/platform/bios-settings)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to configure how the server behaves when power is restored after an unexpected power
loss.

Examples The following example shows how to create a BIOS policy that restores the server power to its previous state
after a power loss:
switch-A# scope org org3
switch-A /org # create bios-policy bios1
switch-A /org/bios-policy* # set resume-ac-on-power-loss-config resume-action last-state
switch-A /org/bios-policy* # commit-buffer
switch-A /org/bios-policy #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1375
Commands
set resume-ac-on-power-loss-config

Related Commands Command Description


show bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1376 OL-25718-02
Commands
set retention-interval

set retention-interval
To configure the length of time before cleared fault messages are deleted, use the set retention-interval
command.

set retention-interval {forever| days hours minutes seconds}

Syntax Description forever Specifies that fault messages are


never deleted.

days Specifies the number of days that


fault messages are retained. The
range is 0 to 65535 days.

hours Specifies the number of hours that


fault messages are retained. The
range is 0 to 23 hours; the default
is 1 hour

minutes Specifies the number of minutes


that fault messages are retained.
The range is 0 to 59 minutes.

seconds Specifies the number of seconds


that fault messages are retained.
The range is 0 to 59 seconds.

Command Default None

Command Modes Fault-policy (/monitoring/fault-policy)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to set the retention period for fault messages when the set clear-action command is
configured to retain messages.

Examples This example shows how to set the fault message retention period to 30 days:
switch-A# scope monitoring
switch-A /monitoring # scope fault policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1377
Commands
set retention-interval

switch-A /monitoring/fault-policy # set clear-action retain


switch-A /monitoring/fault-policy* # set retention-interval 30 0 0 0
switch-A /monitoring/fault-policy* # commit-buffer
switch-A /monitoring/fault-policy #

Related Commands Command Description


set clear-action
show fault policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1378 OL-25718-02
Commands
set retries

set retries
To set the number of retries, use the set retries command.

set retries retries

Syntax Description retries Number of retries. The range of valid values is 0 to 5.

Command Default None

Command Modes RADIUS (/security/radius)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) The command option number was renamed as retries .

Usage Guidelines Use this command to set the number of times to retry communicating with the RADIUS server before noting
the server as down.

Examples This example shows how to set the number of retries:

switch-A#scope security

switch /security # scope radius

switch /security/radius # set retries 3

switch /security/radius* # commit-buffer

switch /security/radius #

Related Commands Command Description


show ldap
show radius

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1379
Commands
set rootdn

set rootdn
To set a root distinguished name, use the set rootdn command.

set rootdn name

Syntax Description name Root distinguished name. The range of valid values is 1 to 127.

Command Default None

Command Modes Server (/security/ldap/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the distinguished name for the LDAP database superuser account.

Examples This example shows how to set a root distinguished name:

switch-A#scope security

switch-A /security # scope ldap

switch-A /security/ldap # scope server s100

switch-A /security/ldap/server # set rootdn administrator

switch-A /security/ldap/server* # commit-buffer

switch-A /security/ldap/server #

Related Commands Command Description


show ldap
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


1380 OL-25718-02
Commands
set rss receivesidescaling

set rss receivesidescaling


To enable or disable receive-side scaling (RSS), use the set rss receivesidescaling command.

set rss receivesidescaling {disabled| enabled}

Syntax Description disabled The system does not use RSS.

enabled The system uses RSS.

Command Default Enabled

Command Modes Ethernet adapter policy (/org/eth-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enable or disable receive-side scaling (RSS). RSS enables the efficient distribution of
network receive processing across multiple CPUs in multiprocessor systems.

Examples This example shows how to enable RSS in an Ethernet policy:


switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set rss receivesidescaling enabled
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


show eth-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1381
Commands
set scheduler

set scheduler
To set a scheduler for a maintenance policy, use the set scheduler command.

set scheduler scheduler

Syntax Description scheduler The name of the scheduler.

Command Default None

Command Modes Maintenance Policy (/org/maint-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A maintenance policy and a scheduler must be created before using this command.

Examples This example shows how to set a scheduler for a maintenance policy.
Switch-A # scope org
Switch-A /org # scope maint-policy Sample
Switch-A /org/maint-policy # set scheduler default
Switch-A /org/maint-policy* # commit-buffer
Switch-A /org/maint-policy #

Related Commands Command Description


create scheduler
create maint-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1382 OL-25718-02
Commands
set scrub-policy

set scrub-policy
To set the scrub policy, use the set scrub-policy command.

set scrub-policy name

Syntax Description name Scrub policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Rack Server discovery policy (/org/rackserver-disc-policy)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command was introduced in the Rack Server Discovery policy
(/org/rackserver-disc-policy). The Server Discovery Policy mode
(/org/server-disc-policy) has been obsoleted.

Usage Guidelines Use this command to associate a specified scrub policy with the service profile you used to enter service
profile mode.

Examples This example shows how to set the scrub policy:

switch-A# scope org org10

switch-A /org # scope server-disc-policy sdp100

switch-A /org/rackserver-disc-policy # set scrub-policy scrub101

switch-A /org/rackserver-disc-policy* # commit-buffer

switch-A /org/rackserver-disc-policy #

Related Commands Command Description


show scrub-policy
show rackserver-disc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1383
Commands
set scsi-io count

set scsi-io count


To configure the number of SCSI I/O queue resources to allocate, use the set scsi-io count command.

set scsi-io count count

Syntax Description count Number of queue resources.

Command Default The SCSI I/O queue count is 1.

Command Modes Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to configure the number of SCSI I/O queue resources to allocate. Enter a number between
1 and 8.

Examples This example shows how to configure the SCSI I/O queue for a Fibre Channel policy:
switch-A# scope org
switch-A /org # enter fc-policy FcPolicy19
switch-A /org/fc-policy # set scsi-io count 4
switch-A /org/fc-policy* # set scsi-io ring-size 128
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


set scsi-io ring-size
show scsi-io

Cisco UCS Manager CLI Command Reference, Release 2.0


1384 OL-25718-02
Commands
set scsi-io ring-size

set scsi-io ring-size


To configure the number of descriptors in the SCSI I/O queue, use the set scsi-io ring-size command.

set scsi-io ring-size ring-size

Syntax Description ring-size Number of descriptors.

Command Default The SCSI I/O ring size is 512.

Command Modes Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to configure the number of descriptors in the SCSI I/O queue. Enter a number between 64
and 512.

Examples This example shows how to configure the SCSI I/O queue for a Fibre Channel policy:
switch-A# scope org
switch-A /org # enter fc-policy FcPolicy19
switch-A /org/fc-policy # set scsi-io count 4
switch-A /org/fc-policy* # set scsi-io ring-size 128
switch-A /org/fc-policy* # commit-buffer
switch-A /org/fc-policy #

Related Commands Command Description


set scsi-io count
show scsi-io

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1385
Commands
set send

set send
To set send, use the set send command.

set send {off| on}

Syntax Description off Specifies send off.

on Specifies send on.

Command Default None

Command Modes Flow control policy (/eth-uplink/flow-control/policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify flow control send options.
When you specify off, traffic on the port flows normally regardless of the packet load.
When you specify on, the UCS system sends a pause request to the network if the incoming packet rate
becomes too high. The pause remains in effect for a few milliseconds before traffic is reset to normal levels.

Examples This example shows how to set send:

switch-A# scope eth-uplink

switch-A /eth-uplink # scope flow-control

switch-A /eth-uplink/flow-control # scope policy fcpolicy110

switch-A /eth-uplink/flow-control/policy # set send on

switch-A /eth-uplink/flow-control/policy* # commit-buffer

switch-A /eth-uplink/flow-control/policy #

Related Commands Command Description


show stats-threshold-policy
show policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1386 OL-25718-02
Commands
set send-periodically

set send-periodically
To enable the sending of a periodic Call Home inventory message, use the set send-periodically command.

set send-periodically {off| on}

Syntax Description off Disables a periodic inventory message.

on Enables a periodic inventory message.

Command Default Disabled

Command Modes Inventory (monitoring/callhome/inventory)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to enable the periodic sending of a Call Home inventory message. The periodic message
includes hardware inventory information and an inventory of all software services currently enabled. If the
periodic message is enabled, the default period is 7 days and the default time of day is 00:00.

Examples This example shows how to enable the periodic sending of a Call Home inventory message at 17:30 hours
every 14 days:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # scope inventory
switch-A /monitoring/callhome/inventory # set send-periodically on
switch-A /monitoring/callhome/inventory* # set interval-days 14
switch-A /monitoring/callhome/inventory* # set timeofday-hour 17
switch-A /monitoring/callhome/inventory* # set timeofday-minute 30
switch-A /monitoring/callhome/inventory* # commit-buffer
switch-A /monitoring/callhome/inventory #

Related Commands Command Description


set interval-days
set timeofday-hour
set timeofday-minute
show inventory

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1387
Commands
set server

set server
To specify the remote server on which the firmware download file resides, use the set server command.

set server server

Syntax Description server Specifies the remote server name or IP address.

Command Default None

Command Modes Firmware download task (/firmware/download-task)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the remote server on which the firmware download file resides.

Examples This example shows how to specify the remote server:


switch-A# scope firmware
switch-A /firmware # scope download-task ucs-k9-bundle.1.1.0.279.bin
switch-A /firmware/download-task # set server 192.20.1.28
switch-A /firmware/download-task #

Related Commands Command Description


show download-task

Cisco UCS Manager CLI Command Reference, Release 2.0


1388 OL-25718-02
Commands
set session-timeout

set session-timeout
To set the maximum amount of time that can elapse after the last refresh request before Cisco UCS Manager
considers a web session to have ended, use the set session-timeout command.

set session-timeout seconds

Syntax Description seconds Specify an integer between 60 and 172800.

Command Default By default, the time is set to 7200 seconds.

Command Modes Authentication domain (/security/auth-domain)

Command History Release Modification


2.0(3) This command was introduced.

Usage Guidelines None

Examples This example shows how to set the session timeout to 14400 seconds.
UCS-A # scope security
UCS-A /security # scope auth-domain sample
UCS-A /security/auth-domain # set refresh-period 500
UCS-A /security/auth-domain # set session-timeout 14400
UCS-A /security/auth-domain* # commit-buffer
UCS-A /security/auth-domain #

Related Commands Command Description


set refresh-period

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1389
Commands
set sharing

set sharing
To set a sharing type for the fabric VLAN, use the set sharing command.

set sharing {isolated| none| primary}

Syntax Description isolated Use this option to set the sharing type as isolated.

none Use this option to not set a sharing type for the fabric VLAN.

primary Use this option to set the sharing type as primary.

Command Default None.

Command Modes VLAN (/eth-uplink/fabric/vlan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A VLAN for the fabric must be created to use this command.

Examples This example shows how to set the sharing type to isolated for a fabric VLAN.
Switch-A # scope eth-uplink
Switch-A /eth-uplink # scope fabric
Switch-A /eth-uplink/fabric # scope vlan 200
Switch-A /eth-uplink/fabric/vlan # set sharing isolated
Switch-A /eth-uplink/fabric/vlan* # commit-buffer
Switch-A /eth-uplink/fabric/vlan #

Related Commands Command Description


create vlan
set native
set pubnwname
set vlan-id

Cisco UCS Manager CLI Command Reference, Release 2.0


1390 OL-25718-02
Commands
set site-id

set site-id
To configure customer site identification (ID) information for the monitored equipment, use the set site-id
command.

set site-id site-id

Syntax Description site-id Site identification text information.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to configure customer site ID information to be included in Call Home messages for the
monitored equipment. Enter up to 512 characters. If the information includes spaces, you must enclose your
entry in quotes (" ").

Examples This example shows how to configure the customer site ID:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set side-id SanJose
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1391
Commands
set size

set size
To specify the size of a disk partition, use the set size command.

set size {size| unspecified}

Syntax Description size Specifies the partition size in MBytes.

unspecified Specifies no partition size.

Command Default None

Command Modes Partition (/org/local-disk-config/partition)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the size of a disk partition in MBytes.

Examples This example shows how to specify a 10 GB partition:


server-A# scope org /
server-A /org # scope service-profile ServInst90
server-A /org/service-profile # create local-disk-config
server-A /org/service-profile/local-disk-config* # set mode no-raid
server-A /org/service-profile/local-disk-config* # create partition
server-A /org/service-profile/local-disk-config/partition* # set size 10000
server-A /org/service-profile/local-disk-config/partition* # set type ntfs
server-A /org/service-profile/local-disk-config/partition* # commit-buffer
server-A /org/service-profile/local-disk-config/partition #

Related Commands Command Description


show local-disk-config

Cisco UCS Manager CLI Command Reference, Release 2.0


1392 OL-25718-02
Commands
set snmp community

set snmp community


To set up an SNMP community, use the set snmp community command.

set snmp community community

Syntax Description community Community name. This name can be between 1 and 32 alphanumeric
characters long.

Command Default None

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Cisco recommends that you enable only the communication services that are required to interface with other
network applications.
The community name can be any alphanumeric string. You can create only one community string.

Examples This example shows how to set up an SNMP community:

switch-A#scope monitoring

switch-A /monitoring # set snmp community snmpcom10

switch-A /monitoring* # commit-buffer

switch-A /monitoring #

Related Commands Command Description


show snmp
show snmp-trap

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1393
Commands
set sol-policy

set sol-policy
To set the serial over LAN (SoL) policy, use the set sol-policy command.

set sol-policy name

Syntax Description name SoL policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to associate the specified SoL policy with the service profile you used to enter service
profile mode.

Examples This example shows how to set the SoL policy:

switch-A# scope org org110

switch-A /org # scope service-profile spEast110

switch-A /org/service-profile # set sol-policy apEast110

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show sol-config
show sol-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1394 OL-25718-02
Commands
set speed

set speed
To set the speed, use the set speed command.

memory mode
set speed {speed| unspec}

sol-config and sol-policy modes


set speed {115200| 19200| 38400| 57600| 9600}

Syntax Description speed Baud rate. The range of valid values is 0 to 65535.

unspec Specifies unspecified baud rate.

115200 Specifies 115200 baud rate.

19200 Specifies 19200 baud rate.

38400 Specifies 38400 baud rate.

57600 Specifies 57600 baud rate.

9600 Specifies 9600 baud rate.

Command Default None

Command Modes /org/server-qual/memory


/org/service-profile/sol-config
/org/sol-policy

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the memory data rate.

Examples This example shows how to set the speed:

switch-A# scope org org10

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1395
Commands
set speed

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # scope sol-config

switch-A /org/service-profile/sol-config # set speed 9600

switch-A /org/service-profile/sol-config* # commit-buffer

switch-A /org/service-profile/sol-config #

Related Commands Command Description


show memory
show sol-config

Cisco UCS Manager CLI Command Reference, Release 2.0


1396 OL-25718-02
Commands
set speed (/eth-mon-session)

set speed (/eth-mon-session)


To set the data transfer rate for the port, use the set speed command.

set speed{10 gbps | 1 gbps | 20 gbps | 40 gbps }

Syntax Description 10 gbps Sets the transfer rate to 10 GBPS.

1gbps Sets the transfer rate to 1 GBPS.

20 gbps Sets the transfer rate to 20 GBPS.

40 gbps Sets the transfer rate to 40 GBPS.

Command Default By default, the speed is set to 10 GBPS.

Command Modes Destination Interface (/eth-traffic-mon/fabric/eth-mon-session/dest-interface)

Command History Release Modification


2.0(3) This command was introduced.

Usage Guidelines A destination interface must be created to use this command.

Examples This example shows how to set the data transfer rate to 40 GBPS.
UCS-A # scope eth-traffic-mon
UCS-A /eth-traffic-mon # scope fabric a
UCS-A /eth-traffic-mon/fabric # scope eth-mon-session sample
UCS-A /eth-traffic-mon/fabric/eth-mon-session # scope dest-interface 1 22
UCS-A /eth-traffic-mon/fabric/eth-mon-session/dest-interface # set speed 8gbps
UCS-A /eth-traffic-mon/fabric/eth-mon-session/dest-interface* # commit-buffer
UCS-A /eth-traffic-mon/fabric/eth-mon-session/dest-interface #

Related Commands Command Description


show eth-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1397
Commands
set speed (/fc-mon-session)

set speed (/fc-mon-session)


To set the data transfer rate for the port, use the set speed command.

set speed{1gbps | 2 gbps | 4 gbps | 8 gbps | auto }

Syntax Description 1gbps Sets the transfer rate to 1 GBPS.

2 gbps Sets the transfer rate to 2 GBPS.

4gbps Sets the transfer rate to 4 GBPS.

8gbps Sets the transfer rate to 8 GBPS.

Auto Enables Cisco UCS to determine the transfer rate.

Command Default By default, the speed is set to 2 GBPS.

Command Modes Destination Interface (/fc-traffic-mon/fabric/fc-mon-session/dest-interface)

Command History Release Modification


2.0(3) This command was introduced.

Usage Guidelines A destination interface must be created to use this command.

Examples This example shows how to set the data transfer rate to 8 GBPS.
UCS-A # scope fc-traffic-mon
UCS-A /fc-traffic-mon # scope fabric a
UCS-A /fc-traffic-mon/fabric # scope fc-mon-session sample
UCS-A /fc-traffic-mon/fabric/fc-mon-session # scope dest-interface 1 22
UCS-A /fc-traffic-mon/fabric/fc-mon-session/dest-interface # set speed 8gbps
UCS-A /fc-traffic-mon/fabric/fc-mon-session/dest-interface* # commit-buffer
UCS-A /fc-traffic-mon/fabric/fc-mon-session/dest-interface #

Related Commands Command Description


show fc-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


1398 OL-25718-02
Commands
set speed (Uplink Ethernet Port)

set speed (Uplink Ethernet Port)


To set the speed for an uplink Ethernet port, use the set speed command.

set speed{10gbps| 1gbps}

Syntax Description 10gbps Sets the speed to 10 gbps

1gbps Sets the speed to 1 gbps

Command Default 10gbps

Command Modes Fabric interconnect under Ethernet server (/eth-server/fabric)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to set the speed on an uplink Ethernet port.

Examples This example shows how to set the speed:

switch-A# scope eth-uplink

switch-A /eth-uplink # scope fabric a

switch-A /eth-uplink/fabric # scope interface 2 2

switch-A /eth-uplink/fabric* # set speed 10gbps

switch-A /eth-uplink/fabric # commit-buffer

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1399
Commands
set src-templ-name

set src-templ-name
To set the source template name, use the set src-templ-name command.

set src-templ-name name

Syntax Description name Source template name. The range of valid values is 1 to 16.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to associate the specified source template with the service profile you used to enter service
profile mode.

Examples This example shows how to set the source template name:

switch-A# scope org org110

switch-A /org # scope service-profile spEast110

switch-A /org/service-profile # set src-templ-name srcTempName110

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show service-policy
show vhba-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


1400 OL-25718-02
Commands
set sshkey

set sshkey
To set an SSH key, use the set sshkey command.

set sshkey [key | none]

Syntax Description key SSH key.

Command Default None

Command Modes Security (/security)


Local user (/security/local-user)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the SSH key used for passwordless access.

Examples This example shows how to set an SSH key:

switch-A# scope security

switch-A /security # set sshkey "ssh-rsa


AAAAB3NzaC1yc2EAAAABIwAAAIEAuo9VQ2CmWBI9/S1f30klCWjnV3lgdXMzO0W
Ul5iPw85lkdQqap+NFuNmHcb4K iaQB8X/PDdmtlxQQcawclj+k8f4VcOelBxls
Gk5luq5ls1ob1VOIEwcKEL/h5lrdbNlI8y3SS9I/gGiBZ9ARlop9LDpD m8HPh2
LOgyH7Ei1MI8="

switch-A /security* # commit-buffer

switch-A /security #

Related Commands Command Description


show keyring
show trustpoint

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1401
Commands
set ssl

set ssl
To enable or disable SSL when communicating with an LDAP server, use the set ssl command.

set ssl {no| yes}

Syntax Description no Encryption is disabled. Authentication information is sent as clear text.

yes Encryption is required. If encryption cannot be negotiated, the connection fails.

Command Modes LDAP Server (/security/ldap/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to enable or disable SSL encryption when communicating with the LDAP server.

Examples This example shows how to set up SSL on a server:


switch-A# scope security
switch-A /security # scope ldap
switch-A /security/ldap # create server 192.0.20.246
switch-A /security/ldap/server* # set ssl yes
switch-A /security/ldap/server* # set port 389
switch-A /security/ldap/server* # set binddn
"cn=Administrator,cn=Users,DC=cisco-ucsm-aaa3,DC=qalab,DC=com"
switch-A /security/ldap/server* # commit-buffer
switch-A /security/ldap/server #

Related Commands Command Description


show ldap
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


1402 OL-25718-02
Commands
set uefi-os-legacy-video-config legacy-video

set uefi-os-legacy-video-config legacy-video


To set the Uefi operating system legacy video configuration, use the set uefi-os-legacy-video-config
legacy-video command.

set uefi-os-legacy-video-config legacy-video {disabled| enabled| platform-default}

Syntax Description disabled Disables the Uefi operating system legacy video configuration.

enabled Enables the Uefi operating system legacy video configuration.

platform-default Sets the Uefi operating system legacy video configuration to the platform
default option.

Command Default Platform default

Command Modes BIOS Policy (/org/bios-policy

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A BIOS policy for an organization must be created to use this command.

Examples This example shows how to enable the Uefi OS legacy video configuration.
UCS-A # scope org Test
UCS-A /org # scope bios-policy sample
UCS-A /org/bios-policy # set uefi-os-legacy-video-config legacy-video enabled
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


show uefi-os-legacy-video-config

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1403
Commands
set state

set state
To specify the name of the state or province in which the company requesting the certificate is headquartered,
use the set state command.

set state State, province or county name

Syntax Description State, province or county name The name of the state, province or county in which the organization
requesting the certificate is headquartered. The name can include a maximum
of 64 characters and can be alphanumeric.

Command Default None

Command Modes Certificate Request (/security/keyring/certreq)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines You should create a certificate request before specifying the state details.

Examples The following example shows how to set the state information for a certificate request.
UCS-A # scope security
UCS-A /security # scope keyring test
UCS-A /security/keyring # create certreq
UCS-A /security/keyring/certreq* # set state New York
UCS-A /security/keyring/certreq* # commit buffer
UCS-A /security/keyring/certreq #

Related Commands Command Description


set country

set dns

set e-mail

set ip

set locality

set org-name

Cisco UCS Manager CLI Command Reference, Release 2.0


1404 OL-25718-02
Commands
set state

Command Description
set org-unit-name

set subject-name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1405
Commands
set stats-policy

set stats-policy
To set the statistics policy, use the set stats-policy command.

set stats-policy name

Syntax Description name Statistics policy name. The range of valid values is 1 to 16.

Command Default None

Command Modes Virtual NIC template (/org/vnic-templ)


Virtual NIC (/org/service-profile/vnic)
Service profile (/org/service-profile)
Virtual HBA template (/org/vhba-templ)
Virtual HBA (/org/service-profile/vhba)

Command History Release Modification


1.0(1) This command was introduced.

Use this command to associate the specified statistics policy with the service profile you used to enter service
profile mode, or the template you used to enter virtual NIC template or virtual HBA template modes.

Examples This example shows how to set the statistics policy:

switch-A# scope org org110

switch-A /org # scope service-profile spEast110

switch-A /org/service-profile # set stats-policy statsEast110

switch-A /org/service-profile* # commit-buffer

switch-A /org/service-profile #

Related Commands Command Description


show service-profile
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1406 OL-25718-02
Commands
set stepping

set stepping
To set stepping, use the set stepping command.

set stepping {number| unspecified}

Syntax Description number Stepping number. The range of valid value is 0 to 4294967295.

unspecified Specifies an unspecified stepping number.

Command Default None

Command Modes Processor (/org/server-qual/processor)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the processor stepping number.

Examples This example shows how to set the minimum number of cores:

switch-A# scope org org3

switch-A /org # scope server-qual squal10

switch-A /org/server-qual # scope processor

switch-A /org/server-qual/processor # set stepping 1

switch-A /org/server-qual/processor* # commit-buffer

switch-A /org/server-qual/processor #

Related Commands Command Description


show memory
show processor

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1407
Commands
set street-address

set street-address
To configure a street address that will appear in Call Home messages, use the set street-address command.

set street-address street-address

Syntax Description street-address Mailing address text information.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Usage Guidelines Use this command to configure a mailing address for sending RMA replacement equipment. Enter up to 255
characters. If the information includes spaces, you must enclose your entry in quotes (" ").

Examples This example shows how to configure a street address:


switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set street-address "123 Example St., San Jose, CA 95134"
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


1408 OL-25718-02
Commands
set subject-name

set subject-name
To specify the certificate request subject name, use the set subject-name command.

set subject-name Certificate request subject name

Syntax Description Certificate request subject name The subject name of the certificate request. The name can be
alphanumeric.

Command Default None

Command Modes Certificate Request (/security/keyring/certreq)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines You should create a certificate request before specifying the subject name details.

Examples The following example shows how to set the subject name information for a certificate request.
UCS-A # scope security
UCS-A /security # scope keyring test
UCS-A /security/keyring # create certreq
UCS-A /security/keyring/certreq* # set subject-name bgdl-samc1
UCS-A /security/keyring/certreq* # commit buffer
UCS-A /security/keyring/certreq #

Related Commands Command Description


set country

set dns

set e-mail

set ip

set locality

set org-name

set org-unit-name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1409
Commands
set subject-name

Command Description
set state

Cisco UCS Manager CLI Command Reference, Release 2.0


1410 OL-25718-02
Commands
set subnet

set subnet
To set a subnet for an external management static IP address, use the set subnet command.

set subnet subnet

Syntax Description subnet The subnet that you would like to set. It must be in the a.b.c.d format.

Command Default None

Command Modes External management static IP within CIMC (/chassis/server/cimc/ext-static-ip)


External management static IP within service profile (/org/service-profile/ext-static-ip)
Static IP parameters (/org/service-profile/vnic-iscsi/eth-if/ip-if/static-ip-params)

Command History Release Modification


1.4(1) This command was introduced.

2.0(1) This command was introduced in the static IP parameters command mode
(/org/service-profile/vnic-iscsi/eth-if/ip-if/static-ip-params).

Usage Guidelines You must create a service profile before you use this command in the organization command mode.

Examples This example shows how to set the subnet for an external management static IP address of a service profile:
UCS-A # scope org
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope ext-static-ip
UCS-A /org/service-profile/ext-static-ip # set subnet 1.2.3.4
UCS-A /org/service-profile/ext-static-ip* # commit-buffer
UCS-A /org/service-profile/ext-static-ip #

Related Commands Command Description


create service-profile
scope server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1411
Commands
set switch-priority

set switch-priority
To configure the urgency level for Call Home messages, use the set switch-priority command.

set switch-priority {emergencies| alerts| critical| errors| warnings| notifications| information| debugging}

Syntax Description switch-priority options Specifies the message urgency threshold for Call Home messages. See
Usage Guidelines for the urgency level options.

Command Default None

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to specify the message urgency threshold for Call Home messages.
The following table shows the level options in order of decreasing urgency:

emergencies Emergency level (0)

alerts Alert level (1)

critical Critical level (2)

errors Error level (3)

warnings Warning level (4)

notifications Notification level (5)

information Information level (6)

debugging Debug level (7)

Cisco UCS Manager CLI Command Reference, Release 2.0


1412 OL-25718-02
Commands
set switch-priority

Examples This example shows how to specify the urgency level as Critical:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set switch-priority critical
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1413
Commands
set syslog console

set syslog console


To configure which syslog messages are sent to the console, use the set syslog console command.

set syslog console level {alerts| critical| emergencies}+

Syntax Description level Specifies the message urgency


threshold for the syslog console.

emergencies Specifies Emergency (0) level, the


highest urgency messages.

alerts Specifies Alert (1) level.

critical Specifies Critical (2) level.

Command Default The default level is Critical.

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

1.3(1) The state keyword was deprecated.

Usage Guidelines Use this command to set the urgency threshold level for syslog console messages. After configuring the syslog
console information, you must enable the sending of messages using the enable syslog command.

Note The state keyword is deprecated. Use the enable syslog console or disable syslog console commands
to enable or disable the syslog console.

Examples This example shows how to set the urgency threshold level of syslog console messages to alerts:
switch-A# scope monitoring
switch-A /monitoring # set syslog console level alerts
switch-A /monitoring* # enable syslog console
switch-A /monitoring* # commit-buffer
switch-A # /monitoring #

Cisco UCS Manager CLI Command Reference, Release 2.0


1414 OL-25718-02
Commands
set syslog console

Related Commands Command Description


enable syslog
show syslog

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1415
Commands
set syslog file

set syslog file


To configure a syslog file, use the set syslog file command.

set syslog file {level {emergencies| alerts| critical| errors| warnings| notifications| information| debugging}|
name name| size size}+

Syntax Description level Specifies the message urgency threshold for the syslog file. See Usage Guidelines
for the level options.

name Specifies the syslog file name.

name Name of the file. The file name can be up to 16 characters.

size Specifies file size.

size File size in bytes. The range of valid values is 4096 to 4194304.

Command Default The default level is Critical and the default file size is 4194304 bytes.

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

1.3(1) The state keyword was deprecated.

Usage Guidelines Use this command to set the file name, the maximum file size, and the urgency threshold level of syslog
messages for the syslog file. After configuring the syslog file information, you must enable the writing of
messages to the file using the enable syslog command.
The following table shows the level options in order of decreasing urgency.

emergencies Emergency level (0)

alerts Alert level (1)

critical Critical level (2)

errors Error level (3)

Cisco UCS Manager CLI Command Reference, Release 2.0


1416 OL-25718-02
Commands
set syslog file

warnings Warning level (4)

notifications Notification level (5)

information Information level (6)

debugging Debug level (7)

Note The state keyword is deprecated. Use the enable syslog file or disable syslog file commands to enable
or disable the syslog file.

Examples This example shows how to enable the syslog file and configure the name, size, and urgency level:
switch-A# scope monitoring
switch-A /monitoring # enable syslog file
switch-A /monitoring* # set syslog file name logsSanJose7
switch-A /monitoring* # set syslog file size 4096
switch-A /monitoring* # set syslog file level alerts
switch-A /monitoring* # commit-buffer
switch-A /monitoring #

Related Commands Command Description


enable syslog
show syslog

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1417
Commands
set syslog monitor

set syslog monitor


To configure syslog monitoring by the operating system, use the set syslog monitor command.

set syslog monitor level {emergencies| alerts| critical| errors| warnings| notifications| information|
debugging}+

Syntax Description level Specifies the message urgency threshold for the syslog monitor. See Usage Guidelines
for the level options.

Command Default The default level is Critical.

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

1.3(1) The state keyword was deprecated.

Usage Guidelines Use this command to set the urgency threshold level of syslog messages to monitor. After configuring the
syslog monitor information, you must enable monitoring using the enable syslog command.
The following table shows the level options in order of decreasing urgency.

emergencies Emergency level (0)

alerts Alert level (1)

critical Critical level (2)

errors Error level (3)

warnings Warning level (4)

notifications Notification level (5)

information Information level (6)

debugging Debug level (7)

Cisco UCS Manager CLI Command Reference, Release 2.0


1418 OL-25718-02
Commands
set syslog monitor

Note Messages at levels below Critical are displayed on the terminal monitor only if you have entered the
terminal monitor command.

Note The state keyword is deprecated. Use the enable syslog monitor or disable syslog monitor commands
to enable or disable the syslog monitor.

Examples This example shows how to enable the syslog monitor and configure the urgency threshold level of syslog
messages to monitor:
switch-A# scope monitoring
switch-A /monitoring # enable syslog monitor
switch-A /monitoring* # set syslog monitor level warnings
switch-A /monitoring* # commit-buffer
switch-A /monitoring #

Related Commands Command Description


enable syslog
show syslog
terminal monitor

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1419
Commands
set syslog remote-destination

set syslog remote-destination


To configure sending of syslog messages to a remote destination, use the set syslog remote-destination
command.

set syslog remote-destination {server-1| server-2| server-3} {level {emergencies| alerts| critical| errors|
warnings| notifications| information| debugging}| hostname hostname| facility {local0| local1| local2|
local3| local4| local5| local6| local7}}+

Syntax Description server-1 Specifies server 1.

server-2 Specifies server 2.

server-3 Specifies server 3.

level Specifies the message urgency threshold for sending to the remote
destination. See Usage Guidelines for the level options.

hostname Specifies host name.

hostname Host name. The name can be from 1 to 256 characters.

facility Specifies the facility number for the messages sent to the remote destination.

local n The local facility number. The range of valid values is local0 through
local7.

Command Default The default for Hostname is None. The default level is Critical.

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

1.3(1) The state keyword was deprecated.

Usage Guidelines Use this command to configure the host name, message urgency level, and facility number for the sending of
syslog messages to a remote syslog server. After configuring the remote server information, you must enable
the sending of messages using the enable syslog command. You can independantly configure and enable
up to three remote servers using the server- n keyword.

Cisco UCS Manager CLI Command Reference, Release 2.0


1420 OL-25718-02
Commands
set syslog remote-destination

The following table shows the level options in order of decreasing urgency.

emergencies Emergency level (0)

alerts Alert level (1)

critical Critical level (2)

errors Error level (3)

warnings Warning level (4)

notifications Notification level (5)

information Information level (6)

debugging Debug level (7)

Note The state keyword is deprecated. Use the enable syslog remote-destination or disable syslog
remote-destination commands to enable or disable the syslog remote-destination.

Examples This example shows how to enable and configure a syslog remote destination:
switch-A# scope monitoring
switch-A /monitoring # enable syslog remote-destination server-1
switch-A /monitoring* # set syslog remote-destination server-1 hostname ITEast1 level alerts
switch-A /monitoring* # commit-buffer

switch-A /monitoring #

Related Commands Command Description


enable syslog
show syslog

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1421
Commands
set target

set target
To set a target, use the set target command.

set target {a| b}{port slot-id/port-id | port-channel id}

Syntax Description a Specifies switch A.

b Specifies switch B.

port Specifies port.

slot-id/port-id Specifies the slot and port identification number.

port-channel Specifies port channel.

id Specifies the port channel identification number.

Command Default None

Command Modes Pin group under Fibre Channel uplink (/fc-uplink/pin-group)


Pin group under Ethernet uplink (/eth-uplink/pin-group)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to set the Fibre Channel or Ethernet pin target to the specified switch and port, or switch
and port channel. Scope to /fc-uplink/pin-group to set the Fibre Channel pin target. Scope to
/eth-uplink/pin-group to set the Ethernet pin target.

Examples This example shows how to set a target:

switch-A# scope eth-uplink

switch-A /eth-uplink # scope pin-group pinGroupOne

switch-A /eth-uplink/pin-group # set target a port 1/1

switch-A /eth-uplink/pin-group* # commit-buffer

switch-A /eth-uplink/pin-group #

Cisco UCS Manager CLI Command Reference, Release 2.0


1422 OL-25718-02
Commands
set target

Related Commands Command Description


show pin-group
show target

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1423
Commands
set template

set template
To specify a service profile template, use the set template command.

set template template

Syntax Description template Specifies the name of a service profile template. Enter up to 32 characters.

Command Default None

Command Modes Server automatic configuration policy (/org/server-autoconfig-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify a service profile template for creating a service profile instance for the server.

Examples The following example shows how to specify a service profile template:
switch-A# scope org /
switch-A /org # create server-autoconfig-policy AutoConfigFinance
switch-A /org/server-autoconfig-policy* # set destination org finance
switch-A /org/server-autoconfig-policy* # set qualifier ServPoolQual22
switch-A /org/server-autoconfig-policy* # set template ServTemp2
switch-A /org/server-autoconfig-policy* # commit-buffer
switch-A /org/server-autoconfig-policy #

Related Commands Command Description


show server-autoconfig-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1424 OL-25718-02
Commands
set template-name

set template-name
To set the template name, use the set template-name command.

set template-name name

Syntax Description name Template name. The range of valid values is 1 to 16.

Command Default None

Command Modes vNIC (/org/service-profile/vnic)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # scope vnic vnic10

switch-A /org/service-profile/vnic # set template-name temp10

switch-A /org/service-profile/vnic* # commit-buffer

switch-A /org/service-profile/vnic #

Related Commands Command Description


show vhba
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1425
Commands
set throttling

set throttling
To limit the number of Call Home messages received for the same event, use the set throttling command.

set throttling {off| on}

Syntax Description off Disables limiting of duplicate messages.

on Enables limiting of duplicate messages.

Command Default Enabled

Command Modes Callhome (/monitoring/callhome)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to limit the number of Call Home messages received for the same event. If the number of
messages sent exceeds a maximum limit within a preset time frame, further messages for that alert type are
discarded within that time frame.

Examples This example shows how to enable throttling of duplicate Call Home messages:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # set throttling on
switch-A /monitoring/callhome* # commit-buffer
switch-A /monitoring/callhome #

Related Commands Command Description


show callhome

Cisco UCS Manager CLI Command Reference, Release 2.0


1426 OL-25718-02
Commands
set timeofday-hour

set timeofday-hour
To configure the hour of the day for sending a periodic Call Home inventory message, use the set
timeofday-hour command.

set timeofday-hour hour

Syntax Description hour The hour of day.

Command Default The default time of day is 00:00.

Command Modes Inventory (/monitoring/callhome/inventory)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to configure the hour of day for sending a periodic Call Home inventory message. The
range is 0 to 23; the default is 0.

Examples This example shows how to enable the periodic sending of a Call Home inventory message at 17:30 hours
every 14 days:
UCS-A# scope monitoring
UCS-A /monitoring # scope callhome
UCS-A /monitoring/callhome # scope inventory
UCS-A /monitoring/callhome/inventory # set send-periodically on
UCS-A /monitoring/callhome/inventory* # set interval-days 14
UCS-A /monitoring/callhome/inventory* # set timeofday-hour 17
UCS-A /monitoring/callhome/inventory* # set timeofday-minute 30
UCS-A /monitoring/callhome/inventory* # commit-buffer
UCS-A /monitoring/callhome/inventory #

Related Commands Command Description


set interval-days
set send-periodically
set timeofday-minute
show inventory

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1427
Commands
set timeofday-minute

set timeofday-minute
To configure the minutes field of the time of day for sending a periodic Call Home inventory message, use
the set timeofday-minute command.

set timeofday-minute minute

Syntax Description minute The minute of the hour of day.

Command Default The default time of day is 00:00.

Command Modes Inventory (/monitoring/callhome/inventory)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to configure the minutes field of the time of day for sending a periodic Call Home inventory
message. The range is 0 to 59; the default is 0.

Examples This example shows how to enable the periodic sending of a Call Home inventory message at 17:30 hours
every 14 days:
UCS-A# scope monitoring
UCS-A /monitoring # scope callhome
UCS-A /monitoring/callhome # scope inventory
UCS-A /monitoring/callhome/inventory # set send-periodically on
UCS-A /monitoring/callhome/inventory* # set interval-days 14
UCS-A /monitoring/callhome/inventory* # set timeofday-hour 17
UCS-A /monitoring/callhome/inventory* # set timeofday-minute 30
UCS-A /monitoring/callhome/inventory* # commit-buffer
UCS-A /monitoring/callhome/inventory #

Related Commands Command Description


set interval-days
set send-periodically
set timeofday-hour
show inventory

Cisco UCS Manager CLI Command Reference, Release 2.0


1428 OL-25718-02
Commands
set timeout

set timeout
To set a timeout, use the set timeout command.

set timeout timeout

Syntax Description timeout Timeout interval, in seconds. The range of valid values is 1 to 60.

Command Default None

Command Modes TACACS (/security/tacacs)


RADIUS (/security/radius)
LDAP (/security/ldap)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set a timeout:

switch-A#scope security

switch-A /security # scope ldap

switch-A /security/ldap # set timeout 30

switch-A /security/ldap* # commit-buffer

switch-A /security/ldap #

Related Commands Command Description


show ldap
show tacacs

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1429
Commands
set timezone

set timezone
To set the time zone for system services, use the set timezone command.

set timezone

Command Default The time zone is UTC.

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to set the time zone for system services that require time of day. You are prompted with
a sequence of choices to select your time zone.

Examples This example shows how to select the time zone for Los Angeles:
UCS-A# scope system
UCS-A /system # scope services
UCS-A /system/services # set timezone
Please identify a location so that time zone rules can be set correctly.
Please select a continent or ocean.
1) Africa 4) Arctic Ocean 7) Australia 10) Pacific Ocean
2) Americas 5) Asia 8) Europe
3) Antarctica 6) Atlantic Ocean 9) Indian Ocean
#? 2
Please select a country.
1) Anguilla 18) Ecuador 35) Paraguay
[...truncated...]
11) Cayman Islands 28) Jamaica 45) United States
[...truncated...]
#? 45
Please select one of the following time zone regions.
1) Eastern Time
[...truncated...]
15) Mountain Standard Time - Arizona
16) Pacific Time
17) Alaska Time
[...truncated...]
#? 16
The following information has been given:
United States
Pacific Time
Therefore timezone 'America/Los_Angeles' will be set.
Local time is now: Fri May 15 07:39:25 PDT 2009.
Universal Time is now: Fri May 15 14:39:25 UTC 2009.
Is the above information OK?
1) Yes
2) No
#? 1
UCS-A /system/services #

Cisco UCS Manager CLI Command Reference, Release 2.0


1430 OL-25718-02
Commands
set timezone

Related Commands Command Description


show clock
show timezone

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1431
Commands
set total

set total
To set the maximum number of concurrent web sessions for all users, use the set total command.

set total maximum number of sessions

Syntax Description maximum number of sessions The total number of concurrent web sessions. The value must be a
number between 1 and 256.

Command Default By default, the number of concurrent web sessions for all users is set to the maximum of 256.

Command Modes Web session limits (/system/services/web-session-limits)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines The value for the maximum number of concurrent sessions for all users must be a number between 1 and 256.

Examples This example shows how to set the total number of concurrent web sessions for all users to 30.
Switch-A # scope system
Switch-A /system # scope services
Switch-A /system/services # scope web-session-limits
Switch-A /system/services/web-session-limits # set total 30
Switch-A /system/services/web-session-limits* # commit-buffer
Switch-A /system/services/web-session-limits #

Related Commands Command Description


set per-user

scope web-session-limits

Cisco UCS Manager CLI Command Reference, Release 2.0


1432 OL-25718-02
Commands
set trans-queue count

set trans-queue count


To configure the number of transmit queue resources to allocate, use the set trans-queue count command.

set trans-queue count count

Syntax Description count Number of queue resources.

Command Default The transmit queue count is 1.

Command Modes Ethernet adapter policy (/org/eth-policy)


Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to configure the number of transmit queue resources to allocate. Enter a number between
1 and 256.
This command replaces the set work-queue count command.

Examples This example shows how to configure the number of transmit queue resources for an Ethernet policy:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set recv-queue count 100
switch-A /org/eth-policy* # set trans-queue count 100
switch-A /org/eth-policy* # set comp-queue count 200
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


set trans-queue ring-size
show eth-policy
show fc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1433
Commands
set trans-queue ring-size

set trans-queue ring-size


To configure the number of descriptors in the transmit queue, use the set trans-queue ring-size command.

set trans-queue ring-size ring-size

Syntax Description ring-size Number of descriptors.

Command Default The transmit queue ring size is 256.

Command Modes Ethernet adapter policy (/org/eth-policy)


Fibre Channel adapter policy (/org/fc-policy)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Use this command to configure the number of descriptors in the transmit queue. Enter a number between 64
and 4096.
This command replaces the set work-queue ring-size command.

Examples This example shows how to configure the transmit queue ring size for an Ethernet policy:
switch-A# scope org
switch-A /org # enter eth-policy EthPolicy19
switch-A /org/eth-policy # set trans-queue count 100
switch-A /org/eth-policy* # set trans-queue ring-size 1024
switch-A /org/eth-policy* # commit-buffer
switch-A /org/eth-policy #

Related Commands Command Description


set trans-queue count
show eth-policy
show fc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1434 OL-25718-02
Commands
set trustpoint

set trustpoint
To specify the trustpoint for a keyring, use the set trustpoint command.

set trustpoint trustpoint

Syntax Description trustpoint Name of a defined trustpoint.

Command Default None

Command Modes Keyring (/security/keyring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the trustpoint for a keyring. The trustpoint name can be up to 16 characters.

Examples This example shows how to specify the trustpoint for a keyring:
switch-A# scope security
switch-A /security # scope keyring MyKR05
switch-A /security/keyring # set trustpoint CiscoCA5
switch-A /security/keyring* # commit-buffer
switch-A /security/keyring #

Related Commands Command Description


create trustpoint

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1435
Commands
set type (backup)

set type (backup)


To specify the configuration and state information to be backed up, use the set type command.

set type {all-configuration| logical-configuration| system-configuration| full-state}

Syntax Description all-configuration Backup server, fabric, and system-related configuration.

logical-configuration Backup fabric and server-related configuration.

system-configuration Backup system-related configuration.

full-state Backup full state for disaster recovery.

Command Default All configuration information (server, fabric, and system-related) is backed up.

Command Modes System backup (/system/backup)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the configuration and state information to be backed up.

Examples This example specifies that fabric and server-related configuration are to be backed up:
server-A# scope system
server-A /system # create backup ftp: full-state enabled
Password:
server-A /system/backup* # set type logical-configuration
server-A /system/backup* # commit-buffer
server-A /system/backup #

Related Commands Command Description


show backup

Cisco UCS Manager CLI Command Reference, Release 2.0


1436 OL-25718-02
Commands
set type (partition)

set type (partition)


To specify the file system of a disk partition, use the set type command.

set type {ext2| ext3| fat32| none| ntfs| swap}

Syntax Description ext2 The partition uses the EXT2 file system.

ext3 The partition uses the EXT3 file system.

fat32 The partition uses the FAT32 file system.

none The partition uses no file system.

ntfs The partition uses the NTFS file system.

swap The partition is used as swap space.

Command Default None

Command Modes Partition (/org/local-disk-config/partition)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the file system of a disk partition.

Examples This example shows how to specify the NTFS file system for a new partition:
server-A# scope org /
server-A /org # scope service-profile ServInst90
UCS-A /org/service-profile # create local-disk-config
UCS-A /org/service-profile/local-disk-config* # set mode no-raid
UCS-A /org/service-profile/local-disk-config* # create partition
UCS-A /org/service-profile/local-disk-config/partition* # set size 10000
UCS-A /org/service-profile/local-disk-config/partition* # set type ntfs
UCS-A /org/service-profile/local-disk-config/partition* # commit-buffer
UCS-A /org/service-profile/local-disk-config/partition #

Related Commands Command Description


show local-disk-config

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1437
Commands
set type (template)

set type (template)


To set the updating policy of a template, use the set type command.

set type {initial-template| updating-template}

Syntax Description initial-template Instances created from this template will not automatically update if this
template is updated.

updating-template Instances created from this template will automatically update if this
template is updated.

Command Default Instances created from this template will not automatically update if this template is updated.

Command Modes Virtual HBA template (/org/vhba-templ)


Virtual NIC template (/org/vnic-templ)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to set the updating policy of a vHBA (virtual host bus adapter) or vNIC (virtual network
interface card) template.

Examples This example shows how to specify that instances created from a vNIC template will automatically update if
the template is updated:
switch-A# scope org org10
switch-A /org # scope vnic-templ sp10
switch-A /org/vnic-templ # set type updating-template
switch-A /org/vnic-templ* # commit-buffer
switch-A /org/vnic-templ #

Related Commands Command Description


show vhba-templ
show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


1438 OL-25718-02
Commands
set units

set units
To set memory units, use the set units command.

set units {units| unspec}

Syntax Description units Memory units. The range of valid values is 0 to 65535.

unspec Specifies unspecified memory units.

Command Default None

Command Modes /org/server-qual/memory


/org/server-qual/storage

Command History Release Modification


1.0 This command was introduced.

Usage Guidelines Memory units refer to the DRAM chips mounted on the PCB.

Examples This example shows how to set memory units:

switch-A# scope org org10

switch-A /org # scope server-qual squal10

switch-A /org/server-qual # scope memory

switch-A /org/server-qual/memory # set units 1000

switch-A /org/server-qual/memory* # commit-buffer

switch-A /org/server-qual/memory #

Related Commands Command Description


show memory
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1439
Commands
set uplink-fail-action

set uplink-fail-action
To set an uplink fail action, use the set uplink-fail-action command.

set uplink-fail-action {link-down| warning}

Syntax Description link-down Specifies that down virtual interfaces are marked link down.

warning Specifies that a fault is generated for down virtual interfaces.

Command Default None

Command Modes Network control policy within the organization command mode (/org/nw-ctrl-policy)
Network control policy within Ethernet storage command mode (/eth-storage/nw-ctrl-policy)

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines This configuration will be applicable only in end host mode (default mode).
Warning is useful when you want to maintain blade-to-blade connectivity inside the UCSM system when all
uplink ports go down. You do this, however, at the expense of not providing fabric failover when uplink
connectivity is lost.

Examples This example shows how to set an uplink fail action:

UCS-A # scope org org100


UCS-A /org # scope nw-ctrl-policy nCP100
UCS-A /org/nw-ctrl-policy # set uplink-fail-action warning
UCS-A /org/nw-ctrl-policy* # commit-buffer
UCS-A /org/nw-ctrl-policy #

Related Commands Command Description


show nw-ctrl-policy
show service-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1440 OL-25718-02
Commands
set uplink-trunking

set uplink-trunking
To set uplink trunking for a Fabric, use the set uplink-trunking command.

set uplink-trunking {disabled| enabled}

Syntax Description disabled Disables uplink trunking for a Fabric.

enabled Enables uplink trunking for a Fabric.

Command Default None

Command Modes Fabric (/fc-uplink/fabric)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to enable uplink trunking for a Fabric:
UCS-A # scope fc-uplink
UCS-A /fc-uplink # scope fabric a
UCS-A /fc-uplink/fabric # set uplink-trunking enabled
UCS-A /fc-uplink/fabric* # commit-buffer
UCS-A /fc-uplink/fabric #

Related Commands Command Description


show fabric

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1441
Commands
set usb-boot-config make-device-non-bootable

set usb-boot-config make-device-non-bootable


To modify the boot option for a USB device, use the set usb-boot-config make-device-non-bootable
command.

set usb-boot-config make-device-non-bootable {disabled| enabled| platform-default}

Syntax Description disabled Use this option to disable the USB device from being configured as
non-bootable.

enabled Use this option to enable the USB device to be booted.

platform-default Use this option to set the USB device boot configuration to be the same as
the default option of the platform.

Command Default Platform default

Command Modes BIOS Policy (/org/bios-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A BIOS policy must be configured to use this command.

Examples This example shows how to enable the boot configuration for USB drive.
UCS-A # scope org
UCS-A /org # scope bios-policy test
UCS-A /org/bios-policy # set usb-boot-config make-device-non-bootable enabled
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


create bios-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1442 OL-25718-02
Commands
set usb-front-panel-access-lock-config usb-front-panel-lock

set usb-front-panel-access-lock-config usb-front-panel-lock


To set a locking configuration for the USB front panel access, use the set usb-front-panel-access-lock-config
usb-front-panel-lock command.

set usb-front-panel-access-lock-config usb-front-panel-lock {disabled| enable| platform-default}

Syntax Description disabled Disables the front panel locking configuration.

enable Enables the front panel locking configuration.

platform-default Sets the front panel locking configuration to the platform default option.

Command Default Platform default

Command Modes BIOS policy (/org/bios-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a BIOS policy before you use this command.

Examples This example shows how to set the USB front panel locking configuration to the platform default option:
UCS-A # scope org test
UCS-A /org # scope bios-policy sample
UCS-A /org/bios-policy # set usb-front-panel-access-lock-config usb-front-panel-lock
platform-default
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


set usb-boot-config make-device-non-bootable

set usb-system-idle-power-optimizing-setting-config usb-idle-power-optimizing

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1443
Commands
set usb-system-idle-power-optimizing-setting-config usb-idle-power-optimizing

set usb-system-idle-power-optimizing-setting-config
usb-idle-power-optimizing
To set the power optimization schedule when the USB system is idle, use the set
usb-system-idle-power-optimizing-setting-config usb-idle-power-optimizing command.

set usb-system-idle-power-optimizing-setting-config usb-idle-power-optimizing {high-performance|


lower-idle-power| platform-default}

Syntax Description high-performance Sets power optimization schedule to high-performance.

lower-idle-power Sets power optimization schedule to lower-idle-power.

platform-default Sets power optimization schedule to the platform default option.

Command Default Platform default

Command Modes BIOS (/org/bios-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must create a BIOS policy before you use this command.

Examples This example shows how to set the USB system power optimization schedule to the platform default option:
UCS-A # scope org test
UCS-A /org # scope bios-policy sample
UCS-A /org/bios-policy # set usb-system-idle-power-optimizing-setting-config
usb-idle-power-optimizing platform-default
UCS-A /org/bios-policy* # commit-buffer
UCS-A /org/bios-policy #

Related Commands Command Description


set usb-boot-config make-device-non-bootable

set usb-front-panel-access-lock-config usb-front-panel-lock

Cisco UCS Manager CLI Command Reference, Release 2.0


1444 OL-25718-02
Commands
set user

set user
To specify a user name for logging in to a remote server, use the set user command.

set user user

Syntax Description user Specifies the user name.

Command Default None

Command Modes Configuration import (/system/import-config)


System backup (/system/backup)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the user name for logging in to a remote server for a file transfer.

Examples This example specifies the user name for logging in to a remote file server:
server-A# scope system
server-A /system # scope import-config host35
server-A /system/import-config # set user User13
server-A /system/import-config* # commit-buffer
server-A /system/import-config #

Related Commands Command Description


show backup
show import-config

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1445
Commands
set user-id

set user-id
To set a user identification for an iSCSI authentication profile, use the set user-id command.

set user-id user-id

Syntax Description user-id The user identification for an ISCSI authentication profile. The value can include
a maximum of 128 characters.

Command Default None

Command Modes iSCSI Authentication Profile (/org/iscsi-auth-profile)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines An iSCSI authentication profile must be created to use this command.
The name of the user ID can include a maximum of 128 characters. The name can be alphanumeric and can
include special characters.

Examples This example shows how to set the user ID for an ISCSI authentication profile.
UCS-A # scope org test
UCS-A /org # create auth-profile sample
UCS-A /org/auth-profile* # set user-id exampleuser
UCS-A /org/auth-profile* # set password
Enter password:
Confirm password:
UCS-A /org/auth-profile* # commit-buffer
UCS-A /org/auth-profile #

Related Commands Command Description


create auth-profile
set password (auth-profile)

Cisco UCS Manager CLI Command Reference, Release 2.0


1446 OL-25718-02
Commands
set userid

set userid
To specify the username the system should use to log in to the remote server, use the set userid command.

set userid userid

Syntax Description userid The login user name for the remote server.

Command Default None

Command Modes Firmware download task (/firmware/download-task)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the user name the system should use to log in to the remote server. This field
does not apply if the protocol is TFTP.

Examples This example shows how to specify the user name for logging in to the remote server:
switch-A# scope firmware
switch-A /firmware # scope download-task ucs-k9-bundle.1.1.0.279.bin
switch-A /firmware/download-task # set userid User123
switch-A /firmware/download-task #

Related Commands Command Description


show download-task

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1447
Commands
set user-label

set user-label
To assign an identifying label to the server, use the set user-label command.

set user-label label

Syntax Description label Enter up to 32 characters with no spaces.

Command Default None

Command Modes Server (/chassis/server)


IOM (/chassis/iom)
Interface within Ethernet Storage (eth-storage/fabric/interface)
Interface within Ethernet Server (eth-server/fabric/interface)
Interface within Ethernet Uplink (eth-uplink/fabric/interface)
Interface within Fibre Channel Uplink (fc-uplink/fabric/interface)
Fabric Extender Module (/fex)

Command History Release Modification


1.0(1) This command was introduced only in the server mode. The maximum number of
characters in the user label was 16.

1.4(1) This command was introduced in other command modes. The maximum number of
characters for the user label was increased from 16 to 32.

Usage Guidelines Use this command to assign an identifying label to a server.

Examples This example shows how to assign a label to server 2 in chassis 1:


switch-A# scope server 1/2
switch-A /chassis/server # set user-label SanJose13
switch-A /chassis/server* # commit-buffer
switch-A /chassis/server #

Related Commands Command Description


show server

Cisco UCS Manager CLI Command Reference, Release 2.0


1448 OL-25718-02
Commands
set uuid-prefix

set uuid-prefix
To specify the prefix for UUID pool values, use the set uuid-prefix command.

set uuid-prefix {uuid-prefix| derived}

Syntax Description uuid-prefix Specifies the prefix in the format nnnnnnnn-nnnn-nnnn .

derived Use the prefix of the UUID burned into the hardware at manufacture.

Command Default The UUID prefix is derived.

Command Modes UUID suffix pool (/org/uuid-suffix-pool)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the Universally Unique Identifier (UUID) prefix to be combined with UUID
suffix pool values for dynamic UUID assignment.
The prefix contains 16 hexadecimal characters in three hyphen-separated groups, in the form
nnnnnnnn-nnnn-nnnn .

Examples This example shows how to specify a UUID prefix for the UUID suffix pool:
switch-A# scope org org10
switch-A /org # scope uuid-suffix-pool usp10a
switch-A /org/uuid-suffix-pool # set uuid-prefix 12345678-9abc-def0
switch-A /org/uuid-suffix-pool* # commit-buffer
switch-A /org/uuid-suffix-pool #

Related Commands Command Description


show uuid-suffix-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1449
Commands
set v3privilege

set v3privilege
To specify the SNMPv3 security level for the SNMP trap destination, use the set v3privilege command.

set v3privilege {auth| noauth| priv}

Syntax Description auth Specifies keyed-hash authentication with the trap destination.

noauth Specifies user name authentication with the trap destination.

priv Specifies keyed-hash authentication and data encryption (privacy) with the trap
destination.

Command Default User name authentication (noauth) is used with the trap destination.

Command Modes SNMP trap (/monitoring/snmp-trap)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the Simple Network Management Protocol version 3 (SNMPv3) security level
for the SNMP trap destination.

Examples This example shows how to set the SNMPv3 security level for the SNMP trap destination:
switch-A# scope monitoring
switch-A /monitoring # scope snmp-trap 192.20.1.28
switch-A /monitoring/snmp-trap # set v3privilege auth
switch-A /monitoring/snmp-trap* # commit-buffer
switch-A /monitoring/snmp-trap #

Related Commands Command Description


show snmp-trap

Cisco UCS Manager CLI Command Reference, Release 2.0


1450 OL-25718-02
Commands
set vcon

set vcon
To set up a vCon (virtual adapter), use the set vcon command.

set vcon {1 | 2} selection {all | assigned-only | exclude-dynamic | exclude-assigned}

Syntax Description 1 Specifies adapter 1.

2 Specifies adapter 2.

selection Specifies a placement selection.

all Places all vNICs and vHBAs.

assigned-only Places assigned vNICs and vHBAs.

exclude-dynamic Excludes dynamic vNICs and vHBAs from being placed.

exclude-assigned Excludes assigned vNICs and vHBAs from being placed.

Command Default None

Command Modes vCon policy (/org/vcon-policy)


Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines vCons

Examples This example shows how to set up a vCon:


switch-A# scope org /
switch-A /org # scope vcon-policy vcp100
switch-A /org/vcon-policy # set vcon 1 selection all
switch-A /org/vcon-policy* # commit-buffer
switch-A /org/vcon-policy #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1451
Commands
set vcon

Related Commands Command Description


show vcon
show vcon-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1452 OL-25718-02
Commands
set vcon-profile

set vcon-profile
To associate a vCon (virtual adapter) profile, use the set vcon-profile command.

set vcon-profile profile-name

Syntax Description profile-name The name of the profile.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines Associates the specified vNIC/vHBA placement policy with the service profile.

Examples This example shows how to associate a vCon profile:


switch-A# scope org org100
switch-A /org # scope service-profile sp100
switch-A /org/service-profile # set vcon-profile vcp100
switch-A /org/service-profile* # commit-buffer
switch-A /org/service-profile #

Related Commands Command Description


show vcon
show

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1453
Commands
set version

set version
To set the version number, use the set version command.

set version number

Syntax Description number Version number.

Command Default None

Command Modes Pack image (/org/fw-host-pack/pack-image)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the package image version number. Changing this number triggers firmware
updates on all components using the firmware through a service profile.

Examples This example shows how to set the version number:

switch-A# scope org org100

switch-A /org # scope fw-host-pack fhp10

switch-A /org/fw-host-pack # scope pack-image pi10

switch-A /org/fw-host-packpack-image # set version 1.3

switch-A /org/fw-host-packpack-image* # commit-buffer

switch-A /org/fw-host-packpack-image #

Related Commands Command Description


show pack-image
show version

Cisco UCS Manager CLI Command Reference, Release 2.0


1454 OL-25718-02
Commands
set version (snmp-trap)

set version (snmp-trap)


To specify the SNMP version for the SNMP trap destination, use the set version command.

set version {v1| v2c| v3}

Syntax Description v1 Specifies SNMP version 1.

v2c Specifies SNMP version 2c.

v3 Specifies SNMP version 3.

Command Default SNMP version 2c is used.

Command Modes SNMP trap (/monitoring/snmp-trap)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the Simple Network Management Protocol (SNMP) version for the SNMP trap
destination.

Examples This example shows how to specify SNMPv3 for the SNMP trap destination:
switch-A# scope monitoring
switch-A /monitoring # scope snmp-trap 192.20.1.28
switch-A /monitoring/snmp-trap # set version v3
switch-A /monitoring/snmp-trap* # commit-buffer
switch-A /monitoring/snmp-trap #

Related Commands Command Description


show snmp-trap

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1455
Commands
set vhba

set vhba
To set a vHBA, use the set vhba command.

set vhba name

Syntax Description name vHBA name. The range of valid values is 1 to 16.

Command Default None

Command Modes Path (/org/boot-policy/storage/san-image/path)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set a vHBA:

switch-A# scope org org3

switch-A /org # scope boot-policy boot1

switch-A /org/boot-policy # scope storage

switch-A /org/boot-policy/storage # scope san-image primary

switch-A /org/boot-policy/storage/san-image # scope path primary

switch-A /org/boot-policy/storage/san-image/path # set vhba vhba100

switch-A /org/boot-policy/storage/san-image/path* # commit-buffer

switch-A /org/boot-policy/storage/san-image/path #

Related Commands Command Description


show interface
show vhba

Cisco UCS Manager CLI Command Reference, Release 2.0


1456 OL-25718-02
Commands
set virtual-ip

set virtual-ip
To set up a virtual IP address, use the set virtual-ip command.

set virtual-ip address

Syntax Description address Virtual IP address. Enter the argument in the format A.B.C.D.

Command Default None

Command Modes System (/system)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set up a virtual IP address:

switch# scope system

switch /system # set virtual-ip 209.165.200.225

switch /system* # commit-buffer

switch /system #

Related Commands Command Description


show image
show vif

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1457
Commands
set vlan-id

set vlan-id
To set an ID for the VLAN of the fabric, use the set vlan-id command.

set vlan-id vlan-id

Syntax Description vlan-id The ID of the VLAN. The ID must be a number, and between 1-3967, and
4049-4093.

Command Default None

Command Modes VLAN within Ethernet uplink (/eth-uplink/fabric/vlan)


VLAN within Ethernet storage (/eth-storage/fabric/vlan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A VLAN for the fabric must be created to use this command.

Examples This example shows how to set the ID for the VLAN of the fabric.
Switch-A # scope eth-storage
Switch-A /eth-storage # scope fabric a
Switch-A /eth-storage/fabric # scope vlan 200
Switch-A /eth-storage/fabric/vlan # set vlan-id 250
Switch-A /eth-storage/fabric/vlan* # commit-buffer
Switch-A /eth-storage/fabric/vlan #

Related Commands Command Description


create vlan
scope vlan

Cisco UCS Manager CLI Command Reference, Release 2.0


1458 OL-25718-02
Commands
set vmretention

set vmretention
To set virtual machine retention for a VM lifecycle policy , use the set vmretention command.

set vmretention {vmretention| 1-day| 1-hour| 5-days}

Syntax Description vmretention Use this option to not set a retention policy.

1-day Use this option to set the VM retention to 1 day.

1-hour Use this option to set the VM retention to 1 hour.

5-days Use this option to set the VM retention to 5 days.

Command Default None

Command Modes VM Life cycle policy (/system/vm-mgmt/vm-life-cycle-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to set the VM retention for the lifecycle policy to 5 days.
Switch-A # scope system
Switch-A /system # scope vm-mgmt
Switch-A /system/vm-mgmt # scope vm-life-cycle-policy
Switch-A /system/vm-mgmt/vm-life-cycle-policy # set vmretention 5-days
Switch-A /system/vm-mgmt/vm-life-cycle-policy* # commit-buffer
Switch-A /system/vm-mgmt/vm-life-cycle-policy #

Related Commands Command Description


set vnicretention

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1459
Commands
set vnic

set vnic
To set the vNIC, use the set vnic command.

set vnic vnic

Syntax Description vnic VNIC name. The range of valid values is 1 to 16.

Command Default None

Command Modes Path (/org/boot-policy/lan/path)

Command History Release Modification


1.0(1) This command was introduced.

A vNIC is a virtualized network interface that is configured on a physical network adapter and appears to be
a physical NIC to the operating system of the server. The type of adapter in the system determines how many
vNICs you can create. For example, a Cisco UCS CNA M71KR adapter has two NICs, which means you can
create a maximum of two vNICs for each of those adapters.

Examples This example shows how to set the VNIC:

switch-A# scope org org3

switch-A /org # scope boot-policy boot1

switch-A /org/boot-policy # scope lan

switch-A /org/boot-policy/lan # scope path

switch-A /org/boot-policy/lan/path # set vnic 101

switch-A /org/boot-policy/lan/path* # commit-buffer

switch-A /org/boot-policy/lan/path #

Related Commands Command Description


show path
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


1460 OL-25718-02
Commands
set vnicretention

set vnicretention
To set a VNIC retention policy for the VM lifecycle policy, use the set vnicretention command.

set vnicretention
set vnicretention {vnicretention| 1-day| 1-hour| 5-days}

Syntax Description vnicretention Use this option to not set a retention policy

1-day Use this option to set the retention as 1 day.

1-hour Use this option to set the retention as 1 hour.

5-days Use this option to set the retention as 5 days.

Command Default None

Command Modes VM Lifecycle policy (/system/vm-mgmt/vm-life-cycle-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to set the VNIC retention for the lifecycle policy to 5 days.
Switch-A # scope system
Switch-A /system # scope vm-mgmt
Switch-A /system/vm-mgmt # scope vm-life-cycle-policy
Switch-A /system/vm-mgmt/vm-life-cycle-policy # set vnicretention 5-days
Switch-A /system/vm-mgmt/vm-life-cycle-policy* # commit-buffer
Switch-A /system/vm-mgmt/vm-life-cycle-policy #

Related Commands Command Description


set vmretention

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1461
Commands
set weight

set weight
To set the weight, use the set weight command.

set weight {weight| best-effort| none}

Syntax Description weight Weight number. The range of valid values is 0 to 10.

best-effort Specifies best effort.

none Specifies no weight.

Command Default None

Command Modes Ethernet best effort (/eth-server/qos/eth-best-effort)


Ethernet classified (/eth-server/qos/eth-classified)
Fibre Channel (/eth-server/qos/fc)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set the weight:


switch-A# scope eth-server
switch-A /eth-server # scope qos
switch-A /eth-server/qos # scope eth-classified
switch-A /eth-server/qos/eth-classified # set weight 5
switch-A /eth-server/qos/eth-classified* # commit-buffer
switch-A /eth-server/qos/eth-classified #

Related Commands Command Description


show eth-best-effort
show eth-classified

Cisco UCS Manager CLI Command Reference, Release 2.0


1462 OL-25718-02
Commands
set width

set width
To set the width, use the set width command.

set width {width| unspec}

Syntax Description width Width. The range of valid values is 0 to 65535.

unspec Specifies width unspecified.

Command Default None

Command Modes Memory (/org/server-qual/memory)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify the bit width of the data bus.

Examples This example shows how to set the width:

switch-A# scope org org10

switch-A /org # scope server-qual squal10

switch-A /org/server-qual # scope memory

switch-A /org/server-qual/memory # set width 1000000

switch-A /org/server-qual/memory* # commit-buffer

switch-A /org/server-qual/memory #

Related Commands Command Description


show memory
show storage

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1463
Commands
set wwn

set wwn
To set a World Wide Name (WWN), use the set wwn command.

set wwn name

Syntax Description name WWN name. The name entered must be in hh:hh:hh:hh:hh:hh:hh:hh format.

Command Default None

Command Modes Path (/org/boot-policy/storage/san-image/path)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to set a WWN:

switch-A# scope org org10a

switch-A /org # scope boot-policy boot6b

switch-A /org/boot-policy # scope storage

switch-A /org/boot-policy/storage # scope san-image primary

switch-A /org/boot-policy/storage/san-image # scope path primary

switch-A /org/boot-policy/storage/san-image/path # set wwn 20:00:00:00:20:00:00:23

switch-A /org/boot-policy/storage/san-image/path* # commit-buffer

switch-A /org/boot-policy/storage/san-image/path* #

Related Commands Command Description


show path
show san-image

Cisco UCS Manager CLI Command Reference, Release 2.0


1464 OL-25718-02
Commands
set wwpn-pool

set wwpn-pool
To specify a pool of world wide port names (WWPN) for a vHBA template, use the set wwpn-pool command.

set wwpn-pool wwpn-pool

Syntax Description wwpn-pool Name of a WWPN pool.

Command Default The default WWPN pool is used.

Command Modes Virtual HBA template (/org/vhba-templ)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to specify an existing pool of world wide port names (WWPN) for dynamic assignment
to a vHBA (virtual host bus adapter) template.

Examples This example shows how to specify a WWPN pool for a vHBA:
switch-A# scope org org10
switch-A /org # scope vhba-templ vhba10
switch-A /org/vhba-templ # set wwpn-pool MyWwpnPool13
switch-A /org/vhba-templ* # commit-buffer
switch-A /org/vhba-templ #

Related Commands Command Description


show vhba-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1465
Commands
show activate status

show activate status


To display the activation status, use the show activate status command.

show activate status

This command has no arguments or keywords.

Command Default Displays the activation status.

Command Modes Input/output module (/chassis/iom)


Fabric interconnect (/fabric-interconnect)
Adapter (/chassis/server/adapter)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the activation status:


switch-A# scope chassis 1
switch-A /chassis # scope iom 1
switch-A /chassis/iom # show activate status
State: Ready

Related Commands Command Description


show firmware
show status

Cisco UCS Manager CLI Command Reference, Release 2.0


1466 OL-25718-02
Commands
show adapter

show adapter
To display adapter information, use the show adapter command.

show adapter [detail | expand]*

Syntax Description detail (Optional) Displays details about all adapters.

expand (Optional) Displays limited details about all adapters.

Command Default Displays adapter information.

Command Modes Server qualification (/org/server-qual)


Server (/chassis/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show adapter command without any arguments or keywords to display a list of adapters.

Examples This example shows how to display a list of adapters:

switch-A# scope org org10

switch-A /org # scope server-qual sq10

switch-A /org/server-qual # show adapter

Server 1/1:
Adapter PID Vendor Serial Operational State
------- ---------- ----------------- ------------ -----------------
1 N20-AE0002 Cisco Systems Inc EXM12510017 Operable
2 N20-AE0003 Cisco Systems Inc EXM12510018 Operable
switch-A /org/server-qual #

Related Commands Command Description


show chassis

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1467
Commands
show adapter

Command Description
show server-qual

Cisco UCS Manager CLI Command Reference, Release 2.0


1468 OL-25718-02
Commands
show assoc

show assoc
To display service profile association information, use the show assoc command.

show assoc

This command has no arguments or keywords.

Command Default Displays service profile association information.

Command Modes Server (/chassis/server)


Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show assoc command without any arguments or keywords to display a list of service
profile associations.

Examples This example shows how to display service profile associations:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # show assoc

Service Profile Name Association Server Server Pool


-------------------- -------------- ------ -----------
org10/sp10 Associated 1/1 10
org10/sp100 Associated 1/2 10
switch-A /org/service-profile #

Related Commands Command Description


show org
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1469
Commands
show audit-logs

show audit-logs
To display the audit log, use the show audit-logs command.

show audit-logs [id | detail]*

Syntax Description id (Optional) Displays a specific audit log.

detail (Optional) Displays details in the audit log.

Command Default Displays the audit log.

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was released.

Usage Guidelines This command does not require a license.

Examples This command shows how to display the audit log:

switch-A# scope security

switch-A /security # show audit-logs

Audit trail logs:


Creation Time User ID Action Description
-------------------- ---------- -------- ---------------- -----------
2009-07-01T15:59:07 internal 905342 Creation Fabric A: local user admin
logged
2009-07-01T15:58:48 internal 905339 Deletion Fabric A: user admin terminated

2009-07-01T15:51:02 internal 905275 Creation Fabric A: local user admin


logged
2009-07-01T15:50:48 internal 905271 Deletion Fabric A: user admin terminated

2009-07-01T15:49:19 internal 905265 Creation Fabric A: local user admin


logged
2009-07-01T15:47:48 internal 905254 Deletion Fabric A: user admin terminated
switch-A /security #

Cisco UCS Manager CLI Command Reference, Release 2.0


1470 OL-25718-02
Commands
show audit-logs

Related Commands Command Description


show event
show remote-user

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1471
Commands
show auth-domain

show auth-domain
To display information on the authentication domains, use the show auth-domain command.

show auth-domain [ name ] [detail]

Syntax Description name (Optional) The name of the authentication domain. Using this option will display
information on only the specified authentication domain.

detail (Optional) This option will display information on all authentication domains that
have been created.

Command Default By default, this command will list the authentication domains that have been created.

Command Modes Security (/security)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines Authentication domains must be created to use this command.

Examples This example shows how to view information on all the authentication domains:
Switch-A # scope security
Switch-A /security # show auth-domain detail

Authentication Domain:
Authentication Domain Name: Default
Default Realm: Local
Authentication Server group: Default

Authentication Domain Name: Sample


Default Realm: Local
Authentication Server group: Sample

Related Commands Command Description


scope auth-domain
create auth-domain
delete auth-domain
enter auth-domain

Cisco UCS Manager CLI Command Reference, Release 2.0


1472 OL-25718-02
Commands
show authentication

show authentication
To display authentication information, use the show authentication command.

show authentication

This command has no arguments or keywords.

Command Default Displays authentication information.

Command Modes Security (/security)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display console and default authentication information:

switch-A# scope security

switch-A /security # show authentication

Console authentication: Local


Default authentication: Local
switch-A /security #

Related Commands Command Description


show radius
show tacacs

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1473
Commands
show auth-server-group

show auth-server-group
To display information on the authentication server groups, use the show auth-server-group command.

show auth-server-group [ authentication server group ] [detail]

Syntax Description authentication server group (Optional) Name of the authentication server group. This option will display
information on the specified authentication server group.

detail (Optional) This option will display information on all authentication server
groups that have been created.

Command Default By default, this command will list the authentication server groups that have been created.

Command Modes LDAP (/security/ldap)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines Authentication server groups must be created to use this command.

Examples This example shows how to view information on the authentication server groups.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # show auth-server-group detail

Authentication server group:

Authentication server group: Sample


Authentication server group: Example
Authentication server group: Test

Related Commands Command Description


create auth-server-group
scope auth-server-group
enter-auth-server-group
delete auth-server-group

Cisco UCS Manager CLI Command Reference, Release 2.0


1474 OL-25718-02
Commands
show backup

show backup
To display backup information, use the show backup command.

show backup [backup-name | detail | fsm status]*

Syntax Description backup-name (Optional) Displays a specific backup file.

detail (Optional) Displays details about all backups.

fsm status (Optional) Displays FSM status.

Command Default Displays backup information.

Command Modes System (/system)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show backup command without any arguments or keywords to display a list of backups.

Examples This example shows how to display backup information:

switch-A# scope system

switch-A /system # show backup

Backup:
Hostname Type User Protocol Administrative State De
scription
---------- --------------------- ---------- -------- -------------------- --
---------
10.193.1.29
All Configuration jennall Scp Disabled
192.168.1.1
Full State Tftp Disabled
192.168.1.2
Full State jennall Scp Disabled

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1475
Commands
show backup

Related Commands Command Description


show firmware
show system

Cisco UCS Manager CLI Command Reference, Release 2.0


1476 OL-25718-02
Commands
show backup (ep-log-policy)

show backup (ep-log-policy)


To display backup information, use the show backup command in ep-log-policy mode.

show backup [detail | expand]

Syntax Description detail Displays all backup information, in list format.

expand Displays some backup information. The command does not display the following:
• Clear on backup
• Interval

Command Default None

Command Modes Endpoint log policy (/org/ep-log-policy)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to display all backup information:


switch-A# scope org
switch-A /org # scope ep-log-policy sel
switch-A /org/ep-log-policy # show backup detail

Log Backup Behavior:


Format: Ascii
Hostname: test
Remote Path: //test/electronic
User: user100
Protocol: Ftp
Backup Action: Timer
Clear on Backup: No
Interval: 1 Hour

switch-A /org/ep-log-policy #

Related Commands Command Description


show ep-log-policy
show

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1477
Commands
show beacon-led

show beacon-led
To display information on the beacon LED, use the show beacon-led command.

show beacon-led {expand| detail}*

Syntax Description expand Displays expanded information on the beacon LED.

detail Displays detailed information on the beacon LED.

Command Default By default, this command displays expanded information.

Command Modes Card (/fabric-interconnect/card)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to display detailed information on the beacon LED:
UCS-A # scope fabric-interconnect A
UCS-A /scope fabric-interconnect # scope card 1
UCS-A /scope fabric-interconnect/card # show beacon-led detail

Beacon LED:
Administrative State: Off
State: Unknown
Current Task: Test

UCS-A /scope fabric-interconnect/card #

Related Commands Command Description


show beacon-led fsm status

scope beacon-led

set admin-state (beacon-led)

Cisco UCS Manager CLI Command Reference, Release 2.0


1478 OL-25718-02
Commands
show beacon-led fsm status

show beacon-led fsm status


To display information on the FSM status of the beacon LED , use the show beacon-led fsm status command.

show beacon-led fsm status

This command has no arguments or keywords.

Command Default None

Command Modes Card (/fabric-interconnect/card)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to display the FSM status of the beacon LED:
UCS-A # scope fabric-interconnect A
UCS-A /fabric-interconnect # scope card 1
UCS-A /fabric-interconnect/card # show beacon-led fsm status

FSM 1:
Remote Result: Not Applicable
Remote Error Code: None
Remote Error Description:
Status: Nop
Previous Status: Illuminate Success
Timestamp: 2011-05-31T15.30.751
Try: 0
Progress(%): 100
Current Task:

UCS-A /fabric-interconnect/card #

Related Commands Command Description


scope beacon-led
set admin-state (beacon-led)

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1479
Commands
show bios

show bios
To display BIOS information, use the show bios command.

show bios [detail]

Syntax Description detail (Optional) Displays details about the BIOS.

Command Default Displays BIOS information.

Command Modes Server (/chassis/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display BIOS information:

switch-A# scope chassis 1

switch-A /chassis # scope server 1/1

switch-A /chassis/server # show bios

Bios Firmware:
Server Model Vendor Running-Vers
------- ---------- ----------------- ------------
1/1 N20-B6620-1 Intel Corp. S5500.86B.08.00.0022.110620081457
switch-A /chassis/server #

Related Commands Command Description


show firmware
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


1480 OL-25718-02
Commands
show bladeserver-disc-policy

show bladeserver-disc-policy
To display information on all blade server discovery policies, use the show bladeserver-disc-policy command.

show bladeserver-disc-policy [ name ] [detail]

Syntax Description name (Optional) The name of the blade server discovery policy. This option will display
information only on the specified policy.

detail (Optional) This option will display information on all blade server discovery policies
that are configured.

Command Default By default, this command displays information on the configured blade server discovery policies in a tabular
format.

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view information on all blade server discovery policies.
Switch-A # scope org
Switch-A /org # show bladeserver-disc-policy detail

Compute blade Discovery Policy:

Name: Default
Qualifier: all-chassis
Action: Immediate
Scrub Policy: Default
Description: Sample text

Related Commands Command Description


create bladeserver-disc-policy
scope bladeserver-disc-policy
enter bladeserver-disc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1481
Commands
show bladeserver-disc-policy

Command Description
delete bladeserver-disc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1482 OL-25718-02
Commands
show boot-definition

show boot-definition
To display boot definition information, use the show boot-definition command.

show boot-definition [detail | expand]*

Syntax Description detail (Optional) Displays details about the boot definition.

expand (Optional) Displays limited details about the boot definition.

Command Default Displays boot definition information.

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the boot definition:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # show boot-definition

Boot Definition:
Reboot on Update: Yes

switch-A /org/service-profile #

Related Commands Command Description


show boot-policy
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1483
Commands
show boot-order

show boot-order
To display the boot order, use the show boot-order command.

show boot-order

This command has no arguments or keywords.

Command Default Displays the boot order.

Command Modes Server (/chassis/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the boot order:

switch-A# scope chassis 1

switch-A /chassis # scope server 1/1

switch-A /chassis/server # show boot-order

Related Commands Command Description


show actual-boot-order

show chassis

Cisco UCS Manager CLI Command Reference, Release 2.0


1484 OL-25718-02
Commands
show boot-option-retry-config

show boot-option-retry-config
To display information on the boot option retry configuration, use the show boot-option-retry-config
command.

show boot-option-retry-config {expand| detail}*

Syntax Description expand (Optional) Displays expanded information on the boot option retry configuration.

detail (Optional) Displays detailed information on the boot option retry configuration.

Command Default By default, this command displays the expanded information of the retry configuration.

Command Modes BIOS Settings (/chassis/server/bios/bios-settings)


BIOS Policy (/org/bios-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A BIOS policy must be created prior to using this command in the BIOS policy commnade mode.

Examples This example shows how to view detailed information on the boot option retry configuration for a server.
Switch-A # scope server 1/1
Switch-A /chassis/server # scope bios
Switch-A /chassis/server/bios # scope bios-settings
Switch-A /chassis/server/bios/bios-settings # show boot-option-retry-config detail

Boot Option Retry Config


Retry
-----
Platform Default

Switch-A /chassis/server/bios/bios-settings #

Related Commands Command Description


create bios-policy

create org

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1485
Commands
show boot-policy

show boot-policy
To display boot policy information, use the show boot-policy command.

show boot-policy [name | detail | expand]*

Syntax Description name (Optional) Displays information about a specific boot policy.

detail (Optional) Displays details about boot policies.

expand (Optional) Displays limited details about boot policies.

Command Default Displays boot policy information.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show boot-policy command without any arguments or keywords to display a list of boot
policies.

Examples This example shows how to display a list of boot policies:

switch-A# scope org org10

switch-A /org # show boot-policy

Boot Policy:
Name Purpose Reboot on Update
-------------------- ----------- ----------------
org10/bp10 Operational No
org10/bp11 Operational Yes
switch-A /org #

Related Commands Command Description


show boot-definition

Cisco UCS Manager CLI Command Reference, Release 2.0


1486 OL-25718-02
Commands
show boot-policy

Command Description
show org

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1487
Commands
show boot-target

show boot-target
To display information about a boot-target, use the show boot-target command.

show boot-target [primary | secondary] [detail] [expand]

Syntax Description primary (Optional) Specifies the primary boot target.

secondary (Optional) Specifies the secondary boot target.

detail (Optional) Displays detailed information about the specified boot target.

expanded (Optional) Displays information about the boot target in an expanded format..

Command Default None

Command Modes WWN initiator (/org/wwn-pool/initiator)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines By default, the show boot-target command displays the output in expanded format.

Examples The following example shows how to display information about all boot targets in the system:
server# scope org
server /org # scope wwn-pool default
server /org/wwn-pool # scope initiator 20:00:00:25:B5:00:00:00
server /org/wwn-pool/initiator # show boot-target secondary

Boot Target:
Type LUN WWN
--------- ---------- ---
Primary 0 00:00:00:00:00:00:00:00
Secondary 1200 20:00:00:00:20:00:00:23
server /org/wwn-pool/initiator #

The following example shows how to display the detailed information about the secondary boot target:
server# scope org
server /org # scope wwn-pool default
server /org/wwn-pool # scope initiator 20:00:00:25:B5:00:00:00
server /org/wwn-pool/initiator # show boot-target secondary detail

Boot Target:
Type: Secondary

Cisco UCS Manager CLI Command Reference, Release 2.0


1488 OL-25718-02
Commands
show boot-target

LUN: 1200
WWN: 20:00:00:00:20:00:00:23
server /org/wwn-pool/initiator #

The following example shows how to display information about the secondary boot target, in expanded format:
server# scope org
server /org # scope wwn-pool default
server /org/wwn-pool # scope initiator 20:00:00:25:B5:00:00:00
server /org/wwn-pool/initiator # show boot-target secondary expand

Boot Target:
Type LUN WWN
--------- ---------- ---
Secondary 1200 20:00:00:00:20:00:00:23
server /org/wwn-pool/initiator #

Related Commands Command Description


create boot-target
delete boot-target
enter boot-target
scope boot-target
show initiator

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1489
Commands
show callhome

show callhome
To display callhome information, use the show callhome command.

show callhome [detail | expand | fsm status]*

Syntax Description detail (Optional) Displays limited details about callhome.

expand (Optional) Displays details about callhome.

fsm status (Optional) Displays finite state machine information.

Command Default Displays callhome information.

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display callhome information:

switch-A# scope monitoring

switch-A /monitoring # show callhome

Callhome:
Admin State: On
Throttling State: On
Contact Information: admin
Customer Contact Email: tgv@tgv.com
From Email: ref@tgv.com
Reply To Email: admin021@tgv.com
Phone Contact e.g., +1-011-408-555-1212: +16504441234
Street Address: 12 First St.
Contract Id:
Customer Id:
Site Id:
Urgency: Debugging
SMTP Server Address: adminHost
SMTP Server Port: 25
switch-A /monitoring #

Cisco UCS Manager CLI Command Reference, Release 2.0


1490 OL-25718-02
Commands
show callhome

Related Commands Command Description


show event
show snmp-trap

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1491
Commands
show cap-qual

show cap-qual
To display capacity qualification information, use the show cap-qual command.

show cap-qual [detail | expand | fcoe | non-virtualized-eth-if | non-virtualized-fc-if |


path-encap-consolidated | path-encap-virtual | protected-eth-if | protected-fc-if | protected-fcoe |
virtualized-eth-if | virtualized-fc-if | virtualized-scsi-if]*

Syntax Description fcoe (Optional) Displays Fibre Channel over Ethernet information.

non-virtualized-eth-if (Optional) Displays non-virtualized Ethernet interface information.

non-virtualized-fc-if (Optional) Displays non-virtualized Fibre Channel interface information.

path-encap-consolidated (Optional) Displays an consolidated encapsulated path information.

path-encap-virtual (Optional) Displays an virtual encapsulated path information.

protected-eth-if (Optional) Displays a protected Ethernet interface information.

protected-fc-if (Optional) Displays a protected Fibre Channel interface information.

protected-fcoe (Optional) Displays a protected Fibre Channel over Ethernet interface


information.

virtualized-eth-if (Optional) Displays a virtualized Ethernet interface information.

virtualized-fc-if (Optional) Displays a virtualized Fibre Channel interface information.

virtualized-scsi-if (Optional) Displays a virtualized SCSI interface information.

expand (Optional) Displays expanded capacity qualification information.

detail (Optional) Displays detailed capacity qualification information.

Command Default Displays capacity qualification information.

Command Modes Adapter (/org/server-qual/adapter)

Command History Release Modification


1.0(1) This command was introduced.

Cisco UCS Manager CLI Command Reference, Release 2.0


1492 OL-25718-02
Commands
show cap-qual

Usage Guidelines This command does not require a license.

Examples This example shows how to display capacity qualification information:

switch-A# scope org org10

switch-A /org # scope server-qual sq10

switch-A /org/server-qual # scope adapter

switch-A /org/server-qual/adapter # show cap-qual

Adapter Capacity Qualification:


Type Maximum
----------------------- -------
Fcoe Unspecified
switch-A /org/server-qual/adapter #

Related Commands Command Description


show chassis
show memory

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1493
Commands
show card Command

show card Command


To display information on a fabric card, use the show card command.

show card [ id ] {expand| detail}*

Syntax Description id (Optional) To display information on a specific fabric card. It must be a value
between 0 and 4294967295.

expand To display information on all fabric cards.

detail To display detailed information on all fabric cards.

Command Default By default, this command displays information on all fabric cards.

Command Modes Fabric Interconnect (/fabric-interconnect)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to display information on a specific fabric card.
UCS-A # scope fabric-interconnect a
UCS-A /fabric-interconnect # show card 1

Fabric Card
-----------

ID Overall Status
-- --------------
1 Operable

UCS-A /fabric-interconnect #

Related Commands Command Description


scope card

scope beacon-led

Cisco UCS Manager CLI Command Reference, Release 2.0


1494 OL-25718-02
Commands
show cat-updater

show cat-updater
To display information about previous capability catalog file updates, use the show cat-updater command.

show cat-updater [ filename ]

Syntax Description filename (Optional) To display information about a specific update, enter the name of the
capability catalog update file.

Command Default None

Command Modes Capability (/system/capability)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to display information about previous capability catalog file update operations. If you do
not specify an update file name, all previous update operations are displayed.

Examples The following example shows how to display the details of previous capability catalog update operations:
UCS-A# scope system
UCS-A /system # scope capability
UCS-A /system/capability # show cat-updater
Catalog Updater:
File Name Protocol Server Userid Status
--------- -------- --------------- --------------- ------
ucs-catalog.1.0.0.4.bin
Scp 192.0.2.111 user1 Failed

UCS-A /system/capability #

Related Commands Command Description


scope cat-updater

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1495
Commands
show certreq

show certreq
To display a certificate request, use the show certreq command.

show certreq

Syntax Description This command has no arguments or keywords.

Command Default Displays a certificate request.

Command Modes Keyring (/security/keyring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display a certificate request:

switch-A# scope security

switch-A /chassis # scope keyring kr10

switch-A /chassis/server # show certreq

Request:
-----BEGIN CERTIFICATE REQUEST-----
MIIBfzCB6QIBADASMRAwDgYDVQQDEwcxLjEuMS4xMIGfMA0GCSqGSIb3DQEBAQUA
A4GNADCBiQKBgQDpXUUWe0PfRBOQevT2Y6vs8E8MOBLVn0kJ1iyGPdcfII9GrMX5
iiF+X1vjZOkvLpOQ4Z1wGdA3JFIm7lgcgf84l40n9vMsFCmqcmoWzX8H0bqnUfw/
YN71NSKJomjSgufhsGBfxH4oAcVP4pg6Ss0dDZpBXch4As1emU7VAD/yuwIDAQAB
oC4wLAYJKoZIhvcNAQkOMR8wHTAbBgNVHREBAf8EETAPggcxLjEuMS4xhwQBAQEB
MA0GCSqGSIb3DQEBBAUAA4GBAB7AqcyPlqWqkZs2T92mLXZ8ApSyjNddhj54zSLY
6L+U4255miPOvCNHo8r3KlzG8jvnL76aBYbWDJfyJEZUIcHs4g1MvztSr0bw8Jcj
pfNVFVhidMgxvMWK1RYM7POcQn6sy3YWZfFajrtXhQisu/KTV8Q6DFzd0b0fSHPu
hX6D
-----END CERTIFICATE REQUEST-----

switch-A /chassis/server #

Cisco UCS Manager CLI Command Reference, Release 2.0


1496 OL-25718-02
Commands
show certreq

Related Commands Command Description


show keyring
show trustpoint

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1497
Commands
show chassis-conn-policy

show chassis-conn-policy
To display information on the chassis connectivity policy, use the show chassis-conn-policy command.

show chassis-conn-policy [chassis id {a| b}][detail]

Syntax Description chassis id ID of the chassis.

a Specifies Fabric A.

b Specifies Fabric B.

detail (Optional) Displays detailed information on the chassis connectivity policy.

Command Default By default, this command displays information on the chassis connectivity policy configured for Fabric A
and B.

Command Modes Organization (/org)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to display information on the chassis connectivity policy for Fabric A:
UCS-A # scope org test
UCS-A /org # show chassis-connectivity-policy 1 a

Chassis Connectivity Policy:

Chassis ID Fabric ID Link Aggregation Preference


---------- --------- ---------------------------
1 A Global

UCS-A /org #

Related Commands Command Description


scope chassis-conn-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1498 OL-25718-02
Commands
show chassis-conn-policy

Command Description
set link-aggregation-pref

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1499
Commands
show chassis

show chassis
To display chassis information, use the show chassis command.

show chassis [id | decommissioned | detail | fabric | firmware | fsm | inventory [detail | expand | fabric |
fan | iom | psu | server] | iom | version]

Syntax Description id (Optional) Displays information for a specific chassis.

decommissioned (Optional) Displays information about a decommissioned chassis.

detail (Optional) Displays detailed information about the chassis.

fabric (Optional) Displays information about the fabric.

firmware (Optional) Displays information about the firmware.

fsm status (Optional) Displays information about the finite state machine.

inventory (Optional) Displays information about the chassis.

iom (Optional) Displays information about the input/output module.

version (Optional) Displays the version numbers of all the devices in the chassis.

Command Default Displays chassis information.

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show chassis command without any arguments or keywords to display a list of chassis.
The show iom command can be run in chassis (/chassis) mode.

Examples This example shows how to display chassis information:


switch-A# show chassis
Chassis:

Cisco UCS Manager CLI Command Reference, Release 2.0


1500 OL-25718-02
Commands
show chassis

Chassis Overall Status Admin State


---------- ------------------------ -----------
1 Accessibility Problem Acknowledged
switch-A#

Related Commands Command Description


show iom
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1501
Commands
show cimc

show cimc
To display Cisco Integrated Management Controller (CIMC) information, use the show cimc command.

show cimc [detail | expand | fsm status]*

Syntax Description detail (Optional) Displays details about the CIMC.

expand (Optional) Displays details about the CIMC, including the management interface
IP address, and the management endpoint log.

fsm status (Optional) Displays finite state machine information.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modifications


1.3(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display CIMC information:

switch-A# scope server 1/1


switch-A /chassis/server # show cimc detail

CIMC:
Product Name: Cisco B200-M1
PID: N20-B6620-1
VID: V01
Vendor: Cisco Systems Inc
Serial (SN): QCI125200H9
Revision: 0
GUID:
Current Task:

switch-A /chassis/server #

Related Commands Command Description


show chassis

Cisco UCS Manager CLI Command Reference, Release 2.0


1502 OL-25718-02
Commands
show cimc

Command Description
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1503
Commands
show cimxml

show cimxml
To display Common Information Model (CIM) XML port information, use the show cimxml command.

show cimxml

This command has no arguments or keywords.

Command Default Displays CIM XML port information.

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display CIM XML port information:

switch-A# scope system

switch-A /system # scope services

switch-A /system/services # show cimxml

Name: cimxml
Admin State: Disabled
Port: 5988
switch-A /system/services #

Related Commands Command Description


show http
show https

Cisco UCS Manager CLI Command Reference, Release 2.0


1504 OL-25718-02
Commands
show class cpu-stats

show class cpu-stats


To display information about the CPU statistics class, use the show class cpu-stats command.

show class cpu-stats [detail | expand]*

Syntax Description detail (Optional) Displays information about the CPU statistics class.

expand (Optional) Displays expanded information about the CPU statistics class.

Command Default Displays information about the CPU statistics class.

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display information about the CPU statistics class:

switch-A# scope org org10

switch-A /eth-server # scope stats-threshold-policy stp10

switch-A /eth-server/stats-threshold-policy # show class cpu-stats expand

Stats Class:
Stats Class: Cpu Stats

Stats Property:
Stats Property: Cpu Stats Cpu Temp
Norm Value: 0.000000
Stats Property: Cpu Stats Cpu Temp Avg
Norm Value: 0.000000
switch-A /eth-server/stats-threshold-policy #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1505
Commands
show class cpu-stats

Related Commands Command Description


show class dimm-stats
show stats-threshold-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1506 OL-25718-02
Commands
show class dimm-env-stats

show class dimm-env-stats


To display information about the dual in-line memory module (DIMM) environment statistics, use the show
class dimm-env-stats command.

show class dimm-env-stats [detail | expand]

Syntax Description detail (Optional) Displays detailed information about the DIMM environment statistics.

expand (Optional) Displays information about the DIMM environment statistics in


expanded format.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to display information about the DIMM environment statistics class:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # show class dimm-env-stats detail

Stats Class:
Stats Class
-----------
Dimm Env Stats
server /org/stats-threshold-policy #

Related Commands Command Description


create class dimm-env-stats

delete class dimm-env-stats

enter class dimm-env-stats

scope class dimm-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1507
Commands
show class env-stats

show class env-stats


To display information about the environment statistics class configuration, use the show class env-stats
command.

show class env-stats [detail | expand]

Syntax Description detail (Optional) Displays detailed information about the environment statistics class
configuration.

expand (Optional) Displays information about the environment statistics class configuration
in expanded format. This is the default output format.

Command Default None

Command Modes Ethernet server statistics threshold policy(eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to display information about all configured environment statistics classes:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # show class env-stats

Stats Class:
Stats Class
-----------
Env Stats
server /eth-server/stats-threshold-policy #

Related Commands Command Description


create class env-stats

delete class env-stats

enter class env-stats

scope class env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


1508 OL-25718-02
Commands
show class ethernet-port-err-stats

show class ethernet-port-err-stats


To display an Ethernet port error statistics class, use the show class ethernet-port-err-stats command.

show class ethernet-port-err-stats {expand| detail}*

Syntax Description expand (Optional) Displays limited details.

detail (Optional) Displays details in list form.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to display an Ethernet port error statistics class.

Examples This example shows how to display an Ethernet port error statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # show class ethernet-port-err-stats

Stats Class:
Stats Class
-----------
Ethernet Port Err Stats

switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1509
Commands
show class ethernet-port-multicast-stats

show class ethernet-port-multicast-stats


To display an Ethernet port multicast statistics class, use the show class ethernet-port-multicast-stats
command.

show class ethernet-port-multicast-stats {expand| detail}*

Syntax Description expand (Optional) Displays limited details.

detail (Optional) Displays details in list form.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to display an Ethernet port multicast statistics class.

Examples This example shows how to display an Ethernet port multicast statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # show class ethernet-port-multicast-stats

Stats Class:
Stats Class
-----------
Ethernet Port Multicast Stats

switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class

Cisco UCS Manager CLI Command Reference, Release 2.0


1510 OL-25718-02
Commands
show class ethernet-port-over-under-sized-stats

show class ethernet-port-over-under-sized-stats


To display an Ethernet port over-under-sized statistics class, use the show class
ethernet-port-over-under-sized-stats command.

show class ethernet-port-over-under-sized-stats {expand| detail}*

Syntax Description expand (Optional) Displays limited details.

detail (Optional) Displays details in list form.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to display an Ethernet port over-under-sized statistics class.

Examples This example shows how to display an Ethernet port over-under-sized statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # show class ethernet-port-over-under-sized-stats

Stats Class:
Stats Class
-----------
Ethernet Port Over Under Sized Stats

switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1511
Commands
show class ethernet-port-stats

show class ethernet-port-stats


To display an Ethernet port statistics class, use the show class ethernet-port-stats command.

show class ethernet-port-stats {expand| detail}*

Syntax Description expand (Optional) Displays limited details.

detail (Optional) Displays details in list form.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to display an Ethernet port statistics class.

Examples This example shows how to display an Ethernet port statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # show class ethernet-port-stats

Stats Class:
Stats Class
-----------
Ethernet Port Stats

switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class

Cisco UCS Manager CLI Command Reference, Release 2.0


1512 OL-25718-02
Commands
show class ethernet-port-stats-by-size-large-packets

show class ethernet-port-stats-by-size-large-packets


To display an Ethernet port large packet statistics class, use the show class
ethernet-port-stats-by-size-large-packets command.

show class ethernet-port-stats-by-size-large-packets {expand| detail}*

Syntax Description expand (Optional) Displays limited details.

detail (Optional) Displays details in list form.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to display an Ethernet port large packet statistics class.

Examples This example shows how to display an Ethernet port large packet statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # show class ethernet-port-stats-by-size-large-packets

Stats Class:
Stats Class
-----------
Ethernet Port Stats By Size Large Packets

switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1513
Commands
show class ethernet-port-stats-by-size-small-packets

show class ethernet-port-stats-by-size-small-packets


To display an Ethernet port small packet statistics class, use the show class
ethernet-port-stats-by-size-small-packets command.

show class ethernet-port-stats-by-size-small-packets {expand| detail}*

Syntax Description expand (Optional) Displays limited details.

detail (Optional) Displays details in list form.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)


Statistics threshold policy under Ethernet uplink (/eth-uplink/stats-threshold-policy)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to display an Ethernet port small packet statistics class.

Examples This example shows how to display an Ethernet port small packet statistics class:
switch-A# scope org org3
switch-A /org # scope stats-threshold-policy p10
switch-A /org/stats-threshold-policy # show class ethernet-port-stats-by-size-small-packets

Stats Class:
Stats Class
-----------
Ethernet Port Stats By Size Small Packets

switch-A /org/stats-threshold-policy #

Related Commands Command Description


show class

Cisco UCS Manager CLI Command Reference, Release 2.0


1514 OL-25718-02
Commands
show class ether-pause-stats

show class ether-pause-stats


To display information about the Ethernet pause statistics class configuration, use the show class
ether-pause-stats command.

show class ether-pause-stats [detail | expand]

Syntax Description detail (Optional) Displays detailed information about the Ethernet pause statistics class
configuration.

expand (Optional) Displays information about the Ethernet pause statistics class configuration,
in expanded format. This is the default output format.

Command Default None

Command Modes Ethernet threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to display the configuration information of the Ethernet pause statistics class:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # show class ether-pause-stats

Stats Class:
Stats Class
-----------
Ether Pause Stats
server /eth-server/stats-threshold-policy #

Related Commands Command Description


create class ether-pause-stats

delete class ether-pause-stats

enter class ether-pause-stats

scope class ether-pause-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1515
Commands
show class io-card-stats

show class io-card-stats


To display information about the Ethernet IO card statistics, use the show class io-card-stats command.

show class io-card-stats [detail | expand]

Syntax Description detail (Optional) Displays detailed information about the Ethernet IO card statistics.

expand (Optional) Displays information about the Ethernet IO card statistics, in expanded
format. This is the default output format.

Command Default None

Command Modes Ethernet statistics threshold policy (/eth-server/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to display all the IO card statistics classes configured in the system:
server# scope eth-server
server /eth-server # scope stats-threshold-policy default
server /eth-server/stats-threshold-policy # show class io-card-stats

Stats Class:
Stats Class
-----------
Io Card Stats
server /eth-server/stats-threshold-policy #

Related Commands Command Description


create class io-card-stats

delete class io-card-stats

enter class io-card-stats

scope class io-card-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


1516 OL-25718-02
Commands
show class memory-array-env-stats

show class memory-array-env-stats


To display the configuration information about the memory array environment statistics class, use the show
class memory-array-env-stats command.

show class memory-array-env-stats [detail | expand]

Syntax Description detail (Optional) Displays detailed information about the memory array environment
statistics.

expand (Optional) Displays information about the memory array environment statistics, in
expanded format. This is the default output format.

Command Default None

Command Modes Statistcis threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to enter the memory array environment statistics class mode:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # show class memory-array-env-stats

Stats Class:
Stats Class
-----------
Memory Array Env Stats
server /org/stats-threshold-policy #

Related Commands Command Description


create class memory-array-env-stats

delete class memory-array-env-stats

enter class memory-array-env-stats

scope class memory-array-env-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1517
Commands
show class motherboard-temp-stats

show class motherboard-temp-stats


To display information on the motherboard temperature statistics class, use the show class
motherboard-temp-stats command.

show class motherboard-temp-stats {expand| detail}*

Syntax Description expand (Optional) To view information on the motherboard temperature statistics class
and the properties that are set for it.

detail (Optional) To view information on the motherboard temperature statistics class.

Command Default By default, the command displays the detailed information of the class.

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A statistics threshold policy and a motherboard temperature statistics class must be created to use this command.

Examples This example shows how to view expanded information on the motherboard temperature statistics class.
UCS-A # scope org test
UCS-A /org/ # scope stats-threshold-policy sample
UCS-A /org/stats-threshold-policy # show class motherboard-temp-stats expand

Stats Class:
Stats Class: Motherboard Temp Stats

Stats Property:
Stats Property: Motherboard Temp Stats Motherboard Rear Temperature Min
Norm Value: 1.000000

Threshold Value:
Direction Severity Esc Value Deesc Value
--------- -------- --------- ------------
Above Normal Warning 0.000000 2.000000

UCS-A /org/stats-threshold-policy/class #

Related Commands Command Description


create class motherboard-temp-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


1518 OL-25718-02
Commands
show class motherboard-temp-stats

Command Description
enter class motherboard-temp-stats

scope class motherboard-temp-stats

delete class motherboard-temp-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1519
Commands
show class pcie-fatal-completion-error-stats

show class pcie-fatal-completion-error-stats


To display the configuration information of the Peripheral Component Interconnect (PCI) Express (PCIe)
fatal completion error statistics class, use the show class pcie-fatal-completion-error-stats command.

show class pcie-fatal-completion-error-stats [detail | expand]

Syntax Description detail (Optional) Displays detailed configuration information about the PCIe fatal completion
error statistics class.

expand (Optional) Displays information about the PCIe fatal completion error statistics class,
in an expanded format. This is the default output format.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to display configuration information of all PCIe fatal completion error statistics
classes in the system:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # show class pcie-fatal-completion-error-stats

server /org/stats-threshold-policy #

Related Commands Command Description


create class pcie-fatal-completion-error-stats

delete class pcie-fatal-completion-error-stats

enter class pcie-fatal-completion-error-stats

scope class pcie-fatal-completion-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


1520 OL-25718-02
Commands
show class pcie-fatal-error-stats

show class pcie-fatal-error-stats


To display the configuration information of the Peripheral Component Interconnect (PCI) Express (PCIe)
fatal error statistics class, use the show class pcie-fatal-error-stats command.

show class pcie-fatal-error-stats [detail | expand]

Syntax Description detail (Optional) Displays detailed configuration information about the PCIe fatal error
statistics class.

expand (Optional) Displays information about the PCIe fatal error statistics class, in an
expanded format. This is the default output format.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to display the configuration information of all PCIe fatal error statistics classes in
the system:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # show class pcie-fatal-error-stats

server /org/stats-threshold-policy #

Related Commands Command Description


create class pcie-fatal-error-stats

delete class pcie-fatal-error-stats

enter class pcie-fatal-error-stats

scope class pcie-fatal-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1521
Commands
show class pcie-fatal-protocol-error-stats

show class pcie-fatal-protocol-error-stats


To display the configuration information of the Peripheral Component Interconnect (PCI) Express (PCIe)
fatal protocol error statistics class, use the show class pcie-fatal-protocol-error-stats command.

show class pcie-fatal-protocol-error-stats [detail | expand]

Syntax Description detail (Optional) Displays detailed configuration information about the PCIe fatal protocol
error statistics class.

expand (Optional) Displays information about the PCIe fatal protocol error statistics class,
in an expanded format. This is the default output format.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Usage Guidelines

Examples This example shows how to display configuration information of all PCIe fatal protocol error statistics classes
in the system:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # show class pcie-fatal-protocol-error-stats

server /org/stats-threshold-policy #

Related Commands Command Description


create class pcie-fatal-protocol-error-stats

delete class pcie-fatal-protocol-error-stats

enter class pcie-fatal-protocol-error-stats

scope class pcie-fatal-protocol-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


1522 OL-25718-02
Commands
show class pcie-fatal-receiving-error-stats

show class pcie-fatal-receiving-error-stats


To display the configuration information of the Peripheral Component Interconnect (PCI) Express (PCIe)
fatal receive error statistics class, use the show class pcie-fatal-receiving-error-stats command.

show class pcie-fatal-receiving-error-stats [detail | expand]

Syntax Description detail (Optional) Displays detailed configuration information about the PCIe fatal receive
error statistics class.

expand (Optional) Displays information about the PCIe fatal receive error statistics class, in
an expanded format. This is the default output format.

Command Default None

Command Modes Statistics threshold policy (/org/stats-threshold-policy)

Command History Release Modification


1.3.1 This command was introduced.

Examples This example shows how to display the configuration information of all PCIe fatal receive error statistics
classes in the system:
server# scope org
server /org # scope stats-threshold-policy default
server /org/stats-threshold-policy # show class pcie-fatal-receiving-error-stats

server /org/stats-threshold-policy #

Related Commands Command Description


create class pcie-fatal-receiving-error-stats

delete class pcie-fatal-receiving-error-stats

enter class pcie-fatal-receiving-error-stats

scope class pcie-fatal-receiving-error-stats

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1523
Commands
show cli

show cli
To display CLI information, use the show cli command.

show cli {command-status | history | mode-info | session-config | shell-type}*

Syntax Description command-status (Optional) Displays the command status.

history (Optional) Displays the history of command usage.

mode-info (Optional) Displays information about the mode you are in.

session-config (Optional) Displays information about your session configuration.

shell-type (Optional) Displays information about the command shell type.

Command Default Displays CLI information.

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display information about your session configuration:

switch-A# show cli session-config

Suppress Headers: off


Suppress Field Spillover: off
Table Field Delimiter: none
switch-A#

Related Commands Command Description


show configuration
show system

Cisco UCS Manager CLI Command Reference, Release 2.0


1524 OL-25718-02
Commands
show cli history

show cli history


To display the history of commands that were run, use the show cli history command.

show cli history

This command has no arguments or keywords.

Command Default By default, the command displays the list of commands that were run.

Command Modes Any command mode.

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view the CLI history.


Switch-A # scope org Test
Switch-A /org # scope service-profile sample
Switch-A /org/service-profile # show cli history

1 00:00:00 scope org Test


2 00:00:00 scope service-profile sample
3 00:00:00 show cli history

Switch-A /org/service-profile #

Related Commands Command Description


show cli

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1525
Commands
show clock (system)

show clock (system)


To display the system clock, use the show clock command.

show clock [detail]

Syntax Description detail (Optional) Displays detailed information in list form.

Command Default None

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the clock:


switch-A# scope system
switch-A /system # scope services
switch-A /system/services # show clock
Tue Apr 20 13:24:33 PDT 2010
switch-A /system/services #

Related Commands Command Description


set clock (system)

set timezone

Cisco UCS Manager CLI Command Reference, Release 2.0


1526 OL-25718-02
Commands
show cluster

show cluster
To display cluster information, use the show cluster command.

show cluster{extended-state | state}

Syntax Description extended-state Displays extended information about the state of the cluster.

state Specifies information about the state of the cluster.

Command Default Displays cluster information.

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to display extended information about the state of the cluster:

switch-A# show cluster extended-state

Cluster Id: 0x7433f72a371511de-0xb90b000decb1ad44


Start time: Tue Jul 7 09:17:46 2009
Last election time: Tue Jul 7 09:22:17 2009
A: UP, PRIMARY
B: UP, INAPPLICABLE, (Management services: DOWN)
A: memb state UP, lead state PRIMARY, mgmt services state: UP
B: memb state UP, lead state INAPPLICABLE, mgmt services state: DOWN
heartbeat state PRIMARY_OK
INTERNAL NETWORK INTERFACES:
eth1, UP
eth2, UP
HA NOT READY
Management services are unresponsive on peer switch
No chassis configured
switch-A#

Related Commands Command Description


show org
show vif

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1527
Commands
show connectivity

show connectivity
To display connectivity information, use the show connectivity command.

show connectivity

Syntax Description This command has no arguments or keywords.

Command Default Displays connectivity information.

Command Modes Organization (/org/service-profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display connectivity information:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # show connectivity

Related Commands Command Description


show hv-conn
show inventory

Cisco UCS Manager CLI Command Reference, Release 2.0


1528 OL-25718-02
Commands
show console-auth

show console-auth
To display the console authentication information, use the show console-auth command.

show console-auth [detail]

Syntax Description detail (Optional) Displays additional information of the authentication mechanism.

Command Default This command displays information on the console authentication mechanism in a tabular format.

Command Modes Security (/security)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view information on console authentication:


Switch-A # scope security
Switch-A /security # show console-auth detail

Console authentication:
Realm: Local
Authentication Server Group: Default

Related Commands Command Description


scope console-auth
scope auth-server-group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1529
Commands
show core-export-target

show core-export-target
To display core export target information, use the show core-export-target command.

show core-export-target [detail | fsm status]

Syntax Description detail (Optional) Displays details about the core export target.

fsm status (Optional) Displays the status of the finite state machine.

Command Default Displays core export target information.

Command Modes Sysdebug (/monitoring/sysdebug)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This command shows how to display core export target information:

switch-A# scope monitoring

switch-A /monitoring # scope sysdebug

switch-A /monitoring/sysdebug # show core-export-target

Core Export Target:


Server Name:
Port: 69
Path:
Administrative State: Disabled
Description:
Current Task:
switch-A /monitoring/sysdebug #

Related Commands Command Description


show cores
show fsm

Cisco UCS Manager CLI Command Reference, Release 2.0


1530 OL-25718-02
Commands
show cores

show cores
To displays the core dump file, use the show cores command.

show cores [name {a| b}] [detail]

Syntax Description name (Optional) Displays a specific core dump file.

a Displays the core dump file for switch A.

b Displays the core dump file for switch B.

detail (Optional) Displays details about the core dump file.

Command Default Displays the core dump file.

Command Modes Sysdebug (/monitoring/sysdebug)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the core dump file:

switch-A# scope monitoring

switch-A /monitoring # scope sysdebug

switch-A /monitoring/sysdebug # show cores

Core Files:
Name Fabric ID
---------- ---------
1266567175_SAM_Pubs-B_svc_sam_bladeAG_log.18412.tar.gz
B
1266270932_SAM_Pubs-B_svc_sam_bladeAG_log.8876.tar.gz
B
1265702128_SAM_Pubs-A_svc_sam_portAG_log.8802.tar.gz
A
1265443496_SAM_Pubs-A_svc_sam_bladeAG_log.22792.tar.gz
A
1265130233_SAM_Pubs-A_svc_sam_bladeAG_log.8801.tar.gz
A
1264676542_SAM_Pubs-A_svc_sam_portAG_log.12062.tar.gz

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1531
Commands
show cores

A
1263728238_SAM_Pubs-A_svc_sam_portAG_log.3266.tar.gz
A

switch-A /monitoring/sysdebug #

Related Commands Command Description


show core-export-target

Cisco UCS Manager CLI Command Reference, Release 2.0


1532 OL-25718-02
Commands
show cpu

show cpu
To display CPU information, use the show cpu command.

show cpu [detail]

Syntax Description detail (Optional) Displays details about the CPU.

Command Default Displays CPU information.

Command Modes Server (/chassis/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display CPU details:

switch-A# scope chassis 1

switch-A /chassis # scope server 1

switch-A /chassis/server # show cpu

Server 1/1:
ID Presence Architecture Socket Cores Speed (GHz)
— -------------------- ----------------- ------ ----------- -----------
1 Equipped Xeon CPU1 4 2.266000
2 Equipped Xeon CPU2 4 2.266000
switch-A /chassis/server #

Related Commands Command Description


show chassis
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1533
Commands
show default-auth

show default-auth
To display information on the default authentication mechanism, use the show default-auth command.

show default-auth [detail]

Syntax Description detail (Optional) To view the realm group and the authentication server group for the default
authentication mechanism.

Command Default By default, this command lists the realm and the authentication server group details in a tabular format.

Command Modes Security (/security)


Authentication Domain (/security/auth-domain)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An authentication domain must be created to use this command within the authentication domain mode.

Examples This example shows how to view the default authentication mechanism for an authentication domain.
Switch-A # scope security
Switch-A /security # scope auth-domain Sample
Switch-A /security/auth-domain # show default-auth detail

Default authentication:
Realm: Local
Authentication server group: Testing

Related Commands Command Description


create default-auth
scope default-auth
enter default-auth
delete default-auth

Cisco UCS Manager CLI Command Reference, Release 2.0


1534 OL-25718-02
Commands
show destination

show destination
To display destination information, use the show destination command.

show destination [email-address | detail | expand]

Syntax Description email-address (Optional) Displays a specific email address.

detail (Optional) Displays a list of email addresses.

expand (Optional) Displays a list of email addresses.

Command Default Displays destination information.

Command Modes Profile (/monitoring/callhome/profile)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show destination command without any arguments or keywords to display a list of
email addresses.

Examples This example shows how to display a list of email addresses:

switch-A# scope monitoring

switch-A /monitoring# scope callhome

switch-A /monitoring/callhome # scope profile

switch-A /monitoring/callhome/profile # show destination detail

Destination:
Email: bob@cisco.com
Email: sally@cisco.com
switch-A /monitoring/callhome/profile #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1535
Commands
show destination

Related Commands Command Description


show profile

Cisco UCS Manager CLI Command Reference, Release 2.0


1536 OL-25718-02
Commands
show disk

show disk
To display disk information, use the show disk command.

show disk [vendor model revision | detail | expand]*

Syntax Description vendor (Optional) Displays a specific vendor name.

model (Optional) Displays a specific model number.

revision (Optional) Displays a specific revision number.

detail (Optional) Displays some details about each disk.

expand (Optional) Displays complete details about each disk.

Command Default Displays disk information.

Command Modes Capability (/system/capability)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines You can also use the show disk command without any arguments or keywords to display a list of disks.

Note If the server contains one or more SATA devices, such as a hard disk drive or solid state drive, this
command displays ATA in the Vendor field. Use the expand keyword to display additional vendor
information.

Examples This example shows how to display a list of disks:


switch-A# scope system
switch-A /system # scope capability
switch-A /system/capability # show disk
Disk Capacity:
Vendor Model HW Revision
------------------------ ------------------------ -----------
ATA SSDSA2SH064G1GC INTEL 0
FUJITSU MBB2147RC 0
FUJITSU MBC2073RC 0
SEAGATE ST9146802SS 0

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1537
Commands
show disk

SEAGATE ST973402SS 0
SEAGATE ST973451SS 0
switch-A /system/capability #

Related Commands Command Description


show cpu
show memory

Cisco UCS Manager CLI Command Reference, Release 2.0


1538 OL-25718-02
Commands
show distributed-virtual-switch

show distributed-virtual-switch
To display distributed virtual switch information, use the show distributed-virtual-switch command in
folder mode.

show distributed-virtual-switch [dvs-name | detail]

Syntax Description dvs-name The name of the distributed virtual switch.

detail Specifies detailed distributed virtual switch information, in list format.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware/vcenter/data-center/folder)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to display distributed virtual switch information:
switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # scope vcenter vc10
switch-A /system/vm-mgmt/vmware/vcenter # scope data-center dc10
switch-A /system/vm-mgmt/vmware/vcenter/data-center # scope folder f10
switch-A /system/vm-mgmt/vmware/vcenter/data-center # show distributed-virtual-switch dvs10

Distributed Virtual Switch:


Name Admin State
---------- -----------
dvs10 Disable

switch-A /system/vm-mgmt/vmware/vcenter/data-center #

Related Commands Command Description


show data-center
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1539
Commands
show dns

show dns
To display DNS information, use the show dns command.

show dns

This command has no arguments or keywords.

Command Default Displays DNS information.

Command Modes Services (/system/services)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This exampe shows how to display DNS information:

switch-A# scope system

switch-A /system # scope services

Related Commands Command Description


show http
show ntp

Cisco UCS Manager CLI Command Reference, Release 2.0


1540 OL-25718-02
Commands
show download-task

show download-task
To display download task information, use the show download-task command.

show download-task [file-name | detail | fsm]*

Syntax Description file-name (Optional) Displays a specific download.

detail (Optional) Displays complete details about each download.

fsm (Optional)

Command Default Displays download task information.

Command Modes Firmware (/firmware)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show download-task command without any arguments or keywords to display a list of
downloads.

Examples This example shows how to display a list of downloads:

switch-A# scope firmware

switch-A /firmware # show download-task

Download task:
File Name Protocol Server Userid State
--------- -------- --------------- --------------- -----
ucs-dplug.4.0.1a.N2.1.1.61.gbin
Scp 10.193.1.28 jaunderw Failed
ucs-k9-bundle.1.0.1.61.gbin
Scp t1.nuovasystems jaunderw Failed
ucs-k9-bundle.1.0.1.71.gbin
Scp t1.nuovasystems jaunderw Failed
switch-A /firmware #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1541
Commands
show download-task

Related Commands Command Description


show fsm
show image

Cisco UCS Manager CLI Command Reference, Release 2.0


1542 OL-25718-02
Commands
show dynamic-conn-policy

show dynamic-conn-policy
To display dynamic vNIC connection policy information, use the show dynamic-conn-policy command.

show dynamic-conn-policy [vnic-name | detail]

Syntax Description vnic-name (Optional) Displays information about a specific vNIC.

detail (Optional) Displays details about all vNICs.

Command Default Displays dynamic vNIC connection policy information.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show dynamic-vnic-conn-policy command without any arguments or keywords to
display a list of dynamic vNIC connection policies.

Examples This example shows how to display a list of dynamic vNIC connection policies:

switch-A# scope org org10

switch-A /org # show dynamic-vnic-conn-policy

Dynamic vNIC Connectivity Policy:


Name Dynamic Eth Enforcement Protection Adapter Profile Pin Group
-------------------- ----------- ----------- ---------- --------------- ---------
org10/dvcp10 60 Best Effort Protected
org10/dvcp11 61 Best Effort Protected
switch-A /org #

Related Commands Command Description


show vhba-templ
show vnic-templ

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1543
Commands
show egress-policy

show egress-policy
To display egress-policy information, use the show egress-policy command in qos-policy mode.

show egress-policy [detail | expand]

Syntax Description detail Displays all egress policy information, in list format.

expand Displays all egress policy information, in table format.

Command Default None

Command Modes QoS-policy (/org/qos-policy)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to display expanded egress policy information:
switch-A# scope org
switch-A /system # scope qos-policy
switch-A /system/vm-mgmt # show egress-policy expand

Egress QoS Policy:


Prio Rate Burst
----------- --------- -----
Best Effort 100000 10000

switch-A /system/vm-mgmt/vmware #

Related Commands Command Description


show data-center
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


1544 OL-25718-02
Commands
show environment

show environment
To display environment information, use the show environment command.

show environment [adapter | board | cpu | detail | expand | memory]

Syntax Description adapter (Optional) Displays information about the adapter.

board (Optional) Displays information about the motherboard.

cpu (Optional) Displays information about the CPU.

detail (Optional)

expand (Optional)

memory (Optional) Displays information about the memory.

Command Default Displays environment information.

Command Modes Server (/chassis/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show environment command without any arguments or keywords to display the state
of the server.

Examples This example shows how to display information about the motherboard:

switch-A#scope chassis 1

switch-A /chassis # scope server 1/1

switch-A /chassis/server # show environment

Server 1/1:
Oper Power: On

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1545
Commands
show environment

Motherboard:
Threshold Status: OK
Power State: N/A
Thermal Status: OK
Voltage Status: OK
CMOS Battery Voltage Status: OK
switch-A /chassis/server #

Related Commands Command Description


show memory
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


1546 OL-25718-02
Commands
show error-recovery

show error-recovery
To display error recovery information, use the show error-recovery command.

show error-recovery [detail | expand]*

Syntax Description detail (Optional) Displays details about error recovery.

expand (Optional) Displays limited details about error recovery.

Command Default Displays error recovery information.

Command Modes Fibre Channel host (/chassis/server/adapter/host-fc)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display

switch-A /org # scope chassis 1

switch-A /chassis # scope server 1/1

switch-A /chassis/server # scope adapter 1/1/1

switch-A /chassis/server/adapter # scope host-fc 1

switch-A /chassis/server/adapter/host-fc-if # show error-recovery

Related Commands Command Description


show port

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1547
Commands
show eth-classified

show eth-classified
To Ethernet classified information, use the show eth-classified command.

show error-recovery [bronze | detail | gold | platinum | silver]

Syntax Description bronze (Optional) Displays the bronze class.

detail (Optional) Displays all the classes.

gold (Optional) Displays the gold class.

platinum (Optional) Displays the platinum class.

silver (Optional) Displays the silver class.

Command Default Displays Ethernet classified class information.

Command Modes QoS (/eth-server/qos)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the platinum Ethernet classified class:

switch-A# scope eth-server

switch-A /eth-server # scope qos

switch-A /eth-server/qos # show eth-classified platinum

Ethernet Classified Class


Priority: Platinum
Cos: 5
Weight: 10
Bw Percent: Not Applicable
Drop: No Drop
Mtu: Normal
Multicast Optimize: No

Cisco UCS Manager CLI Command Reference, Release 2.0


1548 OL-25718-02
Commands
show eth-classified

Admin State: Disabled


switch-A /eth-server/qos #

Related Commands Command Description


show eth-best-effort
show fc

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1549
Commands
show eth-if

show eth-if
To display Ethernet interface information, use the show eth-if command.

show eth-if [interface-name | detail | expand]*

Syntax Description interface-name (Optional) Displays information about a specific interface.

detail (Optional) Displays detailed Ethernet interface information.

expand (Optional) Displays limited Ethernet interface information.

Command Default Displays Ethernet interface information.

Command Modes Virtual NIC (/org/service-profile/vnic)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display Ethernet interface information:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # scope vnic vnic10

switch-A /org/service-profile/vnic # show eth-if

Ethernet Interface:
Name: default
Dynamic MAC Addr: 00:00:00:00:00:00
Default Network: Yes
VLAN ID: 1
switch-A /org/service-profile/vnic #

Cisco UCS Manager CLI Command Reference, Release 2.0


1550 OL-25718-02
Commands
show eth-if

Related Commands Command Description


show fc-if
show vnic

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1551
Commands
show eth-if (vnic-iscsi)

show eth-if (vnic-iscsi)


To display information on the VLAN Ethernet interface, use the show eth-if command.

show eth-if {expand| detail}*

Syntax Description expand To display expanded information.

detail To display detailed information.

Command Default None

Command Modes iSCSI VNIC (/org/service-profile/vnic-iscsi)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines Ethernet interfaces for the iSCSI VNIC must be created to use this command.

Examples This example shows how to display expanded information on the Ethernet interface.
UCS-A # scope org test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # show eth-if expand

Ethernet Interface:

VLan Name: testing

IPv4 Interface:

DHCP Initiator IP Params:

Static target:
Priority: 1
Name: trial
Port: 3260
Auth Name: sample

Target Lun:
Target LUN ID:
--------------
1

UCS-A /org/service-profile/vnic-iscsi #

Cisco UCS Manager CLI Command Reference, Release 2.0


1552 OL-25718-02
Commands
show eth-if (vnic-iscsi)

Related Commands Command Description


create eth-if (vnic-iscsi)

scope eth-if (vnic-iscsi)

enter eth-if (vnic-iscsi)

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1553
Commands
show eth-mon-session

show eth-mon-session
To display the Ethernet traffic monitoring session, use the show eth-mon-session command.

show eth-mon-session [ name ] {expand| detail}*

Syntax Description name (Optional) Name of the Ethernet traffic monitoring session.

expand Displays additional information on all Ethernet traffic monitoring sessions, in


list format.

detail Displays information on all Ethernet traffic monitoring session, in list format.

Command Default Displays information on all Ethernet Traffic monitoring sessions.

Command Modes Fabric (/eth-traffic-mon/fabric)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You can use the show command without any options to view all the Ethernet traffic monitoring sessions.

Examples This example shows how to view information on a specific Ethernet traffic monitoring session:
Switch-A # scope eth-traffic-mon
Switch-A /eth-traffic-mon # scope fabric a
Switch-A /eth-traffic-mon/fabric # show eth-mon-session Default detail

Ether Traffic Monitoring Session:


Name: Default
Admin State: Disabled
Oper State: Error
Oper State Reason: Session Admin Shut

Switch-A /eth-traffic-mon/fabric #

Related Commands Command Description


create eth-mon-session
delete eth-mon-session

Cisco UCS Manager CLI Command Reference, Release 2.0


1554 OL-25718-02
Commands
show eth-profile

show eth-profile
To display Ethernet profile information, use the show eth-profile command.

show eth-profile [profile-name | detail | expand]*

Syntax Description profile-name (Optional) Displays information about a specific Ethernet profile.

detail (Optional) Displays details about all Ethernet profiles.

expand (Optional) Displays limited details about all Ethernet profiles.

Command Default Displays Ethernet profile information.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show eth-profile command without any arguments or keywords to display a list of
Ethernet profiles.

Examples This example shows how to display a list of Ethernet profiles:

switch# scope org org10

switch /org # show eth-profile

Eth Profile:
Name
----
org10/ep10
org10/ep11
org10/ep12
switch /org #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1555
Commands
show eth-profile

Related Commands Command Description


show fc-profile
show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


1556 OL-25718-02
Commands
show eth-target

show eth-target
To display information on the Ethernet target endpoint, use the show eth-target command.

show eth-target{name| detail| expand}

Syntax Description name (Optional) To view information on a specific Ethernet target endpoint.

detail (Optional) To view detailed information on all configured Ethernet target


endpoints.

expand (Optional) To view expanded information on all Ethernet target endpoints.

Command Default By default, this command displays expanded information on the Ethernet target endpoints.

Command Modes Interface (/eth-storage/fabric/interface)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines To use this command, Ethernet target endpoints must be configured for a fabric interface.

Examples This example shows how to display information on a specific Ethernet target endpoint.
Switch-A # scope eth-storage
Switch-A /eth-storage # scope fabric a
Switch-A /eth-storage/fabric # scope interface 1 2
Switch-A /eth-storage/fabric/interface # show eth-target Test

Ethernet Target Endpoint:

Name Target MAC Address


---- ------------------
Test 11:22:33:44:55:66

Switch-A /eth-storage/fabric/interface #

Related Commands Command Description


create eth-target

create interface

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1557
Commands
show eth-uplink

show eth-uplink
To display Ethernet uplink information, use the show eth-uplink command.

show eth-profile [detail | expand | fsm status]*

Syntax Description detail (Optional) Displays some detail about the Ethernet uplink.

expand (Optional) Displays all details about the Ethernet uplink.

fsm status (Optional) Displays the finite state machine.

Command Default Displays Ethernet uplink information.

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display Ethernet uplink information:

switch# show eth-uplink expand

Ethernet Uplink:
Mode: End Host
Fabric:
Id: A
Id: B
Stats Threshold Policy:
Full Name: fabric/lan/thr-policy-default
VLAN:
Name VLAN ID Fabric ID Native VLAN
---------- ---------- --------- -----------
default 1 Dual Yes
switch#

Cisco UCS Manager CLI Command Reference, Release 2.0


1558 OL-25718-02
Commands
show eth-uplink

Related Commands
Command Description
show eth-profile
show fabric-interconnect

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1559
Commands
show event

show event
To display event information, use the show event command.

show event [event-id | detail]

Syntax Description event-id (Optional) Displays a specific event.

detail (Optional) Displays all events.

Command Default Displays event information.

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show event command without any arguments or keywords to display a list of events.

Examples This example shows how to display a list of events:

switch-A# show event

Creation Time ID Description


-------------------- -------- -----------
2009-07-31T06:45:40.162 33117 [FSM:STAGE:END]: unprovisioning the Virtual
media bootable device for blade 1/1(
2009-07-31T06:45:40.162 33118 [FSM:STAGE:SKIP]: Disconnect pre-boot environment
agent for server 1/1(FSM-STAGE
2009-07-31T06:45:40.162 33119 [FSM:STAGE:END]: Disconnect pre-boot environment
agent for server 1/1(FSM-STAGE:
2009-07-31T06:45:40.162 33120 [FSM:STAGE:SKIP]: Shutdown the server 1/1; deep
discovery completed(FSM-STAGE:sam
2009-07-31T06:45:40.162 33121 [FSM:STAGE:END]: Shutdown the server 1/1; deep
discovery completed(FSM-STAGE:sam
2009-07-31T06:45:40.162 33122 [FSM:STAGE:SKIP]: Invoke post-discovery policies
on server 1/1(FSM-STAGE:sam:dme
2009-07-31T06:45:40.162 33123 [FSM:STAGE:END]: Invoke post-discovery policies
on server 1/1(FSM-STAGE:sam:dme:
switch-A#

Cisco UCS Manager CLI Command Reference, Release 2.0


1560 OL-25718-02
Commands
show event

Related Commands Command Description


show fault
show sel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1561
Commands
show execute-disable

show execute-disable
To view execute-disable information, use the show execute-disable command.

show execute-disable {expand| detail}*

Syntax Description expand (Optional) Displays information on execute-disable options in an expanded


form.

detail (Optional) Displays detailed information.

Command Default Displays expanded form of information.

Command Modes BIOS Policy (/org/bios-policy)


BIOS Settings for a server (/chassis/server/bios/bios-settings)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view expanded execute-disable information for a BIOS Policy.
Switch-A # scope org Test
Switch-A /org # scope bios-policy sample
Switch-A /org/bios-policy # show execute-disable expand

Execute Disable
Bit
---
Enabled

Switch-A /org/bios-policy #

Related Commands Command Description


set execute-disable bit

Cisco UCS Manager CLI Command Reference, Release 2.0


1562 OL-25718-02
Commands
show extension-key

show extension-key
To display extension key information, use the show extension-key command in vmware mode.

show extension-key [detail | fsm status]

Syntax Description detail Specifies detailed extension key information, in list format.

fsm status Specifies the extension key finite state machine status.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to display extension key information:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # show extension-key detail

Extension Key:
Key: Cisco-UCSM-DOC-TEAM-EXT-KEY
Current Task: Busy

switch-A /system/vm-mgmt/vmware #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1563
Commands
show ext-eth-if

show ext-eth-if
To display external Ethernet interface information, use the show ext-eth-if command.

show ext-eth-if [interface-id | detail | expand]

Syntax Description interface-id (Optional) Displays a specific interface.

detail (Optional) Displays details about all interfaces.

expand Displays a list of interfaces.

Command Default Displays information about the external Ethernet interfaces.

Command Modes Adapter (/chassis/server/adapter)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show ext-eth-if command without any arguments or keywords to display a list of
interfaces.

Examples This example shows how to display a list of interfaces:

switch-A# scope chassis 1

switch-A /chassis # scope server 1/1

switch-A /chassis/server # scope adapter 1/1/1

switch-A /chassis/server/adapter # show ext-eth-if

Ext Interface:
Adapter Id Id Mac Fabric ID Oper State
---------- ---------- ----------------- --------- ----------
1 1 00:23:04:C6:A2:8C A Link Up
1 2 00:23:04:C6:A2:8D B Link Up
switch-A /chassis/server/adapter #

Cisco UCS Manager CLI Command Reference, Release 2.0


1564 OL-25718-02
Commands
show ext-eth-if

Related Commands Command Description


show host-eth-if
show host-fc-if

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1565
Commands
show ext-ipv6-rss-hash

show ext-ipv6-rss-hash
To display IPv6 RSS hash profile information, use the show ext-ipv6-rss-hash command.

show ext-ipv6-rss-hash [ detail | expand]

Syntax Description detail (Optional) Displays details about the external IPv6 RSS hash profile.

expand (Optional) Displays details about the external IPv6 RSS hash profile.

Command Default Displays information about the external IPv6 RSS hash profile.

Command Modes Host Ethernet (/chassis/server/adapter/host-eth)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the external IPv6 RSS hash profile:

switch-A# scope chassis 1

switch-A /chassis # scope server 1/1

switch-A /chassis/server # scope adapter 1/1/1

switch-A /chassis/server/adapter # scope host-eth 1

switch-A /chassis/server/adapter/host-eth-if # show ext-ipv6-rss-hash

External IPv6 RSS Hash Profile:


IP Hash: Disabled
TCP Hash: Disabled
switch-A /chassis/server/adapter/host-eth-if #

Related Commands Command Description


show ipv4-rss-hash
show ipv6-rss-hash

Cisco UCS Manager CLI Command Reference, Release 2.0


1566 OL-25718-02
Commands
show fabric

show fabric
To display fabric interconnect information, use the show fabric command.

fc-uplink mode
show fabric [ a | b | detail | expand]

chassis mode
show fabric [detail]

Syntax Description a (Optional) Displays information about Fabric A.

b (Optional) Displays information about Fabric B.

detail (Optional) Displays details about the fabric interconnect.

expand (Optional) Displays details about the fabric interconnect.

Command Default Displays information about the fabric interconnect.

Command Modes Fibre Channel uplink (/fc-uplink)


Chassis (/chassis)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show fabric command in chassis mode, without any arguments or keywords, to display
a list of fabrics.

Examples This example shows how to display a list of fabrics:

switch-A# scope fc-uplink

switch-A /fc-uplink # show fabric

Locale:

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1567
Commands
show fabric

Id Name C Type Transport Side Slot Id Locale Type


-- ---------- -------------- --------- ----- ---------- -------- ----
A Mux To Host Ether Left 1 Server Lan
B Mux To Host Ether Right 1 Server Lan
A Mux To Host Ether Left 2 Server Lan
B Mux To Host Ether Right 2 Server Lan
A Mux To Host Ether Left 3 Server Lan
B Mux To Host Ether Right 3 Server Lan
A Mux Fabric Ether Left 1 Chassis Lan
B Mux Fabric Ether Right 2 Chassis Lan
switch-A /fc-uplink #

Related Commands Command Description


show interface
show pin-group

Cisco UCS Manager CLI Command Reference, Release 2.0


1568 OL-25718-02
Commands
show fabric-interconnect

show fabric-interconnect
To display fabric interconnect information, use the show fabric-interconnect command.

show fabric-interconnect [ a| b][detail| fsm status]

Syntax Description a (Optional) Displays information about Fabric A.

b (Optional) Displays information about Fabric B.

detail (Optional) Displays details about the fabric interconnect.

fsm status (Optional) Displays finite state machine information.

Command Default Displays information about the fabric interconnect.

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display a list of fabric interconnects:


switch-A# show fabric-interconnect

Fabric Interconnect:
ID OOB IP Addr OOB Gateway OOB Netmask Operability
-- --------------- --------------- --------------- -----------
A 10.193.66.91 10.193.64.1 255.255.248.0 Operable
B 10.193.66.92 10.193.64.1 255.255.248.0 Operable

switch-A#

Related Commands Command Description


show fabric-interconnect inventory
show fabric-interconnect mode

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1569
Commands
show fabric-interconnect inventory

show fabric-interconnect inventory


To display fabric interconnect hardware information, use the show fabric-interconnect inventory command.

show fabric-interconnect inventory [id { a| b}][expand] [detail]

Syntax Description a (Optional) Displays information about Fabric A.

b (Optional) Displays information about Fabric B.

detail (Optional) Displays details about the fabric interconnect


hardware.

expand (Optional) Displays details about the fabric interconnect


hardware.

Command Default Displays information about the fabric interconnect hardware.

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display a list of fabric interconnect hardware:
switch-A# show fabric-interconnect inventory

ID PID Vendor Serial (SN) HW Revision Total Memory (MB)


-------- --------------- ----------------- ----------- ----------- -----------------
A N10-S6100 Cisco Systems, In SSI12480266 0 3549
B N10-S6100 Cisco Systems, In SSI12520C81 0 3549

switch-A#

Related Commands Command Description


show fabric-interconnect
show fabric-interconnect mode

Cisco UCS Manager CLI Command Reference, Release 2.0


1570 OL-25718-02
Commands
show fabric-interconnect mode

show fabric-interconnect mode


To display the fabric interconnect mode, use the show fabric-interconnect mode command.

show fabric-interconnect mode

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the fabric interconnect mode:
switch-A# show fabric-interconnect mode

Ethernet switching mode:


Mode: End Host
FC switching mode:
Mode: End Host

switch-A#

Related Commands Command Description


show fabric-interconnect

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1571
Commands
show fabric-port-channel

show fabric-port-channel
To display information on the fabric port channels, use the show fabric-port-channel command.

show fabric-port-channel [ port channel id ] {expand| detail}*

Syntax Description port channel id (Optional) The ID of the port channel interface. It must be a value between
1024 and 4096.

expand Displays expanded information on the port channel interface, including member
port information.

detail Displays detailed information on the port channel interface.

Command Default None

Command Modes Fabric within the Ethernet server mode (/eth-server/fabric)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines The fabric port channels must be available to use this command.

Examples This example shows how to display information on the fabric port channels available in fabric A in the Ethernet
server mode:
UCS-A # scope eth-server
UCS-A /eth-server # scope fabric a
UCS-A /eth-server/fabric # show fabric-port-channel

Fabric Port Channel:

Port Channel ID Chassis ID Admin State Oper State State Reason


--------------- ---------- ----------- ---------- -------------
1123 1 Enabled Up

UCS-A /eth-server/fabric #

Related Commands Command Description


scope fabric-port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


1572 OL-25718-02
Commands
show fabric-port-channel

Command Description
show host-port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1573
Commands
show failover

show failover
To display failover timeout information, use the show failover command.

show failover [detail | expand]

Syntax Description detail (Optional) Displays detailed failover timeout information.

expand (Optional) Displays detailed failover timeout information.

Command Default Displays information about the failover timeout.

Command Modes Host Ethernet (/chassis/server/adapter/host-eth)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display detailed failover timeout information:

switch-A# scope chassis 1

switch-A /chassis # scope server 1/1

switch-A /chassis/server # scope adapter 1/1/1

switch-A /chassis/server/adapter # scope host-eth 1

switch-A /chassis/server/adapter/host-eth # show failover

Ethernet Failover Profile:


Timeout (sec): 5
switch-A /chassis/server/adapter/host-eth #

Related Commands Command Description


show event
show fault

Cisco UCS Manager CLI Command Reference, Release 2.0


1574 OL-25718-02
Commands
show fan

show fan
To display fan information, use the show fan command.

capability mode
show fan [vendor model hardware-rev | detail | expand]

fan-module mode
show fan [detail | expand]

Syntax Description vendor (Optional) Displays the vendor name.

model (Optional) Displays the model number.

hw-rev (Optional) Displays the hardware revision number.

detail (Optional) Displays detailed fan information.

expand (Optional) Displays expanded fan information.

Command Default Displays information about the fan.

Command Modes Capability (/system/capability)


Fan module (/chassis/fan-module)
Fabric interconnect (any command mode)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show fan command without any arguments or keywords, in capability mode, to display
a list of fans.

Examples This command shows how to display a list of fans:

switch-A# scope system

switch-A /system # scope capability

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1575
Commands
show fan

switch-A /system/capability # show fan

Fan Module:
Vendor Model HW Revision
------------------------ ------------------------ -----------
Cisco 73-11624-02 04
Cisco Systems N5K-C5010-FAN 0
Cisco Systems N5K-C5020-FAN 0
Cisco Systems Inc N10-FAN1= 0
Cisco Systems Inc N10-FAN2= 0
Cisco Systems Inc N20-FAN5 0
N/A N10-FAN1 0
N/A N10-FAN2 0
switch-A /system/capability #

Related Commands Command Description


show chassis
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


1576 OL-25718-02
Commands
show fan-module

show fan-module
To display fan module information, use the show fan-module command.

show fan [traymodule][detail][expand]

Syntax Description tray module (Optional) Displays a specific module in a specific tray.

detail (Optional) Displays detailed information about all fans.

expand (Optional) Displays limited information about all fans.

Command Default Displays information about the fan module.

Command Modes Chassis (/chassis)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show fan-module command without any arguments or keywords to display a list of fan
modules.

Examples This command shows how to display a list of fan modules:

switch-A# scope chassis 1

switch-A /system/capability # show fan-module

Fan Module:
Tray Module Overall Status
---------- ---------- --------------
1 1 Operable
1 2 Operable
1 3 Operable
1 4 Operable
1 5 Operable
1 6 Operable
1 7 Operable
1 8 Operable
switch-A /system/capability #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1577
Commands
show fan-module

Related Commands Command Description


show fan
show iom

Cisco UCS Manager CLI Command Reference, Release 2.0


1578 OL-25718-02
Commands
show fault policy

show fault policy


To display fault policy information, use the show fault policy command.

show fault policy [detail]

Syntax Description detail (Optional) Displays detailed information about the fault policy.

Command Default Displays information about the fault policy.

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the fault policy:

switch-A# scope monitoring

switch-A /monitoring # show fault policy

Fault Policy:
Clear Action: Retain
Retention Interval: 00:01:00:00
Flap Interval (sec): 10
switch-A /monitoring # show fault policy

Related Commands Command Description


show fault
show syslog

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1579
Commands
show fc

show fc
To display Fibre Channel class information, use the show fc command.

show fc [detail]

Syntax Description detail (Optional) Displays detailed Fibre Channel class information.

Command Default Displays information about the Fibre Channel class.

Command Modes QoS (/eth-server/qos)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display Fibre Channel class information:

switch-A# scope eth-server

switch-A /eth-server # scope qos

switch-A /eth-server/qos # show fc

FC Class:
Priority: 1
Cos: 3
Weight: 5
Bw Percent: 50
Drop: No Drop
Mtu: Fc
Admin State: Enabled
switch-A /eth-server/qos #

Related Commands Command Description


show eth-best-effort
show eth-classified

Cisco UCS Manager CLI Command Reference, Release 2.0


1580 OL-25718-02
Commands
show fc-if

show fc-if
To display Fibre Channel interface information, use the show fc-if command.

show fc-if [detail][expand]

Syntax Description detail (Optional) Displays detailed Fibre Channel interface information.

expand (Optional) Displays expanded Fibre Channel interface information.

Command Default Displays information about Fibre Channel interfaces.

Command Modes Virtual HBA (/org/service-profile/vhba)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display Fibre Channel interface information:

switch-A# scope org org10

switch-A /org # scope service-profile sp10

switch-A /org/service-profile # scope vhba vhba10

switch-A /org/service-profile/vhba # show fc-if

Fibre Channel Interface:


Name: default
vSAN ID: 1
switch-A /org/service-profile/vhba #

Related Commands Command Description


show eth-if
show vhba

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1581
Commands
show fc-profile

show fc-profile
To display Fibre Channel profile information, use the show fc-profile command.

show fc-profile [profile-name][detail][expand]

Syntax Description profile-name (Optional) Displays a specific Fibre Channel profile.

detail (Optional) Displays limited details about all Fibre Channel profiles.

expand (Optional) Displays expanded information about all Fibre Channel profiles.

Command Default Displays information about Fibre Channel profiles.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show fc-profile command without any arguments or keywords to display a list of Fibre
Channel profiles.

Examples This example shows how to display a list of Fibre Channel profiles:

switch-A# scope org org10

switch-A /org/ # show fc-profile

FC Profile:
Name
----
org10/fcp10
org10/fcp11
switch-A /org/ #

Related Commands Command Description


show eth-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


1582 OL-25718-02
Commands
show fc-profile

Command Description
show org

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1583
Commands
show fc-storage

show fc-storage
To display information on the Fibre Channel storage device, use the show fc-storage command.

show fc-storage {expand| detail}*

Syntax Description expand (Optional) To view additional information about the Fibre Channel storage device.

detail (Optional) To view detailed information about the Fibre Channel storage device.

Command Default By default, this command displays the Fibre Channel over Ethernet native VLAN ID.

Command Modes Any command mode.

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view expanded information on the Fibre Channel storage device.
Switch-A # scope org Test
Switch-A /org # show fc-storage expand

FC Storage:

FCoE Storage Native VLAN: 44

VSAN:
Name: VSAN100_storage
ID: 100
FCoE VLAN ID: 100
Default zoning: disabled
Overall status: ok
Member Port:
Fabric ID Slot ID Port ID Oper State State Reason Oper Speed
--------- ------- ------- ---------- ------------ ----------
A 2 3 Down Administratively down Indeterminate

Name: test
ID: 200
FCoE VLAN ID: 200
Default zoning: disabled
Overall status: ok
Member Port:
Fabric ID Slot ID Port ID Oper State State Reason Oper Speed
--------- ------- ------- ---------- ------------ ----------
A 3 4 Down Administratively down Indeterminate

Cisco UCS Manager CLI Command Reference, Release 2.0


1584 OL-25718-02
Commands
show fc-storage

Switch-A /org #

Related Commands Command Description


scope fc-storage

create vsan

create vlan

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1585
Commands
show feature

show feature
To display information on a feature, use the show feature command.

show feature [name vendor version] [detail]

Syntax Description name Name of the feature. The name can include a maximum of 64 characters.

vendor Name of the vendor. The name can include a maximum of 510 characters.

version Version of the feature. The version can include a maximum of 510 characters.

detail (Optional) To display detailed information.

Command Default By default, this command displays the license feature information in a tabular format.

Command Modes License (/license)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to display detailed information on a license feature.
Switch-A # scope license
Switch-A /license # show feature detail

License feature:
Name: ETH_PORT_ACTIVATION_PKG
Vendor: cisco
Version: 1.0
Type: Counted
Grace Period: 120

Switch-A /license #

Related Commands Command Description


install file

clear file

Cisco UCS Manager CLI Command Reference, Release 2.0


1586 OL-25718-02
Commands
show file

show file
To view licenses installed on a fabric interconnect, use the show file command.

show file license file name detail

Syntax Description license file name (Optional) The name of a license file. Use this option to view the details of a
specific license file.

detail (Optional) Displays the licenses installed on the fabric interconnect with the
level of detail specified in the command.

Command Default None

Command Modes License (/license)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view the licenses details installed on a fabric interconnect.
Switch-A # scope license
Switch-A /license # show file detail

License file: UCSFEAT20100928112305377.lic


ID : 1212121212121212
Version: 1.0
Scope: A
State: Installed
Features
Feature names:ETH_PORT_ACTIVATION_PKG
Vendor: cisco
Version: 1.0
Quantity: 24
Lines:
Line ID: 1
Type: Increment
Expiry Date: Never
Pak:
Quantity: 24
Signature: B10101010101

License file: UCSFEAT20100928112332175.lic


ID : 1313131313131313
Version: 1.0

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1587
Commands
show file

Scope: B
State: Installed
Features
Feature names:ETH_PORT_ACTIVATION_PKG
Vendor: cisco
Version: 1.0
Quantity: 24
Lines:
Line ID: 1
Type: Increment
Expiry Date: Never
Pak:
Quantity: 24
Signature: F302020202020

Switch-A /license #

Related Commands Command Description


install file

show usage

Cisco UCS Manager CLI Command Reference, Release 2.0


1588 OL-25718-02
Commands
show host-port-channel

show host-port-channel
To display information on host port channels, use the show host-port-channel command.

show host-port-channel [ port channel id ] {expand| detail}*

Syntax Description port channel id (Optional) ID of the port channel. It must be a value between 1024 and 4096.

expand Displays expanded information on the host port channel, including member
port information.

detail Displays detailed information on the host port channel.

Command Default None

Command Modes Fabric within the Ethernet server mode (/eth-server/fabric)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines Host port channels must be configured to use this command.

Examples This example shows how to display information on host port channels within a fabric in the Ethernet server
mode:
UCS-A # scope eth-server
UCS-A /eth-server # scope fabric a
UCS-A /eth-server/fabric # show host-port-channel

Host Port channel:

Port Channel ID Chassis ID Oper State State Reason


--------------- ---------- ---------- -------------
1125 2 Up

UCS-A /eth-server/fabric #

Related Commands Command Description


show fabric-port-channel

scope host-port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1589
Commands
show identity iqn

show identity iqn


To display the IQN information for a system, use the show identity iqn command.

show identity iqn{detail | Word}

Syntax Description detail To display detailed information on the IQN identities.

Word To display information on a specific IQN identity.

Command Default By default, the command lists information on all IQN identities configured for an IQN pool.

Command Modes IQN Pool (/org/iqn-pool)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines IQN pools and prefixes must be configured to use this command.

Examples This example shows how to display information on IQN identities for an IQN pool.
UCS-A # scope org
UCS-A /org # scope iqn-pool sample
UCS-A /org/iqn-pool # show identity iqn

IQN Prefix IQN Name Assigned Pool DN


---------- -------- -------- --------
test1 sample:1 No org-root/iqn-pool-sample
test2 sample:2 No org-root/iqn-pool-sample
test3 sample:3 No org-root/iqn-pool-sample

UCS-A /org/iqn-pool #

Related Commands Command Description


create iqn-pool

create block

set iqn-prefix

Cisco UCS Manager CLI Command Reference, Release 2.0


1590 OL-25718-02
Commands
show identity (server)

show identity (server)


To display identity information for a server, use the show identity command.

show identity

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display identity information for a server:
switch-A# scope server 1/1
switch-A /chassis/server # show identity

Server 1/1:
Burned-In UUID: 6bf4c501-d3a9-11dd-b4d9-000bab01bfd6
Dynamic UUID: 6bf4c501-d3a9-11dd-b4d9-000bab01bfd6

Ext Interface:

Adapter Interface Mac


------- --------- ---
1 1 00:24:97:1F:5B:F2
1 2 00:24:97:1F:5B:F3

switch-A /chassis/server #

Related Commands Command Description


show chassis
show server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1591
Commands
show identity (service-profile)

show identity (service-profile)


To display identifier information for a service profile, use the show identity command.

show identity

This command has no arguments or keywords.

Command Default None

Command Modes Service profile (/org/service-profile)

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display identifier information for a service profile:
switch-A# scope org /org100
switch-A /org # scope service-profile sp100
switch-A /org/service-profile # show identity

Service Profile Name: org100/sp100


UUID Suffix Pool:
Dynamic UUID: Derived

switch-A /org/service-profile #

Related Commands Command Description


show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


1592 OL-25718-02
Commands
show identity mac-addr

show identity mac-addr


To display the MAC address identity information for a system, use the show identity mac-addr command.

show identity mac-addr [ id ] [pool-info| profile-info]+ [detail]

Syntax Description id Displays identity information for a specific MAC address. Specify a MAC
address in the format NN:NN:NN:NN:NN:NN.

pool-info (Optional) Displays identity information for the pool.

profile-info (Optional) Displays identity information for the profile.

detail (Optional) Displays details about the identity information in list format.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the MAC address identity information for a system:
switch-A# scope org /org100
switch-A /org # show identity mac-addr
MAC Address Assigned Owner Assigned Service Profile
----------------- -------- --------- ------------------------
00:25:B5:00:00:00 Yes Pool org-root/ls-Blade6-Default/ether-eth1
00:25:B5:00:00:01 No Pool
00:25:B5:00:00:02 No Pool
00:25:B5:00:00:03 No Pool
--More--

switch-A /org # show identity mac-addr pool-info


MAC Address Assigned Owner Pool DN
----------------- -------- --------- -------
00:25:B5:00:00:00 Yes Pool org-root/mac-pool-default/00:25:B5:00:00:00
00:25:B5:00:00:01 No Pool org-root/mac-pool-p100/00:25:B5:00:00:01
00:25:B5:00:00:02 No Pool org-root/mac-pool-p100/00:25:B5:00:00:02
00:25:B5:00:00:03 No Pool org-root/mac-pool-p100/00:25:B5:00:00:03
--More--

switch-A /org #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1593
Commands
show identity mac-addr

Related Commands Command Description


show org

Cisco UCS Manager CLI Command Reference, Release 2.0


1594 OL-25718-02
Commands
show identity uuid

show identity uuid


To display the universally unique identifier (UUID) identity information for a system, use the show identity
uuid command.

show identity uuid [ id ] [pool-info| profile-info]+ [detail]

Syntax Description id Displays identity information for a specific UUID. Specify a UUID in the form
NNNN-NNNNNNNNNNNN.

pool-info (Optional) Displays identity information for the pool.

profile-info (Optional) Displays identity information for the profile.

detail (Optional) Displays details about the identity information in list format.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the UUID identity information for a system:
switch-A# scope org /org100
switch-A /org # show identity uuid

UUID Assigned Owner Assigned Service Profile


----------------- -------- --------- ------------------------
0000-000000000001 No Pool

switch-A /org # show identity uuid pool-info


UUID Assigned Owner Pool DN
----------------- -------- --------- -------
0000-000000000001 No Pool org-root/uuid-pool-p100/0000-000000000001

switch-A /org #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1595
Commands
show identity uuid

Related Commands Command Description


show org

Cisco UCS Manager CLI Command Reference, Release 2.0


1596 OL-25718-02
Commands
show identity wwn

show identity wwn


To display the world-wide name (WWN) identity information for a system, use the show identity wwn
command.

show identity wwn [ id ] [pool-info| profile-info]+ [detail]

Syntax Description id Displays identity information for a specific WWN. Specify a unique WWN in
the form HH:HH:HH:HH:HH:HH:HH:HH.

pool-info (Optional) Displays identity information for the pool.

profile-info (Optional) Displays identity information for the profile.

detail (Optional) Displays details about the identity information in list format.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the WWN identity information for a system:
switch-A# scope org /org100
switch-A /org # show identity wwn
WWN Assigned Owner Assigned Service Profile
----------------------- -------- --------- ------------------------
20:00:00:25:B5:00:00:00 No Pool
20:00:00:25:B5:00:00:01 No Pool
20:00:00:25:B5:00:00:02 No Pool
20:00:00:25:B5:00:00:03 No Pool
--More--

switch-A /org # show identity wwn pool-info


WWN Assigned Owner Pool DN
----------------------- -------- --------- -------
20:00:00:25:B5:00:00:00 No Pool org-root/wwn-pool-p44/20:00:00:25:B5:00:00:00
20:00:00:25:B5:00:00:01 No Pool
org-root/wwn-pool-oneWWtwoNN/20:00:00:25:B5:00:00:01
20:00:00:25:B5:00:00:02 No Pool org-root/wwn-pool-default/20:00:00:25:B5:00:00:02
20:00:00:25:B5:00:00:03 No Pool org-root/wwn-pool-default/20:00:00:25:B5:00:00:03

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1597
Commands
show identity wwn

--More--

switch-A /org #

Related Commands Command Description


show org

Cisco UCS Manager CLI Command Reference, Release 2.0


1598 OL-25718-02
Commands
show interface

show interface
To display information about one or more interfaces on a fabric interconnect, use the show interface command.

show interface
show interface [slot-id port-id|fsm] [expand|detail]

Syntax Description slot-id (Optional) Slot identification number. The range of valid values is 2 to 5.

port-id (Optional) Port identification number. The range of valid values is 1 to 40.

fsm (Optional) Displays finite state machine information.

expand (Optional) Displays details about the interface.

detail (Optional) Displays details about the interface, including the admin state,
operating state, and port mode.

Command Default None

Command Modes Fabric interconnect under Fibre Channel uplink (/fc-uplink/fabric)


Fabric interconnect under Ethernet server (/eth-server/fabric)
Fabric interconnect under Ethernet storage (/eth-storage/fabric)
Fabric interconnect under Ethernet uplink (/eth-uplink/fabric)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to display information about one or more interfaces on a fabric interconnect.

Examples This example shows how to display expanded information about interfaces on a fabric interconnect:
switch-A# scope eth-storage
switch-A# /eth-storage # scope fabric b
switch-A# /eth-storage/fabric # show interface expand

Storage Ethernet Interface:


Slot ID: 2
Port Id: 7
Admin State: Enabled
Oper State: Sfp Not Present

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1599
Commands
show interface

State Reason: Unknown

Slot ID: 3
Port Id: 15
Admin State: Enabled
Oper State: Sfp Not Present
State Reason: Unknown
switch-A /eth-storage/fabric #

Examples This example shows how to display detailed information about a specific interface:
switch-A# scope eth-storage
switch-A# /eth-storage # scope fabric b
switch-A# /eth-storage/fabric # show interface 2 7 detail

Storage Ethernet Interface:


Slot ID: 2
Port Id: 7
User Label:
Admin State: Enabled
Oper State: Sfp Not Present
Port mode: Trunk
Pin group name:
State Reason: Unknown
Current Task:
switch-A /eth-storage/fabric #

Related Commands Command Description


create interface

Cisco UCS Manager CLI Command Reference, Release 2.0


1600 OL-25718-02
Commands
show inventory

show inventory
To display the configuration of the Call Home periodic system inventory message, use the show inventory
command.

show inventory [detail]

Syntax Description detail (Optional) Display additional configuration details.

Command Default None

Command Modes /exec/monitoring/callhome

Command History Release Modification


1.0(2) This command was introduced.

Usage Guidelines Use this command to display the configuration of the Call Home periodic system inventory message.

Examples This example shows how to display the configuration of the Call Home periodic system inventory message:
switch-A# scope monitoring
switch-A /monitoring # scope callhome
switch-A /monitoring/callhome # show inventory detail

Callhome periodic system inventory:


Send periodically: Off
Interval days: 14
Hour of day to send: 17
Minute of hour: 30
Time last sent: Never
Next scheduled: Never
Send Now: No

switch-A /monitoring/callhome/inventory #

Related Commands Command Description


set interval-days
set send-periodically
set timeofday-hour
set timeofday-minute

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1601
Commands
show inventory (fabric-interconnect)

show inventory (fabric-interconnect)


To display the physical inventory information for a fabric interconnect, use the show inventory command.

show inventory {detail | expand}

Syntax Description detail Displays summary information in a list.

expand Displays details of the physical components of the fabric interconnect such as ports
and the transceivers in them, the power supply unit and FAN components.

Command Default By default, this command displays ID, PID, vendor, serial number, hardware revision, and total memory of
the fabric interconnect in a tabular format.

Command Modes Fabric interconnect (/fabric-interconnect)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to display expanded information for a fabric interconnect.
UCS-A # scope fabric-interconnect a
UCS-A /fabric-interconnect # show inventory expand

A:
Fabric Card:

Slot Description Num Ports State PID Serial(SN)


---- ----------- --------- ------ --- ----------
1 02 16 port flexible GEM 16 Online UCS-FI-6248UP JAF1453BNBL

Ether Port:

Slot Port Oper State MAC Role Xvcr


---- ---- ---------- --- ---- ----
1 1 Up 00:05:73:CB:64:E8 Network N/A
2 8 Sfp Not Present 00:05:73:B0:07:CF Server N/A

FAN:

ID PID Serial(SN) Overall Status


--- --- ---------- --------------
1 UCS-FAN-6248UP N/A Operable

Cisco UCS Manager CLI Command Reference, Release 2.0


1602 OL-25718-02
Commands
show inventory (fabric-interconnect)

PSU:

PSU PID Serial(SN) Overall Status


--- --- ---------- --------------
1 UCS-PSU-6248UP-AC ART1452X0BR Operable

UCS-A /fabric-interconnect #

Related Commands Command Description


show fabric-interconnect

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1603
Commands
show ipmi-user

show ipmi-user
To display IPMI user information, use the show ipmi-user command.

show ipmi-user [ipmi-user-name | detail | expand]*

Syntax Description ipmi-user-name (Optional) Displays information about a specific IPMI user.

detail (Optional) Displays details about all end-point users.

expand (Optional) Displays limited details about all end-point users.

Command Default Displays IPMI user information.

Command Modes IPMI access profile (/org/ipmi-access-profile)

Command History Release Modification


1.0(1) This command was introduced as show epuser.

1.4(1) This command was renamed as show ipmi-user.

Usage Guidelines This command does not require a license.


You can also use the show ipmi-user command without any arguments or keywords to display a list of IPMI
users.

Examples This example shows how to display a list of IPMI users:

switch-A# scope org org10

switch-A /org # scope ipmi-access-profile ipmiAP10

switch-A /org/ipmi-access-profile # show ipmi-user

IPMI user:
User Name End point user privilege Password
---------- ------------------------ --------
epu10 Readonly
epu11 Readonly
switch-A /org/ipmi-access-profile #

Cisco UCS Manager CLI Command Reference, Release 2.0


1604 OL-25718-02
Commands
show ipmi-user

Related Commands Command Description


create ipmi-user
scope ipmi-user

enter ipmi-user

show ipmi-access-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1605
Commands
show iqn-pool

show iqn-pool
To display information on the IQN pools, use the show iqn-pool command.

show iqn-pool {name | detail | expand}

Syntax Description name To display information on a


specific IQN pool.

detail To display detailed information on


a specific IQN pool or on all IQN
pools.

expand To display expanded information


on a specific IQN pool or on all
IQN pools.

Command Default By default, this command displays information on all configured IQN pools.

Command Modes Organization (/org)

Command History Release Modification


2.0(2) This command was introduced.

Usage Guidelines IQN pools must be configured before you use this command.

Examples This example shows how to view expanded information for a configured IQN pool.
UCS-A # scope org
UCS-A /org # show iqn-pool Sample1 expand

IQN Pool:
Name: Sample1
IQN prefix: example
Size: 3
Assigned: 0

Block of IQN Names:


Suffix From To
------ ---- --
trial 0 2

Pooled:
Name Assigned Assigned To Dn
---- ---------- ---------------

Cisco UCS Manager CLI Command Reference, Release 2.0


1606 OL-25718-02
Commands
show iqn-pool

Test:0 No
Test:1 No
Test:2 No

UCS-A /org #

Related Commands Command Description


create iqn-pool

scope iqn-pool

enter iqn-pool

delete iqn-pool

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1607
Commands
show iscsi-policy

show iscsi-policy
To display information on the iSCSI policy, use the show iscsi-policy command.

show iscsi-policy [ name ] {expand| detail}*

Syntax Description name (Optional) To display information on a specific iSCSI policy.

expand To display expanded information on all available iSCSI policies.

detail To display detailed information on all available iSCSI policies.

Command Default By default, the command lists the iSCSI policies that are available.

Command Modes Organization (/org)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines An iSCSI policy must be configured to use this command.

Examples This example shows how to display detailed information on the iSCSI policy.
UCS-A # scope org
UCS-A /org # show iscsi-policy detail

Iscsi adapter Policy:

Name: sample
Description: sample iscsi adapter policy

UCS-A /org #

Related Commands Command Description


create iscsi-policy

set descr

set iscsi-protocol-item

Cisco UCS Manager CLI Command Reference, Release 2.0


1608 OL-25718-02
Commands
show iscsi-protocol-profile

show iscsi-protocol-profile
To display information on the iSCSI protocol items, use the show iscsi-protocol-profile command.

show iscsi-protocol-profile {expand| detail}*

Syntax Description expand To display expanded information.

detail To display detailed information.

Command Default By default, the command displays detailed information.

Command Modes ISCSI Adapter policy (/org/iscsi-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines The iSCSI protocol items must be defined for an ISCSI adapter policy to use this command.

Examples This example shows how to view expanded information on the iSCSI protocol items.
UCS-A # scope org
UCS-A /org # scope iscsi-policy sample
UCS-A /org/iscsi-policy # show iscsi-protocol-profile expand

Iscsi protocol item:


Connection timeout (secs): 255
Lun Busy Retry Count: 50
TCP Time Stamp: yes
DHCP Timeout: 90

UCS-A /org/iscsi-policy #

Related Commands Command Description


set iscsi-protocol-item connection-timeout

set iscsi-protocol-item dhcp-timeout

set iscsi-protocol-item lun-busy-retry-count

set iscsi-protocol-item tcp-time-stamp

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1609
Commands
show iscsi

show iscsi
To display information on the boot iSCSI, use the show iscsi command.

show iscsi {expand| detail}*

Syntax Description expand To display information on the boot iSCSI.

detail To display detailed information on the boot iSCSI.

Command Default By default, this command displays detailed information.

Command Modes Boot Policy (/org/boot-policy)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines An iSCSI for a boot policy must be created to use this command.

Examples This example shows how to display expanded information on the boot iSCSI.
UCS-A # scope org test
UCS-A /org # scope boot-policy default
UCS-A /org/boot-policy # show iscsi expand

Boot ISCSI:

Order: 4

ISCSI Image Path:


iscsivnicname: sample

UCS-A /org/boot-policy #

Related Commands Command Description


create iscsi

create path

set iscsivnicname

Cisco UCS Manager CLI Command Reference, Release 2.0


1610 OL-25718-02
Commands
show ldap-group

show ldap-group
To display information on LDAP groups, use the show ldap-group command.

show ldap-group [ Group DN ] [detail]

Syntax Description Group DN (Optional) Name of the LDAP group.

detail (Optional) To view detailed information of all the LDAP groups.

Command Default By default, this command will list the LDAP groups on the system.

Command Modes LDAP (/security/ldap)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines An LDAP group must be created to use this command.

Examples This example shows how to display information on all LDAP groups on the system:
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # show ldap-group detail

LDAP group Default


Roles:
Name: server-profile
Name: server-security
Name: storage
Locales:
Name: Sample

LDAP group Example


Roles:
Name: sample

Locales:
Name: Sample

Related Commands Command Description


scope ldap-group

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1611
Commands
show ldap-group

Command Description
create ldap-group
enter ldap-group
delete ldap-group

Cisco UCS Manager CLI Command Reference, Release 2.0


1612 OL-25718-02
Commands
show ldap-group-rule

show ldap-group-rule
To display information on the LDAP group rules, use the show ldap-group-rule command.

show ldap-group-rule [detail]

Syntax Description detail (Optional) Displays additional information on the LDAP group rules.

Command Default By default, this command lists the LDAP group rule that is enabled.

Command Modes LDAP (/security/ldap)


Server (/security/ldap/server)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines To use this command in the LDAP server mode, an LDAP server must be created.

Examples This example shows how to view the LDAP group rules information for an LDAP server.
Switch-A # scope security
Switch-A /security # scope ldap
Switch-A /security/ldap # scope server Default
Switch-A /security/ldap/server # show ldap-group-rule detail

Ldap group rules:

Group traversal: Non Recursive


Check user's ldap group: Enable
attribute holding parent DNS: up

Switch-A /security/ldap/server #

Related Commands Command Description


create ldap-group-rule
scope ldap-group-rule
enter ldap-group-rule
delete ldap-group-rule

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1613
Commands
show local-disk-config-policy

show local-disk-config-policy
To display local disk configuration policy information, use the show local-disk-config-policy command.

show local-disk-config-policy [name | detail | expand]*

Syntax Description name (Optional) Displays information about a specific local disk configuration policy.

detail (Optional) Displays details about boot policies.

expand (Optional) Displays limited details about boot policies.

Command Default Displays local disk configuration policy information.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show local-disk-config-policy command without any arguments or keywords to display
a list of boot policies.

Examples This example shows how to display a list of boot policies:

switch-A# scope org org10

switch-A /org # show local-disk-config-policy

Local Disk Config Policy:


Name Mode Protect Configuration
-------------------- ------------------- ----------------
org10/bp10 Any Configuration No
org10/bp11 Any Configuration Yes
switch-A /org #

Related Commands Command Description


show org

Cisco UCS Manager CLI Command Reference, Release 2.0


1614 OL-25718-02
Commands
show maint-policy

show maint-policy
To display information on the maintenance policies, use the show maint-policy command.

show maint-policy [ name ] [detail]

Syntax Description name (Optional) Name of the maintenance policy. This option will display information
only on the specified policy.

detail (Optional) This option displays information on all the maintenance policies that are
created.

Command Default By default, this command will list the maintenance policies that are created, and the respective scheduler
information.

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view detailed information on the maintenance policies.
Switch-A # scope org
Switch-A /org # show maint-policy detail

Maintenance Policy:
Name: Default
Scheduler: Timed
Uptime Disruptions: Immediate

Name: Sample
Scheduler: Test
Uptime Disruptions: Immediate

Related Commands Command Description


scope maint-policy
enter maint-policy
create maint-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1615
Commands
show maint-policy

Command Description
delete maint-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1616 OL-25718-02
Commands
show member-port-channel

show member-port-channel
To display information on configure member port channels, use the show member-port-channelcommand.

show member-port-channel [{a| b} port channel id] {expand| detail}*

Syntax Description a Specifies fabric A.

b Specifies fabric B.

port channel id ID of the port channel.

expand Displays expanded information.

detail Displays detailed information.

Command Default By default, the command displays information on all configured member port channels.

Command Modes VSAN (/fc-uplink/vsan)


VSAN within fabric (/fc-uplink/fabric/vsan)
VLAN within Ethernet storage (/eth-storage/vlan)
VLAN within a fabric in the Ethernet storage (/eth-storage/fabric/vlan)
VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within a fabric in Ethernet uplink (/eth-uplink/fabric/vlan)

Command History Release Modification


1.4(1) This command was introduced.

2.0(1) This command was introduced in the Ethernet uplink mode.

Usage Guidelines You must create a VSAN or a VLAN and member port channels before you use this command.

Examples This example shows how to display information on the member port channels:
UCS-A # scope fc-uplink
UCS-A /fc-uplink # scope fabric a
UCS-A /fc-uplink/fabric # scope vsan sample
UCS-A /fc-uplink/fabric/vsan # show member-port-channel

Member Port Channel:

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1617
Commands
show member-port-channel

Fabric ID Port Channel ID Oper State State reason


--------- --------------- ---------- ------------
A 2 Indeterminate Unknown
B 3 Indeterminate Unknown

UCS-A /fc-uplink/fabric/vsan #

Related Commands Command Description


create member-port-channel

enter member-port-channel

scope member-port-channel

delete member-port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


1618 OL-25718-02
Commands
show member-port

show member-port
To display information on configured member ports, use the show member-port command.

show member-port [{a| b} slot-id port-id]{expand| detail}*

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot id Slot identification number.

port id Port identification number.

expand Displays expanded information.

detail Displays detailed information.

Command Default By default, this command displays information on all configured member ports.

Command Modes VLAN within Ethernet storage (/eth-storage/vlan)


VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within a fabric in the Ethernet uplink mode (/eth-uplink/fabric/vlan)
VSAN within the Fibre Channel uplink mode (/fc-uplink/vsan)
VSAN within the fabric interconnect mode (/fc-uplink/fabric/vsan)

Command History Release Modification


1.0(1) This command was introduced.

1.4(1) This command is not available in the Port Channel mode within /eth-uplink/switch
mode.
This command can be used in the VLAN mode within Ethernet Storage.
(/eth-storage/vlan).

2.0(1) This command was introduced in the following command modes:


• VLAN within Ethernet uplink (/eth-uplink/vlan)
• VLAN within a fabric in the Ethernet uplink mode (/eth-uplink/fabric/vlan)

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1619
Commands
show member-port

Usage Guidelines You must configure member ports before you use this command.

Examples This example shows how to display information on member ports:


UCS-A # scope fc-uplink
UCS-A /fc-uplink # scope vsan sample
UCS-A /fc-uplink/vsan # show member-port b 2 16

Member Port:

Fabric ID Slot ID Port ID Oper State State Reason Oper Speed


--------- ------- ------- ---------- ------------ ----------
B 2 16 SFP not present SFP not present Indeterminate

UCS-A /fc-uplink/vsan #

Related Commands Command Description


create member-port

enter member-port

scope member-port

delete member-port

Cisco UCS Manager CLI Command Reference, Release 2.0


1620 OL-25718-02
Commands
show member-port fc

show member-port fc
To display information on the Fibre Channel member ports, use the show member-port fc command.

show member-port fc [{a| b} slot-id port-id] {expand| detail}*

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number.

port-id Port identification number.

expand Displays expanded information.

detail Displays detailed information.

Command Default By default, this command displays all the Fibre Channel member ports that have been configured.

Command Modes VSAN within a fabric in the Fibre Channel storage mode (/fc-storage/fabric/vsan)
VSAN within the Fibre Channel storage mode (/fc-storage/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must configure Fibre Channel member ports before you use this command.

Examples This example shows how to display information on the Fibre Channel member ports:
UCS-A # scope fc-storage
UCS-A /fc-storage # scope vsan sample
UCS-A /fc-storage/vsan # show member-port fc a 1 22

FC Member Port:

Fabric ID Slot ID Port ID Oper State State Reason Oper Speed


--------- ------- ------- ---------- ------------ ----------
A 1 22 Admin Down Administratively Down Indeterminate

UCS-A /fc-storage/vsan #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1621
Commands
show member-port fc

Related Commands Command Description


create member-port fc

enter member-port fc

scope member-port fc

delete member-port fc

Cisco UCS Manager CLI Command Reference, Release 2.0


1622 OL-25718-02
Commands
show member-port fcoe

show member-port fcoe


To display information on the Fibre Channel over Ethernet member ports, use the show member-port fcoe
command.

show member-port fcoe [{a| b} slot-id port-id] {expand| detail}*

Syntax Description a Specifies fabric A.

b Specifies fabric B.

slot-id Slot identification number.

port-id Port identification number.

expand Displays expanded information.

detail Displays detailed information.

Command Default By default, this command displays information on all the Fibre channel over Ethernet member ports.

Command Modes VSAN within the Fibre Channel storage command mode (/fc-storage/vsan)
VSAN within a fabric (/fc-storage/fabric/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines You must create Fibre Channel over Ethernet member ports before you use this command.

Examples This example shows how to display information on Fibre channel over Ethernet member ports:
UCS-A # scope fc-storage
UCS-A /fc-storage # scope vsan sample
UCS-A /fc-storage/vsan # show member-port fcoe a 1 223

FCOE Member Port:

Fabric ID Slot ID Port ID Oper State State Reason Oper Speed


--------- ------- ------- ---------- ------------ ----------
A 1 223 Admin Down Administratively Down Indeterminate

UCS-A /fc-storage/vsan #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1623
Commands
show member-port fcoe

Related Commands Command Description


create member-port fcoe

enter member-port fcoe

scope member-port fcoe

delete member-port fcoe

Cisco UCS Manager CLI Command Reference, Release 2.0


1624 OL-25718-02
Commands
show mgmt-if-mon-policy

show mgmt-if-mon-policy
To display information on the management interface monitor settings, use the show mgmt-if-mon-policy
command.

show mgmt-if-mon-policy

This command has no arguments or keywords

Command Default None

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to display information on the management interface monitor settings.
Switch-A # scope monitoring
Switch-A /monitoring # show mgmt-if-mon-policy

Admin status: Disabled


Polling interval: 90
Max Failure Reports: 3
Monitoring mechanism: Mii Status

MII Status Settings:


--------------------
Mii Status Retry Interval: 5
Mii Status Retry Count: 3

Ping Gateway Settings:


----------------------
Number of ping requests: 3
Deadline time to wait for ping responses: 15

Arp Target Settings:


-------------------
Number of arp requests: 3
Deadline time to wait for arp responses: 10
Arp IP Target1: 0.0.0.0
Arp IP Target2: 0.0.0.0
Arp IP Target3: 0.0.0.0

Switch-A /monitoring #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1625
Commands
show mgmt-if-mon-policy

Related Commands Command Description


set mgmt-if-mon-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1626 OL-25718-02
Commands
show mon-src

show mon-src
To display information on a monitor source session, use the show mon-src command.

show mon-src [ name ] {expand| detail}*

Syntax Description name (Optional) Use this option to view information on a specific monitor source
session.

expand Use this option to view detailed information on all monitor source sessions.

detail Use this option to view information on the monitor source sessions

Command Default By default, this command lists the monitor source session, and the direction of the session in a tabular format.

Command Modes External Ethernet Interface (/chassis/server/adapter/ext-eth-if)


Fibre Channel interface within Fibre Channel storage (/fc-storage/fabric/fc)
Fibre Channel over Ethernet interface within fabric (/fc-storage/fabric/fcoe)
Interface within Ethernet uplink (/eth-uplink/fabric/interface)
Interface within Fibre Channel uplink (/fc-uplink/fabric/interface)
Port channel within Ethernet uplink (/eth-uplink/fabric/port-channel)
Port channel within Fibre Channel uplink (/fc-uplink/fabric/port-channel)
VHBA within service profile (/org/service-profile/vhba)
VLAN within Ethernet uplink (/eth-uplink/vlan)
VLAN within Ethernet uplink (/eth-uplink/fabric/vlan)
VNIC within service profile (/org/service-profile/vnic)
VSAN within Fibre Channel Uplink (/fc-uplink/fabric/vsan)
VSAN within Fibre Channel uplink (/fc-uplink/vsan)
VSAN within Fibre Channel Storage (/fc-storage/fabric/vsan)
VSAN within Fibre Channel storage (/fc-storage/vsan)

Command History Release Modification


1.4(1) This command was introduced.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1627
Commands
show mon-src

Usage Guidelines A monitor source session must be created to use this command.

Examples This example shows how to display the monitor source session information for a VNIC in a service profile.
Switch-A # scope org
Switch-A /org # scope service-profile sample
Switch-A /org/service-profile # scope vnic example
Switch-A /org/service-profile/vnic # show mon-src Testing

Monitor Source:
Name Direction
----- ----------
Testing Both

Related Commands Command Description


set direction
create mon-src
enter mon-src
scope mon-src
delete mon-src

Cisco UCS Manager CLI Command Reference, Release 2.0


1628 OL-25718-02
Commands
show nw-ctrl-policy

show nw-ctrl-policy
To display network control policy information, use the show nw-ctrl-policy command.

show nw-ctrl-policy [ name ] {expand| detail}*

Syntax Description name (Optional) The name of the network control policy. This option displays information
on the specified network control policy.

expand (Optional) Lists all the network control policies that are configured, along with
additional information.

detail (Optional) Lists all the network control policies along with information on CPD and
the uplink fail action.

Command Default By default, this command displays all the configured network control policies along with CDP and uplink
fail action specifications.

Command Modes Organization (/org)


Ethernet storage (/eth-storage)

Command History Release Modification


1.0(2) This command was introduced.

1.4(1) This command was introduced in the Ethernet storage command mode.

Usage Guidelines A network control policy must be configured to use this command.
To use the detail or expand option, the uplink fail action must be configured to use this command.

Examples This example shows how to display network control policy information:
UCS-A # scope org org10
UCS-A /org # show nw-ctrl-policy nCP100

Network Control Policy:


Name CDP Uplink fail action
---- ----- -------------------
nCP100 Enabled Warning

UCS-A /org #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1629
Commands
show nw-ctrl-policy

Related Commands Command Description


create nw-ctrl-policy

scope nw-ctrl-policy

enter nw-ctrl-policy

delete nw-ctrl-policy

set uplink-fail-action

Cisco UCS Manager CLI Command Reference, Release 2.0


1630 OL-25718-02
Commands
show occurrence one-time

show occurrence one-time


To display information on the one-time occurrence schedules that are configured, use the show occurrence
one-time command.

show occurrence one-time [ name ] [detail]

Syntax Description name (Optional) The name of the one time schedule occurrence. This option will display
information on the specified one-time schedule.

detail (Optional) This option displays information on all one time occurrence schedules that
have been configured. It also displays additional information on each schedule.

Command Default By default, this command displays the name, the start date, and the executed tasks of the schedule.

Command Modes Schedule (/system/schedule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A schedule and one-time occurrence schedule must be created prior to using this command.

Examples This example shows how to view detailed information on the one-time occurrence schedule.
Switch-A # scope system
Switch-A /system # scope schedule Default
Switch-A /system/schedule # show occurrence one-time detail

One-Time Occurrence:
Name: Sample
Start Date: 2010-11-02 T12:23:00:00
Max Duration (dd:hh:mm:ss):None
Max Concur Tasks: Unlimited
Max Tasks: Unlimited
Min Interval (dd:hh:mm:ss): None
Executed Jobs: 0

Switch-A /system/schedule #

Related Commands Command Description


create occurrence one-time
scope occurrence one-time

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1631
Commands
show occurrence one-time

Command Description
enter occurrence one-time
delete occurrence one-time

Cisco UCS Manager CLI Command Reference, Release 2.0


1632 OL-25718-02
Commands
show occurrence recurring

show occurrence recurring


To display information on the recurring occurrence of a schedule, use the show occurrence recurring
command.

show occurrence recurring [ name ] [detail]

Syntax Description name (Optional) The name of the recurring occurrence of a schedule. This option displays
information on the specified recurring occurrence of the schedule.

detail (Optional) This option displays information on all recurring occurrences that have
been created.

Command Default By default, this command displays information on all recurring occurrences of the schedule in a tabular format.

Command Modes Schedule (/system/schedule)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A schedule policy and a recurring occurrence for the schedule must be created to use this command.

Examples This example shows how to view information on the recurring occurrence of a schedule.
Switch-A # scope system
Switch-A /system # scope schedule Default
Switch-A /system/schedule # show occurrence recurring detail

Recurring Occurrence:

Name: Trial
Day: Every day
Hour: Every hour
Minute: Every Minute
Max Duration (dd:hh:mm:ss): None
Max Concur Tasks: 0
Max Tasks: 4
Min Interval (dd:hh:mm:ss): None
Executed Tasks: 0

Name: Sample
Day: Monday
Hour: Every hour
Minute: Every Minute
Max Duration (dd:hh:mm:ss): None
Max Concur Tasks: 2
Max Tasks: 4

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1633
Commands
show occurrence recurring

Min Interval (dd:hh:mm:ss): None


Executed Tasks: 1

Related Commands Command Description


create occurrence recurring
scope occurrence recurring
enter occurrence recurring
delete occurrence recurring

Cisco UCS Manager CLI Command Reference, Release 2.0


1634 OL-25718-02
Commands
show password-profile

show password-profile
To display information on the password profile, use the show password-profile command.

show password-profile [detail]

Syntax Description detail (Optional) Displays detailed information on the password profile.

Command Default By default, this command displays if changing passwords during an interval is enabled or not.

Command Modes Security (/security)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines You must be an administrator user or have aaa privileges to use this command.

Examples This example shows how to display detailed information on the password profile:
UCS-A # scope security
UCS-A /security # show password-profile detail

Password Profile:

Password history count: 0


No password changes allowed: 24
Password change during interval: Enable
Password change interval (in Hours) : 48
Password change count: 2

UCS-A /security #

Related Commands Command Description


scope password-profile

set clear password-history

set change-count

set change-interval

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1635
Commands
show password-profile

Command Description
set no-change-interval

set change-during-interval

set history-count

Cisco UCS Manager CLI Command Reference, Release 2.0


1636 OL-25718-02
Commands
show pending-changes

show pending-changes
To view the changes that are pending for a service profile, use the show pending-changes command.

show pending-changes {expand| detail}*

Syntax Description expand (Optional) To view expanded information on the changes that are pending.

detail (Optional) To view detailed information on the changes that are pending.

Command Default By default, the command displays expanded information on a service profile.

Command Modes Service Profile (/org/service-profile)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A service profile must be created to use this command.

Examples This example shows how to view detailed information on a service profile.
Switch-A # scope org Test
Switch-A /org # scope service-profile sample
Switch-A /org/service-profile # show pending-changes detail

Pending Changes:
----------------
Scheduler: Test
Changed by: admin
Acked by: user
Modified date: 2011-10-03 T09:47:32.618
State: Untriggered
Admin State: Untriggered
Pending Changes: 1
Pending Disruptions: 0

Switch-A /org/service-profile #

Related Commands Command Description


create service-profile

show service-profile

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1637
Commands
show pooled

show pooled
To display information on the pools, use the show pooled command.

IP pool configuration
show pooled a.b.c.d detail expand

UUID Suffix pool, and MAC pool configuration


show pooled ID detail expand

IQN pool configuration


show pooled suffix detail expand

Syntax Description a.b.c.d The IPv4 address of the IP pool.

ID The name of the UUID suffix pool. You should have configured this name to use
this option.

Suffix To display information on a specific IQN pool. You should have configured a
suffix for an IQN pool to use this option.

detail To display detailed information on the configured pools.

expand To display expanded information on the configured pools.

Command Default By default, this command lists all the pools that are available.

Command Modes IP pool (/org/ip-pool)


IQN pool (/org/iqn-pool)
UUID suffix pool (/org/uuid-suffix-pool)
MAC pool (/org/mac-pool)

Command History Release Modification


1.0(1) This command was introduced.

2.0(2) This command was introduced in the IQN pool command mode.

Cisco UCS Manager CLI Command Reference, Release 2.0


1638 OL-25718-02
Commands
show pooled

Usage Guidelines Pools must be configured before you use this command.

Examples This example shows how to display pools configured for an UUID suffix pool.
UCS-A # scope org
UCS-A /org # scope uuid-suffix-pool Sample1
UCS-A /org/uuid-suffix-pool # show pooled expand

Pooled:
ID Assigned Assigned to dn
-- -------- --------------
0000-000000000001 No
0000-000000000002 No
0000-000000000003 No

UCS-A /org/uuid-suffix-pool #

Related Commands Command Description


create block

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1639
Commands
show port-channel

show port-channel
To view information on a port channel, use the show port-channel command.

show port-channel [ port-channel-id ] {expand| detail}*

Syntax Description port-channel-id (Optional) Specify a port channel ID to view information on a specific port
channel.

detail (Optional) Use this option to view information on all port channels that are
created.

expand (Optional) Use this option to view detailed information on all port channels that
are created and the associated member port channels.

Command Default By default, the command displays information on all configured port channels in a tabular format.

Command Modes Fabric interconnect within the Ethernet Uplink mode (/eth-uplink/fabric)
Fabric interconnect within the Ethernet storage mode (/eth-storage/fabric)
Fabric interconnect within the Fibre Channel Uplink mode (/fc-uplink/fabric)

Command History Release Modification


1.0(1) This command was introduced in the Fabric Interconnect mode within the Ethernet
uplink mode (/eth-uplink/fabric).

1.4(1) This command was introduced in the Fabric Interconnect mode within the Fibre
Channel uplink mode (/fc-uplink/fabric) and Ethernet storage mode
(/eth-storage/fabric).

Usage Guidelines You must create port channels before you use this command.

Examples This example shows how to view detailed information on all port channels:
UCS-A # scope eth-uplink
UCS-A /eth-uplink # scope fabric a
UCS-A /eth-uplink/fabric # show port-channel detail

Port Channel:
Channel ID: 1
Name: Sample
Admin State: Enabled
Oper State: Up

Cisco UCS Manager CLI Command Reference, Release 2.0


1640 OL-25718-02
Commands
show port-channel

Admin Speed: Auto


Oper Speed (Gbps): 8

Switch-A /eth-uplink/fabric #

Related Commands Command Description


create port-channel

scope port-channel

enter port-channel

delete port-channel

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1641
Commands
show power-budget

show power-budget
To display the committed power usage level of a server, use the show power-budget command.

show power-budget [detail| expand]

Syntax Description detail (Optional) Displays detailed information in list form.

expand (Optional) Displays expanded information.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to display the committed power usage level of a server.

Examples The following example displays the power usage level setting for server 4 in chassis 2:
UCS-A# scope server 2/4
UCS-A /chassis/server # show power-budget

Power Budget:
Committed (W): 1000
Oper Committed (W): Disabled

UCS-A /chassis/server #

Related Commands Command Description


set power-budget committed

Cisco UCS Manager CLI Command Reference, Release 2.0


1642 OL-25718-02
Commands
show power-control-policy

show power-control-policy
To display information on the configured power policies, use the show power-control-policy command.

show power-control-policy [ name ] {expand| detail}*

Syntax Description name (Optional) The name of the power control policy. This option displays information
on the specified power control policy.

expand This option lists all the power control policies and the organization for which they
have been created.

detail This option lists all the power control policies and lists additional information on the
priorities configured for each power control policy.

Command Default By default, this command lists all the power control policies that have been configured.

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view information on the power control policies.
Switch-A # scope org
Switch-A /org # show power-control-policy detail

Power Policy:
Name: Sample
Admin Priority: 5
Oper Priority: 5

Name: Test
Admin Priority: 2
Oper Priority: 2

Switch-A /org #

Related Commands Command Description


create power-control-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1643
Commands
show power-control-policy

Command Description
scope power-control-policy
enter power-control-policy
set power-control-policy
delete power-control-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


1644 OL-25718-02
Commands
show power-group

show power-group
To view information on power groups, use the show power-group command.

show power-group [ name ] {expand| detail}*

Syntax Description name (Optional) The name of the power group. This option displays information on the
specified power group.

expand This option lists all the power groups that are configured along with additional
information such as configured chassis.

detail This option lists all the configured power groups and provides detailed information
on each power group.

Command Default By default, this command lists the configured power groups in a tabular format.

Command Modes Power Capping Management (/power-cap-mgmt)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines Power groups must be created and a chassis must be associated with each power group to view complete
information on the power groups.

Examples This example shows how to view detailed information of the power groups.
Switch-A # scope power-cap-mgmt
Switch-A /power-cap-mgmt # show power-group expand

Group:
Name: Default
Peak (W): Unbound
Operstate: Cap ok

Chassis:
ID Status
-- ------
1 Cap OK

Name: Sample
Peak (W): Unbound
Operstate: Cap ok

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1645
Commands
show power-group

Chassis:
ID Status
-- ------
1 Cap OK

Switch-A /power-cap-mgmt #

Related Commands Command Description


create power-group
scope power-group
enter power-group
delete power-group

Cisco UCS Manager CLI Command Reference, Release 2.0


1646 OL-25718-02
Commands
show pre-login-banner

show pre-login-banner
To view the pre-login banner message of the switch, use the show pre-login-banner command.

show pre-login-banner [detail]

Syntax Description detail To view detailed display of the pre-login banner.

Command Default None

Command Modes Banner (/security/banner)

Command History Release Modification


2.0 This command was introduced.

Usage Guidelines A pre-login banner message must be set to use this command.

Examples This example shows how to view the pre-login banner message.
UCS-A # scope security
UCS-A /security # scope banner
UCS-A /security/banner # show pre-login-banner

Pre login banner:


Message:
--------
Cisco UCS 6100 Series Fabric Interconnect

Related Commands Command Description


set message

clear message

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1647
Commands
show psu-policy

show psu-policy
To display PSU policy information, use the show psu-policy command in org mode.

show psu-policy [detail]

Syntax Description detail Displays the full policy, in list format.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to display the full policy:


switch-A # scope org org100
switch-A /org # show psu-policy psup100

PSU Policy:
Redundancy: n-plus-1
Description: psup100

switch-A /org #

Related Commands Command Description


set redundancy
show psu

Cisco UCS Manager CLI Command Reference, Release 2.0


1648 OL-25718-02
Commands
show rackserver-disc-policy

show rackserver-disc-policy
To display information on the rack server discovery policy, use the show rackserver-disc-policy command.

show rackserver-disc-policy [detail]

Syntax Description detail (Optional) To view detailed information on a rack server discovery policy.

Command Default Displays information on the rackserver disc policy in a tabular format.

Command Modes Organization (/org)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view detailed information on the rack server disc policy.
Switch-A # scope org Sample
Switch-A /org # show rackserver-disc-policy detail

Rack Server Discovery Policy:


Action: Immediate
Scrub Policy: Default
Description: Sample policy

Switch-A /org #

Related Commands Command Description


scope rackserver-disc-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1649
Commands
show raid-battery

show raid-battery
To display information on the battery backup unit (BBU), use the show raid-battery command.

show raid-battery detail

Syntax Description detail Displays detailed information on the RAID battery.

Command Default None

Command Modes RAID controller (/chassis/server/raid-controller)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view information on the batter backup unit of a server:
UCS-A # scope chassis 1
UCS-A /chassis # scope server 3
UCS-A /chassis/server # scope raid-controller 1 sas
UCS-A /chassis/server/raid-controller # show raid-battery detail
UCS-A /chassis/server/raid-controller #

Related Commands Command Description

Cisco UCS Manager CLI Command Reference, Release 2.0


1650 OL-25718-02
Commands
show scheduler

show scheduler
To display information on a scheduler policy, use the show scheduler command.

show scheduler [ name ] {expand| detail}*

Syntax Description name (Optional) The name of the scheduler. This option displays information on the
specified scheduler.

expand (Optional) Lists all the schedulers and the maintenance policies that have been
configured for each policy.

detail (Optional) Lists all the schedulers that have been configured.

Command Default By default, this command only lists the schedulers that have been configured.

Command Modes System (/system)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines A scheduler policy must be created to use this command.


The one-time and periodic maintenance window policies must be configured to use the expand option with
this command.

Examples This example shows how to view information of a scheduler.


Switch-A # scope system
Switch-A /system # show scheduler expand

Name: Default

One-time Maintenance Window:

Name Start Date Executed Jobs


---- ----------- --------------
Test 2010-09-04 T03:00:00:000 2

Periodic Maintenance Window:

Name Day Hour Minute Executed Jobs


----- --- ---- ------- -------------
Trial Monday 2 30 3

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1651
Commands
show scheduler

Related Commands Command Description


create scheduler
scope scheduler
enter scheduler
set scheduler
delete scheduler

Cisco UCS Manager CLI Command Reference, Release 2.0


1652 OL-25718-02
Commands
show security fsm status

show security fsm status


To display security-related finite state machine information, use the show security fsm status command.

show security fsm status

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display security-related finite state machine information:
switch-A# show security fsm status

FSM 1:
Remote Result: Not Applicable
Remote Error Code: None
Remote Error Description:
Status: Nop
Previous Status: Update User Ep Success
Timestamp: 2010-02-18T05:19:05.705
Try: 0
Progress (%): 100
Current Task:

switch-A#

Related Commands Command Description

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1653
Commands
show sel

show sel
To display the contents of the system event log (SEL) of a server, use the show sel command.

show sel server-id

Syntax Description server-id The server identifier, expressed as chassis-number/server-number.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the contents of the SEL for server 1 in chassis 1:
switch-A# show sel 1/1
1 | 02/15/2010 17:23:27 | BIOS | System Event #0x83 | Timestamp clock synch | SEL
timestamp clock updated, event is first of pair | Asserted
2 | 02/15/2010 17:23:28 | BMC | Drive slot(Bay) SAS0_LINK_STATUS #0x21 | Transition
to Degraded | Asserted
3 | 02/15/2010 17:23:28 | BMC | Drive slot(Bay) SAS0_LINK_STATUS #0x21 | Transition
to On Line | Deasserted
4 | 02/15/2010 17:23:28 | BMC | Platform alert LED_SAS0_FAULT #0x59 | LED is blinking
fast | Asserted
5 | 02/15/2010 17:23:28 | BMC | Platform alert LED_SAS0_FAULT #0x59 | LED is on |
Deasserted
6 | 02/15/2010 17:23:28 | BMC | Platform alert LED_FPID #0x5b | LED is on | Asserted
7 | 02/15/2010 17:23:28 | BMC | Platform alert LED_FPID #0x5b | LED is off | Deasserted

8 | 02/15/2010 17:23:29 | BMC | Entity presence MAIN_POWER #0x52 | Device Absent |


Asserted
9 | 02/15/2010 17:23:29 | BMC | Entity presence MAIN_POWER #0x52 | Device Present |
Deasserted
a | 02/15/2010 17:23:29 | BMC | Platform alert LED_SAS0_FAULT #0x59 | LED is on |
Asserted
b | 02/15/2010 17:23:29 | BMC | Platform alert LED_SAS0_FAULT #0x59 | LED color is
green | Asserted
--More--

switch-A#

Cisco UCS Manager CLI Command Reference, Release 2.0


1654 OL-25718-02
Commands
show sel

Related Commands Command Description

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1655
Commands
show server actual-boot-order

show server actual-boot-order


To display the actual boot order of a server, use the show server actual-boot-order command.

show server actual-boot-order[uuid dynamic-uuid| server-id]

Syntax Description uuid dynamic-uuid (Optional) Displays the actual boot


order for a server with a dynamic
universally unique identifier
(UUID). Specify a dynamic UUID
in the form
NNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN.

server-id (Optional) Displays the actual boot


order for a specific server,
expressed as
chassis-number/server-number.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the actual boot order of server 3 in chassis 1:
switch-A# show server actual-boot-order 1/3

Server 1/3:
Last Update: 2010-02-18T05:20:33.603
Network Device
(1) Cisco NIC 11:0.0
(2) Cisco NIC 12:0.0
CD/DVD
(1) Cisco Virtual CD/DVD 1.19
HDD
(1) #0100 ID00 LUN0 FUJITSU MBC207
FDD
(1) Cisco Virtual HDD 1.19
(2) Cisco Virtual Floppy 1.19
Internal EFI Shell

Cisco UCS Manager CLI Command Reference, Release 2.0


1656 OL-25718-02
Commands
show server actual-boot-order

switch-A#

Related Commands Command Description


show server boot-order

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1657
Commands
show server adapter

show server adapter


To display information about network adapters in a server, use the show server adapter command.

show server adapter [uuid dynamic-uuid| server-id] [detail]

Syntax Description uuid dynamic-uuid (Optional) Displays information about network adapters in a server with a dynamic
universally unique identifier (UUID). Specify a dynamic UUID in the form
NNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN.

server-id (Optional) Displays information about network adapters in a specific server,


expressed as chassis-number/server-number.

detail (Optional) Displays detailed information in list form.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display information about network adapters in server 3 in chassis 1:
switch-A# show server adapter 1/3

Server 1/3:
Adapter PID Vendor Serial Overall Status
------- ---------- ----------------- ------------ --------------
1 N20-AC0002 Cisco Systems Inc QCI13110017 Operable

switch-A#

Related Commands Command Description


show server adapter identity
show server adapter inventory
show server adapter layer2

Cisco UCS Manager CLI Command Reference, Release 2.0


1658 OL-25718-02
Commands
show server adapter

Command Description
show server adapter status

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1659
Commands
show server adapter identity

show server adapter identity


To display identity information about network adapters in a server, use the show server adapter identity
command.

show server adapter identity [uuid dynamic-uuid| server-id]

Syntax Description uuid dynamic-uuid (Optional) Displays identity information about network adapters in a server with
a dynamic universally unique identifier (UUID). Specify a dynamic UUID in the
form NNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN.

server-id (Optional) Displays identity information about network adapters in a specific server,
expressed as chassis-number/server-number.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display identity information about network adapters in server 3 in chassis 1:
switch-A# show server adapter identity 1/3

Server 1/3:
Burned-In UUID: 12345678-abcd-ef12-3456-0123456789ab
Dynamic UUID: 12345678-abcd-ef12-abcd-0000000015d9
Adapter 1:
Product Name: Cisco UCS VIC M81KR Virtual Interface Card
PID: N20-AC0002
VID: V01
Vendor: Cisco Systems Inc
Serial: QCI13110017
Revision: 0

Ext Interface:

Adapter Interface Mac


------- --------- ---
1 1 00:24:97:1F:5C:34
1 2 00:24:97:1F:5C:35

switch-A#

Cisco UCS Manager CLI Command Reference, Release 2.0


1660 OL-25718-02
Commands
show server adapter identity

Related Commands Command Description


show server adapter
show server adapter inventory
show server adapter layer2
show server adapter status

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1661
Commands
show server adapter inventory

show server adapter inventory


To display inventory information about network adapters in a server, use the show server adapter inventory
command.

show server adapter inventory [uuid dynamic-uuid| server-id] [detail]

Syntax Description uuid dynamic-uuid (Optional) Displays inventory information about network adapters in a server with
a dynamic universally unique identifier (UUID). Specify a dynamic UUID in the
form NNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN.

server-id (Optional) Displays inventory information about network adapters in a specific


server, expressed as chassis-number/server-number.

detail (Optional) Displays detailed information in list form.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display inventory information about network adapters in server 3 in chassis 1:
switch-A# show server adapter inventory 1/3

Server 1/3:
Adapter PID Vendor Serial Overall Status
------- ---------- ----------------- ------------ --------------
1 N20-AC0002 Cisco Systems Inc QCI13110017 Operable

switch-A#

Related Commands Command Description


show server adapter
show server adapter identity
show server adapter layer2

Cisco UCS Manager CLI Command Reference, Release 2.0


1662 OL-25718-02
Commands
show server adapter inventory

Command Description
show server adapter status

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1663
Commands
show server adapter layer2

show server adapter layer2


To display Layer 2 information about the network adapters, use the show server adapter layer2 command.

show server adapter layer2 [detail]

Syntax Description detail (Optional) Displays detailed information in list form.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display Layer 2 information about the network adapters:
switch-A# scope server 1/5
switch-A /chassis/server # show server adapter layer2

Ext Interface:

Adapter Interface Mac


------- --------- ---
1 1 00:26:51:0A:A3:0C
1 2 00:26:51:0A:A3:0D

switch-A#

Related Commands Command Description


show server adapter
show server adapter identity
show server adapter inventory
show server adapter status

Cisco UCS Manager CLI Command Reference, Release 2.0


1664 OL-25718-02
Commands
show server adapter status

show server adapter status


To display status information about network adapters in a server, use the show server adapter status
command.

show server adapter status [uuid dynamic-uuid| server-id] [detail]

Syntax Description uuid dynamic-uuid (Optional) Displays status information about network adapters in a server with a
dynamic universally unique identifier (UUID). Specify a dynamic UUID in the
form NNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN.

server-id (Optional) Displays status information about network adapters in a specific server,
expressed as chassis-number/server-number.

detail (Optional) Displays detailed information in list form.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display status information about network adapters in server 3 in chassis 1:
switch-A# show server adapter status 1/3

Server 1/3:
Overall Status
--------------
Operable

switch-A#

Related Commands Command Description


show server adapter
show server adapter identity
show server adapter inventory

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1665
Commands
show server adapter status

Command Description
show server adapter layer2

Cisco UCS Manager CLI Command Reference, Release 2.0


1666 OL-25718-02
Commands
show server boot-order

show server boot-order


To display the boot order of a server, use the show server boot-order command.

show server boot-order [uuid dynamic-uuid| server-id]

Syntax Description uuid dynamic-uuid (Optional) Displays the boot order


for a server with a dynamic
universally unique identifier
(UUID). Specify a dynamic UUID
in the form
NNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN.

server-id (Optional) Displays the boot order


for a specific server, expressed as
chassis-number/server-number.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display the boot order of server 5 in chassis 1:
switch-A# show server boot-order 1/5

Boot Definition:
Full Name: sys/chassis-1/blade-5/boot-policy
Reboot on Update: No

Boot LAN:
Order: 1

LAN Image Path:


Type: Primary
VNIC: default

switch-A#

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1667
Commands
show server boot-order

Related Commands Command Description


show server actual-boot-order

Cisco UCS Manager CLI Command Reference, Release 2.0


1668 OL-25718-02
Commands
show server cpu

show server cpu


To display information about the CPUs in a server, use the show server cpu command.

show server cpu [uuid dynamic-uuid| server-id] [detail]

Syntax Description uuid dynamic-uuid (Optional) Displays information about the CPUs in a server with a dynamic
universally unique identifier (UUID). Specify a dynamic UUID in the form
NNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN.

server-id (Optional) Displays information about the CPUs in a specific server, expressed
as chassis-number/server-number.

detail (Optional) Displays detailed information in list form.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display information about the CPUs in server 5 in chassis 1:
switch-A# show server cpu 1/5

Server 1/5:
ID Presence Architecture Socket Cores Speed (GHz)
--- -------------------- ----------------- ------ ----------- -----------
1 Equipped Xeon CPU1 4 2.666000
2 Equipped Xeon CPU2 4 2.666000

switch-A#

Related Commands Command Description


show server actual-boot-order
show adapter
show server boot-order

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1669
Commands
show server cpu

Command Description
show server identity
show server inventory

Cisco UCS Manager CLI Command Reference, Release 2.0


1670 OL-25718-02
Commands
show server identity

show server identity


To display identity information about a server, use the show server identity command.

show server identity [uuid dynamic-uuid| server-id]

Syntax Description uuid dynamic-uuid (Optional) Displays identity information about a server with a dynamic universally
unique identifier (UUID). Specify a dynamic UUID in the form
NNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN.

server-id (Optional) Displays identity information about a specific server, expressed as


chassis-number/server-number.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.1(1) This command was introduced.

Usage Guidelines This command does not require a license.

Examples This example shows how to display identity information about server 5 in chassis 1:
switch-A# show server identity 1/5

Server 1/5:
Burned-In UUID: 0d05e5b2-0707-11df-b252-000bab01c0fb
Dynamic UUID: 0d05e5b2-0707-11df-b252-000bab01c0fb

Ext Interface:

Adapter Interface Mac


------- --------- ---
1 1 00:26:51:0A:A3:0C
1 2 00:26:51:0A:A3:0D

switch-A#

Related Commands Command Description


show server cpu
show server adapter

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1671
Commands
show server-host-id

show server-host-id
To view the host ID of a Fabric Interconnect, use the show server-host-id command.

show server-host-id a b detail

Syntax Description a (Optional). The identifier for server A.

b (Optional). The identifier for server B.

detail This option will display the host ID for all fabric interconnects that are available.

Command Default None

Command Modes License (/license)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view the host ID of all fabric interconnects.
Switch-A # scope license
Switch-A /license # show server-host-id

Server host id:


Scope Host ID
----- ------
A VDH=SSI13420MRJ
B VDH=FLCI2360018

Switch-A /license #

Related Commands Command Description


show file

show usage

Cisco UCS Manager CLI Command Reference, Release 2.0


1672 OL-25718-02
Commands
show server status

show server status


To display information on the status of a server, use the show server status command.

show server status {ID | detail | chassis id /blade id | UUID}

Syntax Description ID The server ID. The value must be a number between 1 and 255.

detail To display detailed status information on the server.

chassis ID / blade ID The chassis and blade ID of the server.

UUID The UUID of the server.

Command Default By default, the command lists status information on all servers.

Command Modes Server (chassis/server)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to display status information for a specific server using the chassis and blade ID.
UCS-A # scope server 1/1
UCS-A /chassis/server # show server status 1/1

Server Slot Status Availability Overall Status Discovery


------ ----------- ------------ -------------- ---------
1/1 Equipped Available Unassociated Complete

UCS-A /chassis/server #

Related Commands Command Description


scope server

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1673
Commands
show service-profile assoc

show service-profile assoc


To display information on the service profile association, use the show service-profile assoc command.

show service-profile assoc {detail | org | server | UUID}

Syntax Description detail To display detailed information on the service profile.

org To display service profile information associated with a


specific organization.

server To display service profile information associated with a


specific server.

uuid To display service profile information associated with a


UUID.

Command Default By default, this command displays information on all service profiles that are created.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Service profiles must be created to use this command.

Examples This example shows how to display service profile associations.


UCS-A # scope org
UCS-A /org # show service-profile assoc

Service Profile Name Association Server Server Pool


-------------------- ----------- ------- -----------
Trial Associated 1/1 default
Sample Associated 2/1 default
Example Associated 2/2 default

UCS-A /org #

Cisco UCS Manager CLI Command Reference, Release 2.0


1674 OL-25718-02
Commands
show service-profile assoc

Related Commands Command Description


show service-profile status
show service-profile circuit
show service-profile connectivity
show service-profile detail
show service-profile expand
show service-profile fsm
show service-profile identity
show service-profile inventory
show service-profile path
show service-profile name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1675
Commands
show service-profile circuit

show service-profile circuit


To display information on the service profile circuit, use the show service-profile circuit command.

show service-profile circuit {detail | name | org | server | UUID}

Syntax Description detail To display detailed information on the service profile.

name To display information on a specific service profile.

org To display service profile information associated with a


specific organization.

server To display service profile information associated with a


specific server.

uuid To display service profile information associated with a


UUID.

Command Default By default, this command displays information on all service profiles that are created.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Service profiles must be created to use this command.

Examples This example shows how to display service profile circuit information
UCS-A # scope org
UCS-A /org # show service-profile circuit

Service Profile: Example


Server: 1/1

Service Profile: Sample


Server: 1/2

Service Profile: Trial


Server: 2/2

UCS-A /org #

Cisco UCS Manager CLI Command Reference, Release 2.0


1676 OL-25718-02
Commands
show service-profile circuit

Related Commands Command Description


show service-profile assoc
show service-profile status
show service-profile connectivity
show service-profile detail
show service-profile expand
show service-profile fsm
show service-profile identity
show service-profile inventory
show service-profile path
show service-profile name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1677
Commands
show service-profile detail

show service-profile detail


To display detailed information on the status of the service profile, use the show service-profile detail
command.

show service-profile detail

This command has no arguments or keywords.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines A service profile must be created to use this command.

Examples This example shows how to display detailed information on all service profiles:
UCS-A # scope org
UCS-A /org # show service-profile detail

Service Profile:
Service Profile Name: Sample
Type: Instance
Server: 1/2
Selected Server: 1
User Label:
Description:
Assignment: Assigned
Association: Associated
Power State: On
Op State: Config Failure
Oper Qualifier:
Conf State: Failed
Config Qual: Insufficient resources, System UUID Assignment
Dynamic UUID: Derived
Server Pool: default
Source Template:
UUID Suffix Pool: Default
Oper UUID Suffix Pool: org-root/uuid-pool-default
Boot Policy:
Oper Boot Policy: org-root/boot-policy-default
BIOS Policy:
Oper BIOS Policy:
Host f/w Policy:
Oper Host f/w Policy:
Dynamic vNIC Connectivity Policy:
Oper Dynamic vNIC Connectivity Policy:
Local Disk Policy: default
Oper Local Disk Policy: org/local-disk-config-default
Maintenance Policy:

Cisco UCS Manager CLI Command Reference, Release 2.0


1678 OL-25718-02
Commands
show service-profile detail

Oper Maintenance Policy: org-root/maint-default


Mgmt f/w Policy:
Oper Mgmt f/w Policy:
IPMI access Policy:
Oper IPMI access Policy:
Power Policy: default
Power Operational Policy: org-root/power-policy-default
SQL Policy:
Oper SQL Policy:
Stats Policy: default
Oper Stats Policy: org-root/thr-policy-default
Scrub Policy:
Oper Scrub Policy: org-root/scrub-default
vNIC/vHBA Placement Policy:
Oper vNIC/vHBA Placement Policy:
External Management IP State: None
Migration Restriction:
Assignment Status:
Assignment Issues:
Current Task 1:
Current Task 2:
Current Task 3: Resolving and applying identifiers
Pending Changes:
Scheduler:
Changed by:
Acked By:
modified date: 1970:01:01T00:00:00
State: untriggered
Admin State: untriggered
Pending changes: 0

UCS-A /org #

Related Commands Command Description


show service-profile assoc

show service-profile circuit

show service-profile connectivity

show service-profile expand

show service-profile fsm

show service-profile identity

show service-profile inventory

show service-profile path

show service-profile status

show service-profile name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1679
Commands
show service-profile expand

show service-profile expand


To display detailed information on the status of the service profile, use the show service-profile expand
command.

show service-profile expand

This command has no arguments or keywords.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines A service profile must be created to use this command.

Examples This example shows how to display expanded information on all service profiles:
UCS-A # scope org
UCS-A /org # show service-profile expand

Service Profile:
Service Profile Name: Sample
Type: Instance
Server: 1/2
Assignment: Assigned
Association: Associated

Pending Changes:
State Pending Changes Pending Disruptions
----- --------------- -------------------
Untriggered 0 0

Boot Definition:
Full name: org-root/ls-test/boot-policy
Reboot on Update: No

vNIC:
Name: test
Fabric ID: A
Dynamic MAC Addr: Derived

Ethernet Interface:
Name: Sample
Dynamic MAC Addr: Derived
Default Network: No
VLAN ID: 1
Operational VLAN: fabric/lan/net-default

UCS-A /org #

Cisco UCS Manager CLI Command Reference, Release 2.0


1680 OL-25718-02
Commands
show service-profile expand

Related Commands Command Description


show service-profile assoc

show service-profile circuit

show service-profile connectivity

show service-profile detail

show service-profile fsm

show service-profile identity

show service-profile inventory

show service-profile path

show service-profile status

show service-profile name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1681
Commands
show service-profile fsm

show service-profile fsm


To display information on the finite state machine (FSM) of a service profile, use the show service-profile
fsm command.

show service-profile fsm {status| name}

Syntax Description fsm status To display information on the FSM status of the service
profile.

name To display information on the FSM status of a specific service


profile.

Command Default By default, this command displays information on all service profiles that are created.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Service profiles must be created to use this command.

Examples This example shows how to display FSM information for a specific service profile.
UCS-A # scope org
UCS-A /org # show service-profile fsm status sample

Service Profile Name: sample

FSM 1:
Remote Result:
Remote Error Code:
Remote Error Description:
Status:
Previous Status:
Timestamp:
Try:
Flags:
Progress (%):
Current Task:

FSM 2:
Status: NoP
Previous Status: NoP
Timestamp: Never
Try: 0
Flags: 0

Cisco UCS Manager CLI Command Reference, Release 2.0


1682 OL-25718-02
Commands
show service-profile fsm

Progress (%): 100


Current Task: Resolving and applying identifiers

UCS-A /org #

Related Commands Command Description


show service-profile assoc
show service-profile status
show service-profile circuit
show service-profile connectivity
show service-profile detail
show service-profile expand
show service-profile identity
show service-profile inventory
show service-profile path
show service-profile name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1683
Commands
show service-profile identity

show service-profile identity


To display the identity information of all service profiles, use the show service-profile identity command.

show service-profile inventory{name | org | server | uuid}

Syntax Description name To display identity information on a specific service


profile.

org To display identity information on service profiles


associated with a specific organization.

server To display identity information of the service profiles


associated with a specific server.

uuid To display UUID identity information on the service


profiles.

Command Default By default, the command displays identity information on all configured service profiles.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines A service profile must be created before you use this command.

Examples This example shows how to display identity information for a specific service profile.
UCS-A # scope org
UCS-A /org # show service-profile identity name sample1

Service Profile Name: sample1


UUID Suffix Pool: default
Dynamic UUID: Derived

vNIC FC Node: 1
WWN Pool: node-default
Dynamic WWNN: Pool Derived

UCS-A /org #

Cisco UCS Manager CLI Command Reference, Release 2.0


1684 OL-25718-02
Commands
show service-profile identity

Related Commands Command Description


show service-profile assoc

show service-profile circuit

show service-profile connectivity

show service-profile detail

show service-profile expand

show service-profile fsm

show service-profile inventory

show service-profile path

show service-profile status

show service-profile name

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1685
Commands
show service-profile inventory

show service-profile inventory


To display the inventory information of all service profiles, use the show service-profile inventory command.

show service-profile inventory{adapter | bios | board | cpu | detail | expand | memory | mgmt | name |
org | server | storage | uuid}

Syntax Description adapter To display information on the adapters associated with


the service profiles.

bios To display information on the BIOS associated with the


service profiles.

board To display information on the boards associated with


the service profiles.

cpu To display information on the CPUs associated with the


service profiles.

detail To display detailed inventory information on the service


profiles.

expand To display expanded information on the service profiles.

memory To display information on the memory usage associated


with the service profiles.

mgmt To display information on the management details


associated with the service profiles

name To display inventory information on a specific service


profile.

org To display inventory information on service profiles


associated with a specific organization.

server To display server inventory information of the service


profiles.

storage To display storage inventory information of the service


profiles.

uuid To display UUID inventory information on the service


profiles.

Cisco UCS Manager CLI Command Reference, Release 2.0


1686 OL-25718-02
Commands
show service-profile inventory

Command Default By default, this command displays all service profiles, along with information on the type of template used,
the server it is associated with, and the association status.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines A service profile must be created before you use this command.

Examples This example shows how to display inventory information of all configured service profile.
UCS-A # scope org
UCS-A /org # show service-profile inventory adapter

Service Profile Name: Sample


Type: Initial Template
Server: 1/1
Description:
Assignment: Assigned
Association: Associated

Service Profile Name: Example


Type: Initial Template
Server:
Description:
Assignment: Unassigned
Association: Unassociated

UCS-A /org #

Related Commands Command Description


show service-profile assoc

show service-profile circuit

show service-profile connectivity

show service-profile detail

show service-profile expand

show service-profile fsm

show service-profile identity

show service-profile path

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1687
Commands
show service-profile inventory

Command Description
show service-profile status

show service-profile name

Cisco UCS Manager CLI Command Reference, Release 2.0


1688 OL-25718-02
Commands
show service-profile status

show service-profile status


To display information on the status of the service profile, use the show service-profile status command.

show service-profile status {detail | expand | name | org | power | server | Thermal | UUID | voltage}

Syntax Description detail To display detailed information.

expand To display expanded information.

name To display information on a


specific service profile.

org To display information on service


profiles associated with a particular
organization.

power To display power status


information.

server To display information on the


servers that the service profile is
associated with.

thermal To display thermal power status


information.

UUID To display UUID information.

voltage To display voltage information.

Command Default By default, this command lists the status of all the service profiles that are configured.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines A service profile must be created to use this command.

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1689
Commands
show service-profile status

Examples This example shows how to display the power status of all service profiles:
UCS-A # scope org
UCS-A /org # show service-profile status

Service Profile Name Server Assignment Association Power State Op State


-------------------- ------ ---------- ----------- ----------- ---------
Trial 1/1 Assigned Associated On OK
Sample 1/2 Assigned Associated On OK
Example 2/1 Assigned Associated On OK

UCS-A /org #

Related Commands Command Description


create service-profile

show service-profile assoc

show service-profile circuit

show service-profile connectivity

show service-profile detail

show service-profile expand

show service-profile fsm

show service-profile identity

show service-profile inventory

show service-profile path

show service-profile name

Cisco UCS Manager CLI Command Reference, Release 2.0


1690 OL-25718-02
Commands
show snmp-user

show snmp-user
To display SNMPv3 user information, use the show snmp-user command.

showsnmp-user [user-name]

Syntax Description user-name User name.

Command Default None

Command Modes Monitoring (/monitoring)

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to display SNMPv3 user information:

switch-A# scope monitoring

switch-A /monitoring # show snmp-user

switch-A /monitoring # SNMPv3 User:


Name Authentication type
------------------------ -------------------
su100 Md5
switch-A /monitoring #

Related Commands Command Description


show snmp
show snmp-trap

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1691
Commands
show sol-policy

show sol-policy
To display SoL policy information, use the show sol-policy command.

show sol-policy [sol-policy-name | detail]

Syntax Description sol-policy-name (Optional) Displays information about a specific SoL policy.

detail (Optional) Displays details about all SoL policies.

Command Default Displays information about SoL policies.

Command Modes Organization (/org)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines This command does not require a license.


You can also use the show sol-policy command without any arguments or keywords to display a list of policies.

Examples This example shows how to display details about all SoL policies:

switch-A# scope org org10

switch-A /org # show sol-policy detail

SOL Policy:
Name: org10/sol-p10
Admin State: Disable
Speed: 9600
Description:

Name: org10/sol-p11
Admin State: Disable
Speed: 9600
Description:
switch-A /org #

Cisco UCS Manager CLI Command Reference, Release 2.0


1692 OL-25718-02
Commands
show sol-policy

Related Commands Command Description


show org
show qos-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1693
Commands
show sshkey

show sshkey
To display the SSH public key of the host, use the show sshkey command in local management mode.

show sshkey

This command has no arguments or keywords.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to display the SSH public key of the host.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.

Examples This example shows how to display the SSH public key of the host:
switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# show sshkey


*******************
SSH RSA Public Key
*******************

ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEAxlYfe7GDtmCdgZ2TfQivPrQmXh6E808oOofhqgMBA72b
ACu/QJxYeR+S7yqfHJYl1P/Uu+XC3GPueAk5sC3aMMbocwYVt58BsmXeeRubaoO51t1GCQjwwEivQRgI
JGK2dyu1ZWzfiGgaYku3gCYqC59PS7F2TYIoJCWnXwIRI58= root@

switch-A(local-mgmt)#

Cisco UCS Manager CLI Command Reference, Release 2.0


1694 OL-25718-02
Commands
show sshkey

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1695
Commands
show static-target-if

show static-target-if
To display information on the static target interface priority, use the show static-target-if command.

show static-target-if [ priority ] {expand| detail}*

Syntax Description priority (Optional) To display information on a specific target interface priority.

expand To display expanded information.

detail To display detailed information.

Command Default By default, the command displays information on the static target interface priority in a tabular format.

Command Modes Ethernet Interface within the iSCSI VLAN (/org/service-profile/vnic-iscsi/eth-if)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines A static target interface priority must be set to use this command.

Examples This example shows how to display detailed information on the static target interface priority.
UCS-A # scope org Test
UCS-A /org # scope service-profile sample
UCS-A /org/service-profile # scope vnic-iscsi trial
UCS-A /org/service-profile/vnic-iscsi # scope eth-if
UCS-A /org/service-profile/vnic-iscsi/eth-if # show static-target-if detail

Static target:
Priority: 1
Name: testing
Port: 3260
IP address: 10.0.0.0
Auth Name: example

UCS-A /org/service-profile/vnic-iscsi/eth-if #

Related Commands Command Description


create static-target-if

Cisco UCS Manager CLI Command Reference, Release 2.0


1696 OL-25718-02
Commands
show stats

show stats
To display the power usage of a server, use the show stats command.

show stats

This command has no arguments or keywords.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to display the power usage of a server.

Examples The following example displays the power usage for server 4 in chassis 2:
UCS-A# scope server 2/4
UCS-A /chassis/server # show stats

Mb Power Stats:
Time Collected: 2010-04-20T08:45:31.209
Monitored Object: sys/chassis-2/blade-4/board
Suspect: No
Consumed Power (W): 116.653679
Input Voltage (V): 12.051000
Input Current (A): 9.680000
Thresholded: Input Voltage Min

Mb Temp Stats:
Time Collected: 2010-04-20T08:45:31.209
Monitored Object: sys/chassis-2/blade-4/board
Suspect: No
Fm Temp Sen Io (C): 19.000000
Fm Temp Sen Rear (C): 18.000000
Fm Temp Sen Rear L (C):: N/A
Fm Temp Sen Rear R (C): N/A
Thresholded: 0

UCS-A /chassis/server #

Related Commands Command Description


set power-budget committed

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1697
Commands
show storage-controller

show storage-controller
To display information on storage controllers, use the show storage-controller command.

show storage-controller [vendor model hw-rev] {expand| detail}*

Syntax Description vendor (Optional) Vendor name of the storage controller.

model Model number of the storage controller. You must specify the model number if
you have specified the vendor name.

hw-rev Hardware revision number of the storage controller. You must specify the hardware
revision number if you have specified the vendor name.

expand (Optional) Displays expanded information on the available storage controllers.

detail (Optional) Displays detailed information on the available storage controllers.

Command Default By default, the command lists all the storage controllers that are configured.

Command Modes Capability (/system/capability)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to display information on all storage controllers:
UCS-A # scope system
UCS-A /system # scope capability
UCS-A /system/capability # show storage-controller expand

Storage Controllers:

Vendor Model HW Revision


------ ----- ------------
Intel Corp. 82801JIR (ICHIOR) SATA RAID Controller 0
LSI Corp. LSI 1064E 0
LSI Corp. LSI SAS30813E-R 0

UCS-A /system/capability #

Cisco UCS Manager CLI Command Reference, Release 2.0


1698 OL-25718-02
Commands
show storage-controller

Related Commands Command Description


scope storage-controller

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1699
Commands
show tech-support

show tech-support
To view technical information on the chassis, fabric extender module (fex), server and the UCS Manager, use
the showtech-support command.

show tech-support chassis fex server ucsm

Syntax Description chassis The ID of the chassis. The ID must be a numeric value between 1 and 255.

fex The ID of the Fabric extender module. The ID must be a numeric value between 1
and 255.

server The rack ID of the server. The value must be a numeric value.

ucsm To view information on the Unified Computing System Manager software.

Command Default None

Command Modes Local Management (/local-mgmt)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines A fabric must be specified to enter the Local Management command mode.
The chassis and Fabric extender module ID must be values between 1 and 255.

Examples This example shows how to view information on the Unified Computing System Manager software on a
switch.
Switch-A # connect local-mgmt a
Switch-A (local-mgmt) # show tech-support ucsm

Brief Technical Support Information for Fabric A


*************************************************
System Version and Platform Information
*************************************************
'show system uptime'
System Start time: Wed Nov 10 23:39:22 2010
System uptime: 84 days, 9 hours, 10 minutes, 7 seconds
Kernel uptime: 84 days, 9 hours, 10 minutes, 7 seconds
Active supervisor uptime: 84 days, 9 hours, 10 minutes, 7 seconds

'show system resources'


Load average: 1 minute:1.49 5 minutes: 0.68 15 minutes: 0.48

Cisco UCS Manager CLI Command Reference, Release 2.0


1700 OL-25718-02
Commands
show tech-support

Processes: 456 total, 3 running


CPU states: 0.0% user, 2.0% kernel, 98.0% idle
Memory usage: 3634760K total, 1971160K used, 1663600K free, OK buffers, 1493404K cache

Switch-A (local-mgmt) #

Related Commands Command Description


show cli

show clock

show cluster

show file

show license

show mgmt-ip-debug

show open-network-ports

show pmon

show processes

show sel

show sshkey

show version

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1701
Commands
show usage

show usage
To view license usage for a fabric interconnect, use the show usage command.

show usage a b detail Feature

Syntax Description a (Optional) Use this option to view the license usage for scope A.

b (Optional) Use this option to view the license usage for scope B.

detail (Optional) Use this option to view the complete details of the license usage for scope
A and B.

Feature (Optional) Use this option to view the license usage based on a feature name.

Command Default By default, the command displays license usage information according to a feature name in a tabular format.

Command Modes License (/license)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to view detailed license usage information for a fabric interconnect:
Switch-A # scope license
Switch-A /license # show usage detail

License instace: ETH_PORT_ACTIVATION_PKG


Scope : A
Default: 8
Total Quant: 8
Used Quant: 5
State: License OK
Peer Status: Matching
Grace Used: 0

License instace: ETH_PORT_ACTIVATION_PKG


Scope : B
Default: 8
Total Quant: 8
Used Quant: 5
State: License OK
Peer Status: Matching
Grace Used: 0

Cisco UCS Manager CLI Command Reference, Release 2.0


1702 OL-25718-02
Commands
show usage

Switch-A /license #

Related Commands Command Description


show file

show server-host-id

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1703
Commands
show vcenter

show vcenter
To display VCenter information, use the show vcenter command in vmware mode.

show vcenter [vcenter-name | detail | fsm status]

Syntax Description vcenter-name The name of the VCenter.

detail Displays all VCenter information, in list format.

fsm status Displays all VCenter finite state machine information, in list format.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to display VCenter information:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # show vcenter vc10

vCenter:
Name: vc10
Description: test
Hostname or IP address:
Certificate:
vCenter Server Version:

switch-A /system/vm-mgmt/vmware #

Related Commands Command Description


show data-center
show folder

Cisco UCS Manager CLI Command Reference, Release 2.0


1704 OL-25718-02
Commands
show vcon

show vcon
To display vCon information, use the show vcon command.

show vcon [1 | 2 | detail | expand]

Syntax Description 1 Displays vCon information for virtual network interface 1.

2 Displays vCon information for virtual network interface 2.

detail Displays all vCons.

expand Displays all vCons.

Command Default None

Command Modes vCon policy (/org/vcon-policy)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to display vCon information:


switch-A # scope org org100
switch-A /org # scope service-profile sp100
switch-A /org/service-profile* # show vcon 1

Virtual Network Interfaces:


Virtual Network Interfaces ID: 1
Selection Preference: All

Pubs-A /org/service-profile* #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1705
Commands
show vcon-policy

show vcon-policy
To display vCon policy information, use the show vcon-policy command.

show vcon-policy [policy-name | detail | expand]

Syntax Description policy-name The name of the policy. Displays the specified vCon policy.

detail Displays the vCon policy that is associated with the service profile that you
entered.

expand Displays all vCon policies.

Command Default None

Command Modes Organization (/org)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to display vCon policy information:


switch-A # scope org org100
switch-A /org # show vcon-policy vcp100

vNIC/vHBA Placement Profile:


Name
----
org100/vcp100

Pubs-A /org #

Related Commands
• create vcon-policy
• scope org

Cisco UCS Manager CLI Command Reference, Release 2.0


1706 OL-25718-02
Commands
show vif-ns

show vif-ns
To display VIF namespace information, use the show vif-ns command.

show vif-ns [detail]

Syntax Description detail (Optional) To view detailed VIF namespace information.

Command Default None

Command Modes Server (/chassis/server)

Command History Release Modification


2.0(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to display VIF namespace information.


UCS-A # scope server 1/1
UCS-A /chassis/server # show vif-ns

Server: 1/1
Adapter: sys/chassis-1/blade-1/adaptor-1/
Fabric ID Side VIF NS Size VIf used Allocation Status
--------- ---- ----------- -------- ------------------
A Left 61 1 Available
B Left 61 1 Available

UCS-A /chassis/server #

Related Commands Command Description


show vif

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1707
Commands
show virtual-machine

show virtual-machine
To display virtual machine information, use the show virtual-machine command in vmware mode.

show virtual-machine [uuid | detail | expand]

Syntax Description uuid The UUID of the virtual machine.

detail Specifies detailed virtual machine information, in list format.

expand Specifies expanded virtual machine information, in table format.

Command Default None

Command Modes VMware (/system/vm-mgmt/vmware)

Command History Release Modification


1.1(1) This command was introduced.

Examples This example shows how to display virtual machine information:


switch-A# scope system
switch-A /system # scope vm-mgmt
switch-A /system/vm-mgmt # scope vmware
switch-A /system/vm-mgmt/vmware # show virtual-machine
switch-A /system/vm-mgmt/vmware #

Related Commands Command Description


show vcenter

Cisco UCS Manager CLI Command Reference, Release 2.0


1708 OL-25718-02
Commands
show vlan-port-count

show vlan-port-count
To view the Virtual LAN port count for a Fabric interconnect module, use the show vlan-port-count command.

show vlan-port-count

Syntax Description
This command has no arguments or keywords.

Command Default Displays the Virtual LAN port count for a Fabric interconnect module.

Command Modes Fabric Interconnect module (/fabric-interconnect)

Command History Release Modification


1.3(1) This command was introduced.

1.4(1) The number of VLAN port instances that you can configure for a fabric is
reduced from 8000 to 6000.

Usage Guidelines You must select a fabric to use this command.


You can configure a maximum of 6000 VLAN port instances for a given fabric-interconnect.

Examples This example shows how to view the Virtual LAN port counts for Fabric A.
Switch-A # scope fabric-interconnect a
Switch-A /fabric-interconnect # show vlan-port-count

VLAN-Port Count:

VLAN-Port Limit Access VLAN-Port Count Border VLAN-Port Count Alloc Status
--------------------------------------------------------------------------
6000 5 10 Available

Switch-A /fabric-interconnect #

Related Commands Command Description


scope fabric-interconnect

show activate

show environment

show event

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1709
Commands
show vlan-port-count

Command Description
show fan

show fault

show file

show firmware

show fsm

show image

show inventory

show psu

show stats

show storage

show version

Cisco UCS Manager CLI Command Reference, Release 2.0


1710 OL-25718-02
Commands
show vm-life-cycle-policy

show vm-life-cycle-policy
To display information on the virtual machine life cycle policy, use the show vm-life-cycle-policy command.

show vm-life-cycle-policy {expand| detail}*

Syntax Description expand Displays additional information on the VM life cycle policy.

detail Displays detailed information on the VM life cycle policy.

Command Default By default, the command displays additional information on the VM life cycle policy.

Command Modes Virtual Machine Management (/system/vm-mgmt)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines None

Examples This example shows how to display detailed information on the VM lifecycle policy.
Switch-A # scope system
Switch-A /system # scope vm-mgmt
Switch-A /system/vm-mgmt # show vm-life-cycle-policy detail

VM Life Cycle Policy:


VM Retention Time (Minutes): 15
vNIC Retention Time (Minutes): 15

Switch-A /system/vm-mgmt #

Related Commands Command Description


scope vm-life-cycle-policy

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1711
Commands
show web-session-limits

show web-session-limits
To view information on the configured Web session limits, use the show web-session-limits command.

show web-session-limits detail

Syntax Description detail (Optional) Use this option to view detailed information on all Web session limits
that have been configured.

Command Default By default, the command displays information on the configured Web session limits in a tabular format.

Command Modes Services (/system/services)

Command History Release Modification


1.4(1) This command was introduced.

Usage Guidelines Web session limits should have been configured prior to using this command.

Examples This example shows how to view information on the configured Web session limits.
Switch-A # scope system
Switch-A /system # scope services
Switch-A /system/services # show web-session-limits detail

Web Sessions:
Maximum logins for single user: 32
Maximum sessions: 256

Switch-A /system/services #

Related Commands Command Description


scope web-session-limits

set peruser

set total

Cisco UCS Manager CLI Command Reference, Release 2.0


1712 OL-25718-02
Commands
ssh

ssh
To log in to a host that supports SSH, use the ssh command.

ssh host-name

Syntax Description host-name Host name or IP address. Specify the IP address in the format A.B.C.D.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to log in to a host that supports SSH.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.

Examples This example shows how to open an SSH connection to a host:


switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# ssh 192.0.2.111


samdme@192.0.2.111's password:

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1713
Commands
tail-mgmt-log

tail-mgmt-log
To display the last ten lines of a management log file and monitor new entries, use the tail-mgmt-log
command in local management command mode.

tail-mgmt-log filebase

Syntax Description filebase Base name of a management log file. See Usage Guidelines
for valid base names.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to display the ten most recent lines of a management log file and monitor new entries.
Using the filebase argument, this command accesses the management log file at /var/sysmgr/sam_logs/
filebase .log , displaying the ten most recent lines of the log file. After displaying the stored lines, the command
remains open, displaying any new lines until you press the Ctrl-C key combination.
The following list shows the valid values for the filebase argument:
• httpd
• svc_sam_bladeAG
• svc_sam_cliD
• svc_sam_controller
• svc_sam_dcosAG
• svc_sam_dme
• svc_sam_extvmmAG
• svc_sam_hostagentAG
• svc_sam_nicAG
• svc_sam_pamProxy
• svc_sam_portAG

Cisco UCS Manager CLI Command Reference, Release 2.0


1714 OL-25718-02
Commands
tail-mgmt-log

This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.

Examples This example shows how to monitor the most recent entries of a management log file:
switch-A# connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# tail-mgmt-log svc_sam_cliD


[INFO][0xaddbbbb0][Jan 6 13:36:56.216][sam_cliD:newSessionCb] received a vsh session
announce message for terminal: /dev/pts/0(11908)
[INFO][0xae13bbb0][Jan 6 14:48:28.072][sam_cliD:auditSessions] audit: removing terminal
9512
[INFO][0xae13bbb0][Jan 6 14:48:28.073][sam_cliD:auditSessions] audit: removing terminal
11908
[INFO][0xaddbbbb0][Jan 6 16:34:14.019][sam_cliD:newSessionCb] received a vsh session
announce message for terminal: /dev/pts/1(23013)
[INFO][0xae13bbb0][Jan 6 17:01:28.100][sam_cliD:auditSessions] audit: removing terminal
23013
[INFO][0xaddbbbb0][Jan 12 16:07:28.315][sam_cliD:newSessionCb] received a vsh session
announce message for terminal: /dev/pts/2(8612)
[INFO][0xaddbbbb0][Jan 12 16:09:45.404][sam_cliD:newSessionCb] received a vsh session
announce message for terminal: /dev/pts/3(8794)
[INFO][0xae13bbb0][Jan 12 16:09:58.073][sam_cliD:auditSessions] audit: removing terminal
8612
[INFO][0xae13bbb0][Jan 12 16:17:58.072][sam_cliD:auditSessions] audit: removing terminal
8794
[INFO][0xaddbbbb0][Jan 13 09:41:08.052][sam_cliD:newSessionCb] received a vsh session
announce message for terminal: /dev/pts/4(8618)
Ctrl-C
switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1715
Commands
telnet

telnet
To log in to a host that supports Telnet, use the telnet command in local management command mode.

telnet host-name [ port-num ]

Syntax Description host-name Host name or IP address. Specify the IP address in the format A.B.C.D.

port-num (Optional) TCP port number. The default is 23.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to log in to a host that supports Telnet.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.

Examples This example shows how to open a Telnet connection to a host:


switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# telnet 10.193.66.111


Trying 10.20.30.111...
Connected to 10.20.30.111.
Escape character is '^]'.

SanJose login:

Cisco UCS Manager CLI Command Reference, Release 2.0


1716 OL-25718-02
Commands
telnet

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1717
Commands
terminal length

terminal length
To set the number of lines to be displayed in the terminal window, use the terminal length command.

terminal length lines

Syntax Description lines Specifies the number of lines to be displayed in the terminal window.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to set the number of lines to be displayed in the terminal window. The range for lines is
0 to 511 lines. Enter 0 to eliminate pausing.

Examples This example shows how to set the terminal length to 12 lines:
switch-A# terminal length 12
switch-A *# commit-buffer
switch-A #

Related Commands Command Description


terminal width

Cisco UCS Manager CLI Command Reference, Release 2.0


1718 OL-25718-02
Commands
terminal monitor

terminal monitor
To enable the display of syslog messages in the terminal window, use the terminal monitor command.

terminal [no] monitor

Syntax Description no Disables the display of syslog messages in the terminal window.

Command Default Disabled

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to display syslog messages in the terminal window. To prevent the display of syslog
messages in the terminal window, enter the terminal no monitor command.

Examples This example shows how to enable the display of syslog messages in the terminal window:
switch-A# terminal monitor
switch-A *# commit-buffer
switch-A #

Related Commands Command Description


set syslog monitor

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1719
Commands
terminal session-timeout

terminal session-timeout
To configure an inactivity timeout for terminal window sessions, use the terminal session-timeout command.

terminal session-timeout minutes

Syntax Description minutes Specifies the number of minutes of inactivity before the terminal session
disconnects.

Command Default Disabled

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to configure the inactivity timeout for terminal window sessions. The range of minutes
is 0 to 525600 minutes. To prevent the session from disconnecting due to inactivity, enter 0 minutes.

Examples This example shows how to configure an inactivity timeout of 60 minutes for a terminal window session:
switch-A# terminal session-timeout 60
switch-A *# commit-buffer
switch-A #

Cisco UCS Manager CLI Command Reference, Release 2.0


1720 OL-25718-02
Commands
terminal width

terminal width
To set the number of characters per line to be displayed in the terminal window, use the terminal width
command.

terminal width characters

Syntax Description characters Specifies the number of characters per line to be displayed in the terminal
window.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to set the number of characters per line to be displayed in the terminal window. The range
for characters is 24 to 511 characters.

Examples This example shows how to set the terminal display width to 40 characters per line:
switch-A# terminal width 40
switch-A *# commit-buffer
switch-A #

Related Commands Command Description


terminal length

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1721
Commands
top

top
To enter root from any mode, use the top command.

top

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to enter root from any mode:

switch /system/services # top

switch#

Cisco UCS Manager CLI Command Reference, Release 2.0


1722 OL-25718-02
Commands
traceroute

traceroute
To view the route to a network host, use the traceroute command in local management command mode.

traceroute host-name [source source]

Syntax Description host-name The host name or IP address of the destination network host.

source source (Optional) Specifies the IP address to be used as the source address in
outgoing probe packets.

Command Default None

Command Modes Local management (local-mgmt)

Command History Release Modification


1.0(1) This command was introduced.

Usage Guidelines Use this command to trace the route of IP packets to a network host.
You can use the optional source keyword to force the source address of the probe packets to be another IP
address of the sending host.
This command is available on the local management port command line. Use the connect local-mgmt
command to connect to that command line.

Examples This example shows how to trace the route to a network host:
switch-A # connect local-mgmt a
Cisco UCS 6100 Series Fabric Interconnect

TAC support: http://www.cisco.com/tac

Copyright (c) 2009, Cisco Systems, Inc. All rights reserved.

The copyrights to certain works contained herein are owned by


other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html

switch-A(local-mgmt)# traceroute 64.102.255.44

traceroute to 64.102.255.44 (64.102.255.44), 30 hops max, 38 byte packets


1 10.19.64.1 (10.19.64.1) 2.243 ms 3.317 ms 4.054 ms

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1723
Commands
traceroute

2 10.19.15.1 (10.19.15.1) 4.003 ms 3.823 ms 4.042 ms


3 172.28.177.129 (172.28.177.129) 4.022 ms 3.824 ms 4.051 ms
4 172.16.152.13 (172.16.152.13) 4.023 ms 3.815 ms 4.063 ms
5 192.168.241.162 (192.168.241.162) 4.026 ms 3.839 ms 4.075 ms
6 192.168.241.254 (192.168.241.254) 3.969 ms 3.801 ms 4.043 ms
7 10.112.4.157 (10.112.4.157) 4.007 ms 3.846 ms 4.044 ms
8 10.112.4.162 (10.112.4.162) 77.778 ms 77.646 ms 77.852 ms
9 10.112.4.110 (10.112.4.110) 77.851 ms 77.612 ms 77.848 ms
10 192.0.2.158 (192.0.2.158) 77.908 ms 77.553 ms 77.810 ms
11 64.102.241.134 (64.102.241.134) 77.851 ms 77.583 ms 77.807 ms
12 64.102.244.14 (64.102.244.14) 77.854 ms 77.534 ms 77.838 ms
13 64.102.255.44 (64.102.255.44) 77.874 ms 77.590 ms 77.800 ms

switch-A(local-mgmt)#

Related Commands Command Description


connect local-mgmt

Cisco UCS Manager CLI Command Reference, Release 2.0


1724 OL-25718-02
Commands
up

up
To move up one mode, use the up command.

up

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to move up one mode:

switch-A /org/service-profile # up

switch-A /org #

Related Commands Command Description


top

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1725
Commands
update catalog

update catalog
To update and apply the capability catalog, use the update catalog command.

update catalog url

Syntax Description url Specifies the URL of a capability catalog update file.

Command Default None

Command Modes Capability (/system/capability)

Command History Release Modification


1.3(1) This command was introduced.

Usage Guidelines Use this command to perform a capability catalog update. Specify a URL containing the protocol, user,
password, remote hostname, and remote path for the capability catalog update file. The URL can be specified
using the syntax of one of the following protocols:
• FTP— ftp:// hostname/path
• SCP— scp:// username@hostname/path
• SFTP— sftp:// username@hostname/path
• TFTP— tftp:// hostname:port-num/path

If the remote host requires a username and password, use the URL format for the specific protocol, such as
ftp:// user:password@ hostname/path for FTP.
When a username is specified without a password, you are prompted for a password.

Examples This example shows how to update and apply the capability catalog using SCP:
UCS-A# scope system
UCS-A /system # scope capability
UCS-A /system/capability # update catalog
scp://user1@192.0.2.111/catalogs/ucs-catalog.1.0.0.4.bin
Password:

UCS-A /system/capability #

Cisco UCS Manager CLI Command Reference, Release 2.0


1726 OL-25718-02
Commands
update catalog

Related Commands Command Description


scope cat-updater

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1727
Commands
update firmware

update firmware
To update the firmware, use the update firmware command.

update firmware version activate[force]set-startup

Syntax Description version Version number.

activate (Optional) Specifies activation of firmware.

force (Optional) Specifies force of firmware update.

set-startup (Optional) Specifies set the firmware update on startup.

Command Default None

Command Modes Input/output module (/chassis/iom)


BIOS (/chassis/server/bios)

Command History Release Modification


1.0(1) This command was introduced.

2.0(2) This command was introduced in the BIOS command mode.

Examples This example shows how to update the firmware:

switch-A# scope chassis 1

switch-A /chassis # scope iom 2

switch-A# /chassis/iom # update firmware 1.0(0.988)

switch-A# /chassis/iom* # activate firmware 1.0(0.988)

switch-A# /chassis/iom* # commit-buffer

switch-A# /chassis/iom #

Related Commands Command Description


show firmware
show image

Cisco UCS Manager CLI Command Reference, Release 2.0


1728 OL-25718-02
Commands
where

where
To determine where you are in the CLI, use the where command.

where

This command has no arguments or keywords.

Command Default None

Command Modes Any command mode

Command History Release Modification


1.0(1) This command was introduced.

Examples This example shows how to determine where you are in the CLI:

switch-A /org/service-profile # where

Mode: /org/service-profile
Mode Data:
scope org
enter org org10
enter service-profile sp10 instance
switch-A /org/service-profile #

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 1729
Commands
where

Cisco UCS Manager CLI Command Reference, Release 2.0


1730 OL-25718-02
INDEX

A chassis 8
discovery policy 8
acknowledge chassis 92 chassis discovery policy 8
acknowledge fault 94 about 8
acknowledge fex command 93 Cisco Discovery Protocol 15
acknowledge server 95 Cisco UCS Manager 35
acknowledge slot 96 about 35
activate firmware 97 Cisco VM-FEX 33
activate firmware (fabric) command 99 clear alertgroups 115
activate internal firmware command 101 clear auth-server-group command 116
adapters 33, 34 clear backup action 117
NIC 33 clear cores 118
VIC 34 clear file command 119
virtualization 33 clear message command 120
add alertgroups 102 clear password-history command 121
add backup action 104 clear sel (/chassis/server) command 122, 123
add privilege 105 clear sshkey 124
administration 35 CLI session limits 43
apply pending-changes immediate command 108 cluster force primary 125
architectural simplification 1 cluster lead 126
associate server 109 commands for object management 41
associate server-pool 111 commit-buffer 128
autoconfiguration policy 17 communication services 43, 44
about 17 web session limits 43, 44
connect adapter 129
connect bmc 130
B connect clp 131
connect iom command 132
backup sel 112 connect local-mgmt 133
banner 44, 45, 46, 47 connect-nxos command 134
pre-login 44, 45, 46, 47 converged network adapters 33
best effort system class 29 virtualization 33
boot policies 7 copy 135
about 7 create 41
bronze system class 29 create adapter command 137
burned in values 6 create auth-domain command 138
create auth-profile command 139
create auth-server-group command 141
create auto-target-if command 142
C create backup command 143
cd 113 create bios-policy 145
create bladeserver-disc-policy command 146

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 IN-1
Index

create block command 147 create class motherboard-temp-stats command 203


create boot-definition command 149 create class pcie-fatal-completion-error-stats 204
create boot-policy command 150 create class pcie-fatal-error-stats 205
create boot-target 151 create class pcie-fatal-protocol-error-stats 206
create cap-qual 152 create class pcie-fatal-receiving-error-stats 207
create certreq command 154 create class processor-runtime command 208
create chassis command 156 create class psu-input-stats command 209
create class chassis-stats command 157 create class psu-stats command 210
create class cmc-stats command 158 create class rack-unit-fan-stats command 211
create class cpu-env-stats 159 create class rack-unit-psu-stats command 212
create class dimm-env-stats 160 create class system-stats command 213
create class dimm-stats command 161 create class vnic-stats command 214
create class env-stats 162 create client 215
create class ether-error-stats command 163 create cluster command 216
create class ether-if-stats command 164 create cpu 217
create class ether-loss-stats command 165 create data-center 218
create class ether-pause-stats 166 create default-auth command 219
create class ether-rx-stats command 173 create default-behavior 220
create class ether-tx-stats command 174 create dest-interface command 222
create class ethernet-port-err-stats command 167 create destination command 221
create class ethernet-port-multicast-stats command 168 create dhcp-ip-params command 223
create class ethernet-port-over-under-sized-stats command 169 create distributed-virtual-switch 224
create class ethernet-port-stats command 170 create dns command 225
create class ethernet-port-stats-by-size-large-packets command 171 create dynamic-vnic-conn 226
create class ethernet-port-stats-by-size-small-packets create dynamic-vnic-conn-policy 227
command 172 create egress-policy 228
create class fan-module-stats command 175 create eth-if (vnic-iscsi) command 230
create class fan-stats command 176 create eth-if command 229
create class fc-error-stats command 177 create eth-mon-session command 231
create class fc-if-event-stats command 178 create eth-profile command 232
create class fc-if-fc4-counters command 179 create eth-target command 233
create class fc-if-frame-stats command 180 create ext-static-ip command 234
create class fc-port-stats command 181 create fc-mon-session command 235
create class fc-stats command 182 create fc-policy 237
create class fex-env-stats command 183 create fcoe-if command 236
create class fex-power-summary command 184 create folder 238
create class fex-psu-input-stats command 185 create fw-host-pack command 239
create class io-card-stats 186 create fw-mgmt-pack command 240
create class mb-power-stats command 187 create hv-conn command 241
create class mb-temp-stats command 188 create import-config command 242
create class memory-array-env-stats 189 create initiator command 244
create class memory-runtime command 190 create interface command 245
create class menlo-dce-port-stats command 191 create interface fc command 247
create class menlo-eth-error-stats command 192 create interface fcoe command 248
create class menlo-eth-stats command 193 create ip-if command 249
create class menlo-fc-error-stats command 194 create ipmi-access-profile command 250
create class menlo-fc-stats command 195 create ipmi-user command 251
create class menlo-host-port-stats command 196 create iqn-pool command 252
create class menlo-mcpu-error-stats command 197 create iscsi command 255
create class menlo-mcpu-stats command 198 create iscsi-policy command 254
create class menlo-net-eg-stats command 199 create keyring 256
create class menlo-net-in-stats command 200 create lan command 257
create class menlo-q-error-stats command 201 create ldap-group command 258
create class menlo-q-stats command 202 create ldap-group-rule command 259

Cisco UCS Manager CLI Command Reference, Release 2.0


IN-2 OL-25718-02
Index

create local command 260 create slot command 326


create local-disk-config command 261 create snmp-trap command 327
create local-disk-config-policy command 262 create snmp-user command 328
create local-user command 264 create sol-config command 329
create locale command 263 create sol-policy command 330
create lun command 265 create static-ip-params command 331
create mac-pool 266 create static-target-if command 333
create mac-security 267 create stats-threshold-policy command 334
create maint-policy command 268 create storage command 335
create member-port (/port-channel) command 274 create threshold-value 336
create member-port command 269 create trustpoint 338
create member-port fc command 271 create uuid-suffix-pool 339
create member-port fcoe command 273 create vcenter 340
create member-port-channel command 276 create vcon 341
create memory command 278 create vcon-policy 342
create mon-src command 279 create vhba command 343
create network (/eth-uplink/port-profile) 281 create vhba-templ command 345
create network (port-profile) 282 create virtual-media command 347
create ntp-server command 283 create vlan (port-profile) command 350
create nw-ctrl-policy command 284 create vlan command 348
create occurrence one-time command 286 create vnic command 351
create occurrence recurring command 287 create vnic-egress-policy command 353
create org command 289 create vnic-iscsi command 354
create org-ref command 290 create vnic-templ command 355
create pack-image command 292 create vsan command 357
create path (iscsi) command 296 create wwn-pool 359
create path command 294 cycle command 360
create physical-qual 297
create pin-group command 298
create policy 299
create pooled-ip-params command 301
D
create pooling-policy command 302 decommission chassis command 361
create port-channel command 303 decommission fex command 362
create port-profile (eth-uplink) 304 decommission server (chassis command 364
create port-profile (profile-set) 305 decommission server command 363
create power-control-policy command 306 default service profiles 6
create power-group command 307 deferring deployment 21
create processor 308 maintenance policies 21
create profile command 309 delete 41
create qos-policy 310 delete adapter command 365
create rack command 311 delete auth-domain command 366
create role command 312 delete auth-profile command 367
create san-image command 313 delete auth-server-group command 368
create scheduler command 314 delete auto-target-if command 369
create scrub-policy command 315 delete backup command 370
create server 316 delete bladeserver-disc-policy command 371
create server server-pool 318 delete block command 372
create server-autoconfig-policy command 319 delete boot-definition command 374
create server-disc-policy command 320 delete boot-policy command 375
create server-inherit-policy command 321 delete boot-target 376
create server-pool 322 delete cap-qual 377
create server-qual command 323 delete certreq command 379
create server-ref command 324 delete chassis command 380
create service-profile 325

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 IN-3
Index

delete class chassis-stats command 381 delete egress-policy 435


delete class cpu-env-stats 382 delete eth-if command 436
delete class dimm-env-stats 383 delete eth-mon-session command 437
delete class dimm-stats command 384 delete eth-profile command 438
delete class env-stats 385 delete eth-target command 439
delete class ether-error-stats command 386 delete ext-static-ip command 440
delete class ether-if-stats command 387 delete fc-mon-session command 441
delete class ether-loss-stats command 388 delete fc-policy 442
delete class ether-pause-stats 395 delete folder 443
delete class ether-rx-stats command 396 delete fw-host-pack 444
delete class ether-tx-stats command 397 delete fw-mgmt-pack 445
delete class ethernet-port-err-stats 389 delete image command 446
delete class ethernet-port-multicast-stats 390 delete import-config command 448
delete class ethernet-port-over-under-sized-stats 391 delete initiator command 449
delete class ethernet-port-stats 392 delete interface command 450
delete class ethernet-port-stats-by-size-large-packets 393 delete interface fc command 451
delete class ethernet-port-stats-by-size-small-packets 394 delete interface fcoe command 452
delete class fan-module-stats 398 delete ip-if command 453
delete class fan-stats 399 delete ipmi-access-profile command 454
delete class fc-error-stats 400 delete ipmi-user command 455
delete class fc-port-stats 401 delete iqn-pool command 456
delete class fc-stats 402 delete iscsi command 458
delete class fex-env-stats command 403 delete iscsi-policy command 457
delete class fex-power-summary command 404 delete keyring command 459
delete class fex-psu-input-stats command 405 delete lan command 460
delete class io-card-stats 406 delete ldap-group command 461
delete class mb-power-stats 407 delete ldap-group-rule command 462
delete class mb-temp-stats 408 delete local command 463
delete class memory-array-env-stats 409 delete local-disk-config command 465
delete class motherboard-temp-stats command 410 delete local-disk-config-policy 466
delete class pcie-fatal-completion-error-stats 411 delete local-user command 467
delete class pcie-fatal-error-stats 412 delete locale command 464
delete class pcie-fatal-protocol-error-stats 413 delete lun command 468
delete class pcie-fatal-receiving-error-stats 414 delete mac-pool command 469
delete class psu-input-stats 415 delete mac-security command 470
delete class psu-stats 416 delete maint-policy command 471
delete class rack-unit-fan-stats command 417 delete member-port command 472
delete class rack-unit-psu-stats command 418 delete member-port fc command 474
delete class system-stats 419 delete member-port fcoe command 476, 696
delete class vnic-stats 420 delete member-port-channel command 478
delete client 421 delete memory command 480
delete cluster command 422 delete mon-src command 481
delete cpu 423 delete network 483
delete data-center 424 delete network (/profile-set/port-profile) 484
delete default-auth command 425 delete ntp-server 485
delete default-behavior 426 delete nw-ctrl-policy command 486
delete dest-interface command 428 delete occurrence one-time command 487
delete destination command 427 delete occurrence recurring command 488
delete dhcp-ip-params command 429 delete org 489
delete distributed-virtual-switch 430 delete org-ref command 490
delete dns command 431 delete pack-image 491
delete download-task 432 delete path (iscsi) command 494
delete dynamic-vnic-conn 433 delete path command 493
delete dynamic-vnic-conn-policy 434 delete pending-deletion 495

Cisco UCS Manager CLI Command Reference, Release 2.0


IN-4 OL-25718-02
Index

delete physical-qual 496 delete vnic-templ command 553


delete pin-group command 497 delete vsan command 554
delete policy command 498 delete wwn-pool command 555
delete pooled-ip-params command 500 diagnostic-interrupt command 556
delete pooling-policy command 501 dir 557
delete port-channel command 502 disable (distributed-virtual-switch) 559
delete port-profile (profile-set) 503 disable (port-channel) command 567
delete power-control-policy command 504 disable cdp command 560
delete power-group command 505 disable cimxml command 561
delete processor 506 disable core-export-target 562
delete profile 507 disable http command 563
delete qos-policy 508 disable http-redirect command 564
delete rack command 509 disable https command 565
delete remote-user 510 disable locator-led 566
delete role command 511 disable snmp command 568
delete san-image 512 disable syslog 569
delete scheduler command 513 disable telnet-server command 570
delete scrub-policy command 514 disassociate command 571
delete server (/security) command 517 discard-buffer 572
delete server command 515 discovery policy 8, 17
delete server-autoconfig-policy 518 chassis 8
delete server-disc-policy command 519 rack server 17
delete server-inherit-policy 520 server 17
delete server-pool command 521 download image command 573
delete server-qual command 522 download license command 574
delete server-ref command 523 dynamic vNIC connection policy 11
delete service-profile 524 about 11
delete slot 525
delete snmp-trap 526
delete snmp-user 527
delete sol-config 528
E
delete sol-policy 529 enable (port-channel) command 584
delete static-ip-params command 530 enable cdp command 576
delete static-target-if command 531 enable cimxml command 577
delete stats-threshold-policy 532 enable cluster 578
delete storage command 533 enable core-export-target command 579
delete target command 534 enable http command 580
delete threshold-value 535 enable http-redirect command 581
delete trustpoint command 537 enable https command 582
delete user-sessions 538 enable locator-led 583
delete user-sessions local 539 enable snmp command 585
delete user-sessions remote 540 enable syslog 586
delete uuid-suffix-pool command 541 enable telnet-server command 588
delete vcenter 542 end command 589
delete vcon 543 ensable (distributed-virtual-switch) 575
delete vcon-policy 544 enter 41
delete vhba command 545 enter adapter command 590
delete vhba-templ 546 enter auth-domain command 591
delete virtual-media 547 enter auth-profile command 592
delete vlan 548 enter auth-server-group command 593
delete vlan-group-permit command 549 enter auto-target-if command 594
delete vlan-permit command 550 enter backup 595
delete vnic command 551 enter bladeserver-disc-policy command 597
delete vnic-iscsi command 552

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 IN-5
Index

enter block 598 enter egress-policy 655


enter boot-definition 600 enter eth-if 656
enter boot-policy 601 enter eth-if (vnic-iscsi) command 657
enter boot-target 602 enter eth-mon-session command 658
enter cap-qual 603 enter eth-policy 659
enter chassis command 605 enter eth-target command 660
enter class chassis-stats 606 enter ext-static-ip command 661
enter class cpu-env- stats 607 enter fc-mon-session command 662
enter class dimm-env-stats 608 enter fc-policy 663
enter class env-stats 609 enter folder 664
enter class ether-error-stats 610 enter fw-host-pack 665
enter class ether-loss-stats 611 enter fw-mgmt-pack 666
enter class ether-pause-stats 618 enter import-config 667
enter class ether-rx-stats 619, 620 enter initiator 669
enter class ethernet-port-err-stats 612 enter interface 670
enter class ethernet-port-multicast-stats 613 enter interface fc command 671
enter class ethernet-port-over-under-sized-stats 614 enter interface fcoe command 672
enter class ethernet-port-stats 615 enter ip-if command 673
enter class ethernet-port-stats-by-size-large-packets 616 enter ipmi-access-profile 674
enter class ethernet-port-stats-by-size-small-packets 617 enter ipmi-user 675
enter class fan-module-stats 621 enter iqn-pool command 677
enter class fan-stats 622 enter iscsi command 679
enter class fc-error-stats 623 enter iscsi-policy command 678
enter class fc-port-stats 624 enter keyring 680
enter class fc-stats 625 enter lan 681
enter class fex-env-stats command 626 enter ldap-group command 682
enter class fex-power-summary command 627 enter ldap-group-rule command 683
enter class fex-psu-input-stats command 628 enter local 684
enter class io-card-stats 629 enter local-disk-config 685
enter class mb-power-stats 630 enter local-disk-config-policy 686
enter class mb-temp-stats 631 enter local-user 688
enter class memory-array-env-stats 632 enter locale 687
enter class motherboard-temp-stats command 633 enter lun command 689
enter class pcie-fatal-completion-error-stats 634 enter mac-pool 690
enter class pcie-fatal-error-stats 635 enter mac-security 691
enter class pcie-fatal-protocol-error-stats 636 enter maint-policy command 692
enter class pcie-fatal-receiving-error-stats 637 enter member-port 693
enter class psu-input-stats 638 enter member-port (/fc-storage/vsan) command 698
enter class rack-unit-fan-stats command 639 enter member-port (/port-channel) command 700
enter class rack-unit-psu-stats command 640 enter member-port fc command 695
enter class system-stats 641 enter member-port-channel command 701
enter class vnic-stats 642 enter memory command 703
enter client 643 enter mon-src command 704
enter cluster command 644 enter network 706
enter cpu 645 enter nw-ctrl-policy command 707
enter data-center 646 enter occurrence one-time command 708
enter default-auth command 647 enter occurrence recurring command 709
enter default-behavior 648 enter org 710
enter dest-interface command 650 enter pack-image 711
enter destination 649 enter path 713
enter dhcp-ip-params command 651 enter path (iscsi) command 714
enter distributed-virtual-switch 652 enter pin-group 715
enter dynamic-vnic-conn 653 enter policy 716
enter dynamic-vnic-conn-policy 654 enter pooled-ip-params command 718

Cisco UCS Manager CLI Command Reference, Release 2.0


IN-6 OL-25718-02
Index

enter pooling-policy 719 flexibility 2


enter port-channel command 720 flow control 3
enter port-profile (profile-set) 721 link-level 3
enter power-control-policy command 722 priority 3
enter power-group command 723 flow control policy 21, 30
enter processor command 724 about 21, 30
enter qos-policy 725
enter rack command 726
enter scheduler command 727
enter server command 728
G
enter server-ref command 729 global cap policy 12
enter static-ip-params command 730 gold system class 29
enter static-target-if command 732 guidelines 26, 29
enter storage command 733 oversubscription 26
enter threshold-value 734 pinning 29
enter vcenter 736
enter vcon 737
enter vcon-policy 738
enter vlan 739, 741 H
enter vnic-iscsi command 742 hardware-based service profiles 6
enter vsan command 743 hardware, stateless 31
erase configuration 745 high availability 2, 38
erase-log-config 746 about 38
Ethernet 3, 21, 30 high availability configuration 38
Fibre Channel over 3 about 38
flow control policies 21, 30 host firmware package 13
Ethernet adapter policies 11 about 13
about 11 HTTP 43, 44
web session limits 43, 44
HTTPS 43, 44
F web session limits 43, 44

fabric interconnects 38
high availability 38
fault collection policy 20 I
about 20 IEEE 802.1Qbh 33
faults 20 IEEE 802.3x link-level flow control 3
collection policy 20 inheritance, servers 18
lifecycle 20 inherited values 6
FCoE 3 initial templates 7
features 30, 31 install file command 747
opt-in 30 IP addresses 25
stateless computing 31 management IP pool 25
Fibre Channel 3 IP pools 25
link-level flow control 3 management 25
over Ethernet 3 IPMI access profiles 13
priority flow control 3 about 13
Fibre Channel adapter policies 11
about 11
Fibre Channel system class 30
firmware 13, 14 L
host package 13
management package 14 LAN 19
vNIC policy 19

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 IN-7
Index

lanes, virtual 29 oversubscription (continued)


lifecycle, faults 20 guidelines 26
link-level flow control 3 overview 1
local disk configuration policy 14
about 14
ls 748
P
packs 13, 14
M host firmware 13
management firmware 14
MAC addresses 24 pending commands 43
pools 24 PFC 3
maintenance policies 21 pin groups 27
about 21 about 27
management firmware package 14 ping 754
about 14 pinning 27, 29
management interfaces monitoring policy 15 about 27
about 15 guidelines 29
management IP pools 25 servers to server ports 27
about 25 platinum system class 29
mkdir command 750 policies 7, 8, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 30
mobility 31 about 7
move 752 autoconfiguration 17
multi-tenancy 32 boot 7
about 32 chassis discovery 8
opt-in 32 dynamic vNIC connection 11
opt-out 32 about 11
Ethernet 11
fault collection 20
Fibre Channel adapter 11
N flow control 21, 30
network 4 global cap policy 12
connectivity 4 host firmware 13
network control policy 15 IPMI access 13
NIC adapters 33 local disk configuration 14
virtualization 33 maintenance 21
management firmware 14
management interfaces monitoring 15
network control 15
O power 17
opt-in 30, 31, 32 power control 16
about 30 PSU 17
multi-tenancy 32 QoS 17, 30
stateless computing 31 rack server discovery 17
opt-out 30, 31, 32 scrub 21
multi-tenancy 32 serial over LAN 22
stateless computing 31 about 22
organizations 32 server discovery 17
multi-tenancy 32 server inheritance 18
overriding server identity 5 about 18
oversubscription 25, 26 server pool 18
about 25 server pool qualification 18
considerations 25 statistics collection 22

Cisco UCS Manager CLI Command Reference, Release 2.0


IN-8 OL-25718-02
Index

policies (continued) recommission fex command 762


threshold 22 recommission server command 763
vHBA 19 recover-bios 764
VM lifecycle 19 remove alertgroups 765
vNIC 19 remove backup action 767
vNIC/vHBA placement 20 remove fex command 769
pools 23, 24, 25 remove privilege command 770
about 23 remove server command 773
MAC 24 reset command 774
management IP 25 reset pers-bind 779
servers 23 reset-cmos command 776
UUID suffixes 24 reset-errors command 777
WWN 24 reset-kvm command 778
ports 27 restart 780
pinning server traffic 27 rmdir command 781
power 756 run-script 783
power control policy 16
power down soft-followed-by-hard command 757
power down soft-shut-down command 758
power management 16
S
policies 16 SAN 19
power control 16 vHBA policy 19
power policy 17 save 784
about 17 scalability 2
pre-login banner 44, 45, 46, 47 scope 41
creating 45 scope adapter command 785
deleting 47 scope auth-domain command 786
modifying 46 scope auth-profile command 787
priority flow control 3 scope auth-server-group command 788
profiles 4 scope auto-target-if command 789
PSU policy 17 scope backup command 790
pwd 759 scope banner command 791
scope beacon-led command 792
scope bios command 795
Q scope bios-settings command 793
scope bladeserver-disc-policy command 796
QoS policies 17, 30 scope block command 797
about 17, 30 scope boardcontroller 798
quality of service 17, 21, 29, 30 scope boot-definition command 799
about 29 scope boot-policy command 800
flow control policies 21, 30 scope boot-target 801
policies 17, 30 scope callhome command 802
system classes 29 scope cap-qual command 804
scope capability command 803
scope card command 806
scope cat-updater 807
R scope cert-store 808
rack server discovery policy 17 scope chassis (/capability) command 810
about 17 scope chassis command 809
rack-mount servers 17 scope chassis-conn-policy command 811
discovery policy 17 scope chassis-disc-policy command 812
reboot command 760 scope cimc 813
recommission chassis command 761 scope class chassis-stats command 814

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 IN-9
Index

scope class cpu-env-stats 815 scope eth-mon-session command 870


scope class dimm-env-stats 816 scope eth-policy 871
scope class ether-error-stats command 817 scope eth-server command 872
scope class ether-loss-stats command 818 scope eth-storage command 873
scope class ether-pause-stats 825 scope eth-target command 874
scope class ether-rx-stats command 826 scope eth-traffic-mon command 875
scope class ethernet-port-err-stats 819 scope eth-uplink command 876
scope class ethernet-port-multicast-stats 820 scope ext-eth-if command 877
scope class ethernet-port-over-under-sized-stats 821, 1511 scope ext-pooled-ip command 879
scope class ethernet-port-stats 822 scope ext-static-ip command 880
scope class ethernet-port-stats-by-size-large-packets 823 scope extension-key 878
scope class ethernet-port-stats-by-size-small-packets 824 scope fabric 881
scope class fan-module-stats command 828 scope fabric-if command 883
scope class fan-stats command 829 scope fabric-interconnect 884
scope class fc-error-stats command 830 scope fabric-port-channel command 885
scope class fc-stats command 831 scope fan command 886
scope class fex-env-stats command 832 scope fan-module command 887
scope class fex-power-summary command 833 scope fc command 888
scope class fex-psu-input-stats command 834 scope fc-mon-session command 889
scope class io-card-stats 835 scope fc-policy 890
scope class memory-array-env-stats 836 scope fc-storage command 891
scope class memory-error-correctable-codes-stats 837 scope fc-traffic-mon command 892
scope class memory-mirroring-error-stats 838 scope fc-uplink command 893
scope class memory-sparing-error-stats 839 scope fex command 894
scope class motherboard-temp-stats command 840 scope firmware command 895
scope class pc-ie-correctable-stats 841 scope flow-control command 896
scope class pcie-fatal-completion-error-stats 842 scope folder 897
scope class pcie-fatal-error-stats 843 scope fw-host-pack command 898
scope class pcie-fatal-protocol-error-stats 844 scope fw-mgmt-pack command 899
scope class pcie-fatal-receiving-error-stats 845 scope host-eth-if command 900
scope class rack-unit-fan-stats command 846 scope host-eth-if dynamic-mac command 901
scope class rack-unit-psu-stats command 847 scope host-fc-if command 902
scope client 848 scope host-fc-if wwn command 903
scope cluster command 850 scope host-iscsi-if command 904
scope cluster-set command 849 scope host-port-channel command 905
scope console-auth command 851 scope import-config command 906
scope cpu 852 scope instance 907
scope cpu (/system/capability) command 853 scope interface command 908
scope data-center 854 scope interface fc command 909
scope default-auth command 855 scope interface fcoe command 910
scope default-behavior 856 scope inventory command 911
scope dest-interface command 857 scope iom (/capability) command 913
scope dhcp-ip-params command 858 scope iom (/chassis) command 912
scope diag command 859 scope iom command 914
scope dimm command 860 scope ip-if command 915
scope distributed-virtual-switch 861 scope ipmi-access-profile command 916
scope download-task command 862 scope ipmi-user command 917
scope dynamic-vnic-conn 863 scope iqn-pool command 918
scope dynamic-vnic-conn-policy 864 scope iscsi command 920
scope egress-policy 865 scope iscsi-policy command 919
scope eth-best-effort 866 scope lan command 921
scope eth-classified command 867 scope ldap command 922
scope eth-if (vnic-iscsi) command 869 scope ldap-group command 923
scope eth-if command 868 scope ldap-group-rule command 924

Cisco UCS Manager CLI Command Reference, Release 2.0


IN-10 OL-25718-02
Index

scope license command 925 scope service-profile (/org) command 987


scope local-disk-config command 927 scope service-profile command 985
scope locale command 926 scope services command 984
scope lun (static-target-if) command 929 scope snmp-user command 988
scope lun command 928 scope static-ip-params command 989
scope mac-security 930 scope static-target-if command 991
scope maint-policy command 931 scope stats-threshold-policy command 992
scope management-extension command 932 scope storage-controller command 993
scope member-port command. 935 scope sys-defaults command 994
scope member-port fc command 937 scope system command 995
scope member-port fcoe command 938 scope tacacs command 996
scope member-port-channel command 933 scope threshold-value 997
scope memory-array command 940 scope update 999
scope mon-flt command 941 scope vcenter 1000
scope mon-src command 943 scope vcon-policy 1001
scope monitoring command 942 scope vhba command 1002
scope network 945 scope vhba-templ command 1003
scope nw-ctrl-policy command 946 scope virtual-machine 1004
scope occurrence one-time command 947 scope virtual-machine (vm-mgmt) command 1005
scope occurrence recurring command 948 scope vlan 1006
scope org 949 scope vlan command 1007
scope password-profile command 950 scope vm-life-cycle-policy command 1008
scope path (iscsi) command 951 scope vm-mgmt 1009
scope policy 952 scope vmware 1010
scope pooled-ip-params command 954 scope vnic command 1011
scope port-channel command 955 scope vnic-iscsi command 1012
scope port-profile 956 scope vnic-templ command 1013
scope post-code-reporter command 957 scope vsan command 1014
scope post-code-template command 958 scope web-session-limits command 1015
scope power-cap-mgmt command 959 scope wwn-pool command 1016
scope power-control-policy command 960 scrub policy 21
scope power-group command 961 about 21
scope pre-login-banner command 962 send 1017
scope priority-weight command 963 send-syslog 1018
scope profile command 964 send-test-alert 1020
scope profile-set 965 serial over LAN policy 22
scope psu command 966 about 22
scope psu-policy 967 server autoconfiguration policy 17
scope qos command 968 about 17
scope qos-policy 969 server discovery policy 17
scope rack command 970 about 17
scope rack-mount command 971 server inheritance policy 18
scope rackserver-disc-policy command 972 about 18
scope radius command 973 server pool policy 18
scope raid-controller command 974 about 18
scope role command 975 server pool policy qualification 18
scope scheduler command 976 about 18
scope security command 977 server virtualization 2
scope server (/ldap) command 979 servers 4, 5, 7, 13, 14, 17, 18, 23, 27, 31, 32
scope server (vm-mgmt) 980 boot policies 7
scope server command 978 configuration 4
scope server-if command 981 discovery policy 17
scope server-qual command 982 inheritance policy 18
scope server-ref command 983 IPMI access 13

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 IN-11
Index

servers (continued) set cert 1070


local disk configuration 14 set certchain 1071
multi-tenancy 32 set certificate 1072
pinning 27 set change-count command 1073
pool policy 18 set change-during-interval command 1074
pool qualifications 18 set change-interval command 1075
pools 23 set cimxml port command 1076
service profiles 4, 5 set clear password-history command 1078
stateless 31 set clear-action 1077
service profiles 4, 5, 6, 7 set cli suppress-field-spillover 1079
about 4 set cli suppress-headers 1081
configuration 4 set cli table-field-delimiter 1082
inherited values 6 set clock (memory) 1084
network connectivity 4 set clock (system) 1085
override identity 5 set cluster command 1086
templates 7 set collection-interval 1087
set account-status command 1022 set communication-policy-ctrl command 1088
set action command 1024 set community 1090
set adaptor-policy command 1026, 1027 set comp-queue count 1091
set addr command 1028 set concur-tasks command 1092
set admin-state 1032 set console-redir-config baud-rate 1093
set admin-state (beacon-led) command 1033 set console-redir-config console-redir 1094
set admin-vcon 1034 set console-redir-config flow-control command 1096
set adminspeed command 1029 set console-redir-config legacy-os-redir command 1097
set adminstate 1030 set console-redir-config terminal-type command 1098
set aes-128 1035 set contact 1100
set agent-policy 1036 set contract-id 1101
set alertgroups 1037 set core-export-target path 1102
set all 1039 set core-export-target port 1103
set arch command 1041 set core-export-target server-description 1104
set attribute command 1043 set core-export-target server-name 1105
set auth 1044 set correctible-memory-error-log-threshold-config 1106
set auth-server-group command 1049 set cos command 1107
set authentication console command 1045 set country command 1108
set authentication default command 1046 set cpu-performance-config cpu-performance command 1110
set authorization command 1048 set customer-id 1112
set authport command 1047 set data-center 1113
set backup action 1050 set data-center (/client) command 1115
set backup clear-on-backup 1052 set data-center-folder 1114
set backup destination 1053 set date command 1116
set backup format 1055 set day command 1118
set backup hostname 1056 set deescalating 1120
set backup interval 1057 set default-gw command 1121
set backup password 1058 set default-net 1122
set backup protocol 1059 set default-zoning command 1123
set backup remote-path 1060 set descr (vcon-policy) 1127
set backup user 1061 set descr command 1124
set basedn command 1062 set description 1126
set binddn 1063 set destination org 1128
set bios-settings-scrub 1064 set dhcp-vendor-id command 1129
set blocksize command 1066 set direct-cache-access-config access command 1130
set boot-option-retry-config retry command 1067 set direction command 1131
set boot-policy command 1068 set disk-scrub 1134
set cap-policy command 1069 set diskless command 1133

Cisco UCS Manager CLI Command Reference, Release 2.0


IN-12 OL-25718-02
Index

set dns command 1137 set identity uuid-suffix-pool 1195


set dns-policy-ctrl command 1135 set identity wwnn-pool 1196
set domain-name 1139 set identity wwpn-pool 1197
set drop 1140 set intel-turbo-boost-config 1198
set dvs 1141 set intel-vt-config 1199
set dynamic-eth 1142 set intel-vt-directed-io-config 1200
set e-mail (/keyring) command 1144 set interrupt coalescing-time 1202
set email 1143 set interrupt coalescing-type 1203
set enforce-vnic-name 1146 set interrupt count 1204
set enhanced-intel-speedstep-config 1147 set interrupt mode 1205
set error-recovery fcp-error-recovery 1148 set interval-days 1206
set error-recovery link-down-timeout 1149 set ip command 1207
set error-recovery port-down-io-retry-count 1150 set ipmi-access-profile command 1209
set error-recovery port-down-timeout 1151 set iqn-prefix command 1210
set escalating 1152 set iscsi-adaptor-policy command 1211
set execute-disable bit command 1153 set iscsi-identity initiator-name command 1212
set expiration command 1154 set iscsi-protocol-item boottotarget command 1213
set expire-warn-interval command 1156 set iscsi-protocol-item connection-timeout command 1214
set ext-mgmt-ip-state command 1157 set iscsi-protocol-item dhcp-timeout command 1215
set fabric 1158 set iscsi-protocol-item hbamode command 1216
set failover timeout 1159 set iscsi-protocol-item lun-busy-retrycount command 1217
set fc-if name 1160 set iscsi-protocol-item tcp-time-stamp command 1218
set fcoe-storage-native-vlan command 1162 set iscsi-targetname command 1219
set fcoe-vlan 1161 set iscsivnicname command 1220
set file size 1163 set isnative command 1221
set filter command 1164 set key (extension-key) 1223
set firstname command 1165 set key (server) 1222
set flap-interval 1166 set lastname command 1224
set flow-control-policy command 1167 set level 1225
set folder 1168 set link-aggregation-pref (/chassis-disc-policy) command 1228
set folder (/client) command 1169 set link-aggregation-pref command 1227
set forged-transmit command 1170 set local-disk-policy command 1229
set format 1171 set locality command 1230
set from-email 1173 set lun command 1232
set front-panel-lockout-config 1174 set lv-dimm-support-config 1233
set history-count command 1175 set mac-aging command 1235
set host 1176 set mac-pool 1236
set host-cos-control command 1177 set macaddress command 1234
set host-fw-policy command 1178 set maint-policy command 1237
set host-nwio-perf command 1179 set max-duration command 1240
set hostname 1180, 1181 set max-field-size 1242
set hour command 1182 set max-http-user-sessions command 1243
set http port command 1183 set max-memory-below-4gb-config max-memory command 1248
set https cipher-suite 1185 set max-ports 1245
set https cipher-suite-mode 1184 set max-variable-mtrr-setting-config processor-mtrr
set https keyring command 1186 command 1249
set https port command 1187 set maxcap command 1238
set hyper-threading-config 1188 set maxcores command 1239
set id command 1189 set maximum command 1244
set identity dynamic-mac 1190 set maxprocs command 1251
set identity dynamic-uuid 1191 set maxsize 1252
set identity dynamic-wwnn 1192 set maxthreads command 1253
set identity dynamic-wwpn 1193 set member-of-attribute command 1254
set identity mac-pool 1194 set memory-mirroring-mode 1255

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 IN-13
Index

set memory-ras-config 1256 set phone-contact 1320


set memory-sparing-mode sparing-mode command 1258 set pid-regex command 1321
set message command 1259 set pin-group 1323
set mgmt-fw-policy command 1260 set pingroupname command 1324
set mgmt-if-mon-policy arp-deadline command 1261 set pool command 1325
set mgmt-if-mon-policy monitor-mechanism command 1263 set port command 1326
set mgmt-if-mon-policy ping-requests command 1265 set port io-throttle-count 1328
set mgmt-if-mon-policy poll-interval command 1266 set port max-luns 1329
set min-interval command 1269 set port-f-logi retries 1330
set mincap command 1267 set port-f-logi timeout 1331
set mincores command 1268 set port-p-logi retries 1333
set minprocs command 1271 set port-p-logi timeout 1334
set minthreads command 1272 set portmode command 1332
set minute command 1273 set post-error-pause-config port-error-pause command 1335
set mode (eth-uplink) 1274 set power-budget committed 1336
set mode (fc-uplink) 1275 set power-control-policy command 1337
set mode (fw-pack) 1276 set preserve-pooled-values 1338
set mode (local-disk) 1277 set prio 1339
set model-regex 1279 set priority command 1341
set module 1280 set priv-password 1343
set modulus 1282 set privilege 1342
set mtu (eth-best-effort) command 1284 set proc-cap command 1344
set mtu (vnic) 1285 set processor-c-state-config c-state command 1346
set mtu command 1283 set processor-c1e-config c1e command 1246
set multicast-optimize 1286 set processor-c3-report-config 1348
set multicastoptimized 1287 set processor-c6-report-config 1350
set name command 1288 set protect 1351
set native 1289 set protocol 1352
set no-change-interval command 1290 set pubnwname command 1353
set normal-value 1291 set qos-policy 1354
set notificationtype command 1292 set qualifier command 1355
set numa-config 1293 set quiet-boot-config 1356
set numberofblocks command 1294 set rate 1357
set nw-control-policy 1295 set realloc command 1359
set offload large-receive 1296 set realm command 1360, 1361
set offload tcp-rx-checksum 1297 set reboot-on-update command 1362
set offload tcp-segment 1298 set reboot-policy command 1363
set offload tcp-tx-checksum 1299 set receive command 1365
set onboard scu storage support command 1300 set recv-queue count 1366
set order (device boot order) 1301 set recv-queue ring-size 1367
set order (vhba pci scan order) 1302 set redundancy 1368
set order (vnic relative order) 1303 set refresh-period 1370
set org-name command 1306 set regenerate 1371
set org-unit-name command 1304 set remote-file 1372
set out-of-band 1308 set reply-to-email 1373
set overlay-vnic-name command 1309 set reporting-interval 1374
set password (auth-profile) command 1312 set resume-ac-on-power-loss-config 1375
set password command 1310, 1313 set retention-interval 1377
set path 1314 set retries command 1379
set peak command 1315 set rootdn command 1380
set per-user command 1316 set rss receivesidescaling 1381
set perdiskcap command 1317 set scheduler command 1382
set pers-bind 1318 set scrub-policy command 1383
set phone command 1319 set scsi-io count 1384

Cisco UCS Manager CLI Command Reference, Release 2.0


IN-14 OL-25718-02
Index

set scsi-io ring-size 1385 set userid 1447


set send command 1386 set uuid-prefix 1449
set send-periodically 1387 set v3privilege 1450
set server 1388 set vcon 1451
set session-timeout command 1389 set vcon-profile 1453
set sharing command 1390 set version (snmp-trap) 1455
set site-id 1391 set version command 1454
set size 1392 set vhba command 1456
set snmp community command 1393 set virtual-ip command 1457
set sol-policy command 1394 set vlan-id command 1458
set speed (/fc-mon-session) cmmand 1397, 1398 set vmretention command 1459
set speed command 1395 set vnic command 1460
set speed command (Uplink Ethernet Port) 1399 set vnicretention command 1461
set src-templ-name command 1400 set weight command 1462
set sshkey command 1401 set width command 1463
set ssl 1402 set wwn command 1464
set state command 1404 set wwpn-pool 1465
set stats-policy command 1406 show activate status command 1466
set stepping command 1407 show adapter command 1467
set street-address 1408 show assoc command 1469
set subject-name command 1409 show audit-logs command 1470
set subnet command 1411 show auth-domain command 1472
set switch-priority 1412 show auth-server-group command 1474
set syslog console 1414 show authentication command 1473
set syslog file 1416 show backup 1475
set syslog monitor command 1418 show backup (ep-log-policy) 1477
set syslog remote-destination 1420 show beacon-led command 1478
set target command 1422 show beacon-led fsm status command 1479
set template 1424 show bios command 1480
set template-name command 1425 show bladeserver-disc-policy command 1481
set throttling 1426 show boot-definition command 1483
set timeofday-hour 1427 show boot-option-retry-config command 1485
set timeofday-minute 1428 show boot-order command 1484
set timeout command 1429 show boot-policy command 1486
set timezone 1430 show boot-target 1488
set total command 1432 show callhome command 1490
set trans-queue count 1433 show cap-qual command 1492
set trans-queue ring-size 1434 show card command 1494
set trustpoint 1435 show cat-updater 1495
set type 1437 show certreq command 1496
set type (backup) 1436 show chassis command 1500
set type (template) 1438 show chassis-conn-policy command 1498
set uefi-os-legacy-video-config legacy video command 1403 show cimc 1502
set units command 1439 show cimxml command 1504
set uplink-fail-action command 1440 show class cpu-stats command 1505
set uplink-trunking command 1441 show class dimm-env-stats 1507
set usb-boot-config make-device-non-bootable command 1442 show class env-stats 1508
set usb-front-panel-access-lock-config usb-front-panel-lock show class ether-pause-stats 1515
command 1443 show class ethernet-port-err-stats 1509
set usb-system-idle-power-optimizing-setting-config show class ethernet-port-multicast-stats 1510
usb-idle-power-optimizing command 1444 show class ethernet-port-stats 1512
set user 1445 show class ethernet-port-stats-by-size-large-packets 1513
set user-id command 1446 show class ethernet-port-stats-by-size-small-packets 1514
set user-label 1448 show class io-card-stats 1516

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 IN-15
Index

show class memory-array-env-stats 1517 show identity (service-profile) 1592


show class motherboard-temp-stats command 1518 show identity iqn command 1590
show class pcie-fatal-completion-error-stats 1520 show identity mac-addr 1593
show class pcie-fatal-error-stats 1521 show identity uuid 1595
show class pcie-fatal-protocol-error-stats 1522 show identity wwn 1597
show class pcie-fatal-receiving-error-stats 1523 show interface command 1599
show cli command-status command 1524 show inventory 1601
show cli history command 1525 show ipmi-user command 1604
show clock (system) 1526 show iqn-pool command 1606
show cluster state command 1527 show iscsi command 1610
show connectivity command 1528 show iscsi-policy command 1608
show console-auth command 1529 show iscsi-protocol-profile command 1609
show core-export-target command 1530 show ldap-group command 1611
show cores command 1531 show ldap-group-rule command 1613
show cpu command 1533 show local-disk-config-policy command 1614
show default-auth command 1534 show maint-policy command 1615
show destination command 1535 show member port command 1619
show disk 1537 show member-port fc command 1621
show distributed-virtual-switch 1539 show member-port fcoe command 1623
show dns command 1540 show member-port-channel command 1617
show download-task command 1541 show mgmt-if-mon-policy command 1625
show dynamic-conn-policy command 1543 show mon-src command 1627
show egress-policy 1544 show nw-ctrl-policy command 1629
show environment command 1545 show occurrence one-time command 1631
show error-recovery 1547 show occurrence recurring command 1633
show eth-classified command 1548 show password-profile command 1635
show eth-if (vnic-iscsi) command 1552 show pending-changes command 1637
show eth-if command 1550 show pooled command 1638
show eth-mon-session command 1554 show port-channel command 1640
show eth-profile command 1555 show power-budget 1642
show eth-target command 1557 show power-control-policy command 1643
show eth-uplink command 1558 show power-group command 1645
show event command 1560 show pre-login-banner command 1647
show execute-disable command 1562 show psu-policy 1648
show ext-eth-if command 1564 show rackserver-disc-policy 1649
show ext-ipv6-rss-hash command 1566 show raid-battery command 1650
show extension-key 1563 show scheduler command 1651
show fabric command 1567 show security fsm status 1653
show fabric-interconnect 1569 show sel 1654
show fabric-interconnect inventory 1570 show server actual-boot-order 1656
show fabric-interconnect mode 1571 show server adapter 1658
show fabric-port-channel command 1572 show server adapter identity 1660
show failover command 1574 show server adapter inventory 1662
show fan command 1575 show server adapter layer2 1664
show fan-module command 1577 show server adapter status 1665
show fault policy command 1579 show server boot-order 1667
show fc command 1580 show server cpu 1669
show fc-if command 1581 show server identity 1671
show fc-profile command 1582 show server status command 1673
show fc-storage command 1584 show server-host-id command 1672
show feature command 1586 show service-profile assoc command 1674
show file command 1587 show service-profile circuit command 1676
show host-port-channel command 1589 show service-profile detail command 1678
show identity (server) 1591 show service-profile expand command 1680

Cisco UCS Manager CLI Command Reference, Release 2.0


IN-16 OL-25718-02
Index

show service-profile fsm command 1682 terminal session-timeout 1720


show service-profile identity command 1684 terminal width 1721
show service-profile inventory command 1686 threshold policies 22
show service-profile status command 1689 about 22
show snmp-user command 1691 top command 1722
show sol-policy command 1692 traceroute 1723
show sshkey 1694 traffic management 25, 26, 29
show static-target-if command 1696 oversubscription 25, 26
show stats command 1697 quality of service 29
show storage-controller command 1698 system classes 29
show tech-support command 1700 virtual lanes 29
show usage command 1702
show vcenter 1704
show vcon 1705
show vcon-policy 1706
U
show vif-ns command 1707 unified fabric 2, 3
show virtual-machine 1708 about 2
show vlan-port-count command 1709 Fibre Channel 3
show vm-life-cycle-policy command 1711 unsupported tasks 38
show web-session-limits command 1712 up 1725
silver system class 29 update catalog 1726
socpe class ether-tx-stats command 827 update firmware command 1728
ssh 1713 updating templates 7
stateless computing 31 uplink ports 21, 30
about 31 flow control policies 21, 30
opt-in 31 users 43, 44
opt-out 31 CLI session limits 43
statelessness 31 web session limits 43, 44
statistics 22 UUID suffix pools 24
threshold policies 22 about 24
statistics collection policies 22
about 22
supported tasks 36
system classes 29, 30 V
best effort 29 vCons 20
bronze 29 about 20
Fibre Channel 30 vHBA SAN Connectivity policies 19
gold 29 about 19
platinum 29 vHBA templates 19
silver 29 about 19
VIC adapters 34
virtualization 34
T virtual lanes 29
virtual machines 33
tail-mgmt-log 1714 virtualization 19, 33, 34
tasks 36, 38 about 33
supported 36 converged network adapters 33
unsupported 38 NIC adapters 33
telnet 1716 VIC adapter 34
templates 7 VM lifecycle policy 19
service profiles 7 VM-FEX 33
terminal length 1718 about 33
terminal monitor 1719

Cisco UCS Manager CLI Command Reference, Release 2.0


OL-25718-02 IN-17
Index

VM lifecycle policy 19 vNICs 11


about 19 dynamic vNIC connection policy 11
VM-FEX 33
about 33
vNIC 19
policy 19
W
vNIC LAN Connectivity policies 19 web session limits 43, 44
about 19 where command 1729
vNIC templates 19 WWN pools 24
about 19 about 24
vNIC/vHBA placement policies 20 WWNN pools 24
about 20 about 24
vCons 20 WWPN pools 24
about 24

Cisco UCS Manager CLI Command Reference, Release 2.0


IN-18 OL-25718-02

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy