netscaler 9.3 command reference - citrix.com · command reference..... 17 aaa commands ... 530 cls

1957
Command Reference 2015-04-28 18:02:27 UTC © 2015 Citrix Systems, Inc. All rights reserved. Terms of Use | Trademarks | Privacy Statement

Upload: hathuan

Post on 09-Jul-2018

266 views

Category:

Documents


0 download

TRANSCRIPT

  • Command Reference

    2015-04-28 18:02:27 UTC

    2015 Citrix Systems, Inc. All rights reserved. Terms of Use | Trademarks | Privacy Statement

    http://www.citrix.com/about/legal/legal-notice.htmlhttp://www.citrix.com/about/legal/brand-guidelines.htmlhttp://www.citrix.com/about/legal/privacy.html

  • Contents

    Command Reference ......................................................................................... 17

    AAA Commands ................................................................................... 18

    aaa ............................................................................................ 19

    aaa certParams ............................................................................. 20

    aaa global .................................................................................... 22

    aaa group .................................................................................... 24

    aaa kcdAccount ............................................................................. 28

    aaa ldapParams ............................................................................. 32

    aaa parameter .............................................................................. 36

    aaa preauthenticationaction.............................................................. 39

    aaa preauthenticationparameter ........................................................ 42

    aaa preauthenticationpolicy .............................................................. 44

    aaa radiusParams ........................................................................... 47

    aaa session................................................................................... 51

    aaa stats ..................................................................................... 53

    aaa tacacsParams........................................................................... 54

    aaa user ...................................................................................... 57

    Application Commands .......................................................................... 63

    AppFlow Commands ............................................................................. 66

    appflow....................................................................................... 67

    appflow action .............................................................................. 68

    appflow collector ........................................................................... 73

    appflow global .............................................................................. 76

    appflow param .............................................................................. 78

    appflow policy............................................................................... 84

    appflow policylabel ........................................................................ 89

    Application Firewall Commands ............................................................... 93

    appfw......................................................................................... 94

    appfw JSONContentType .................................................................. 95

    2

  • appfw XMLContentType.................................................................... 97

    appfw archive ............................................................................... 99

    appfw confidField .......................................................................... 102

    appfw fieldType............................................................................. 106

    appfw global................................................................................. 109

    appfw htmlerrorpage ...................................................................... 111

    appfw learningdata......................................................................... 114

    appfw learningsettings..................................................................... 118

    appfw policy................................................................................. 123

    appfw policylabel........................................................................... 128

    appfw profile ................................................................................ 133

    appfw settings............................................................................... 186

    appfw signatures............................................................................ 190

    appfw stats .................................................................................. 193

    appfw transactionRecords................................................................. 194

    appfw wsdl................................................................................... 195

    appfw xmlerrorpage........................................................................ 197

    appfw xmlschema .......................................................................... 200

    AppQoE Commands .............................................................................. 202

    appqoe ....................................................................................... 203

    appqoe CustomResp ........................................................................ 204

    appqoe action ............................................................................... 206

    appqoe parameter.......................................................................... 212

    appqoe policy ............................................................................... 215

    appqoe stats................................................................................. 218

    Audit Commands ................................................................................. 219

    audit .......................................................................................... 220

    audit messageaction ....................................................................... 221

    audit messages .............................................................................. 225

    audit nslogAction ........................................................................... 226

    audit nslogParams .......................................................................... 233

    audit nslogPolicy............................................................................ 237

    audit stats ................................................................................... 240

    audit syslogAction .......................................................................... 241

    audit syslogParams ......................................................................... 248

    audit syslogPolicy........................................................................... 252

    Authentication Commands...................................................................... 255

    3

  • authentication Policy ...................................................................... 256

    authentication authnProfile............................................................... 261

    authentication certAction ................................................................. 265

    authentication certPolicy ................................................................. 269

    authentication ldapAction................................................................. 272

    authentication ldapPolicy ................................................................. 282

    authentication localPolicy................................................................. 285

    authentication negotiateAction .......................................................... 288

    authentication negotiatePolicy........................................................... 292

    authentication policylabel ................................................................ 295

    authentication radiusAction .............................................................. 300

    authentication radiusPolicy ............................................................... 307

    authentication samlAction ................................................................ 310

    authentication samlIdPPolicy ............................................................. 324

    authentication samlIdPProfile ............................................................ 330

    authentication samlPolicy................................................................. 335

    authentication tacacsAction .............................................................. 338

    authentication tacacsPolicy............................................................... 343

    authentication vserver..................................................................... 346

    authentication webAuthAction ........................................................... 355

    authentication webAuthPolicy............................................................ 363

    Authorization Commands ....................................................................... 366

    authorization action........................................................................ 367

    authorization policy ........................................................................ 368

    authorization policylabel .................................................................. 372

    AutoScale Commands............................................................................ 377

    autoscale action ............................................................................ 378

    autoscale policy............................................................................. 382

    autoscale profile............................................................................ 387

    Basic Commands.................................................................................. 390

    configstatus.................................................................................. 391

    dbsMonitors .................................................................................. 392

    location ...................................................................................... 393

    locationData ................................................................................. 396

    locationFile .................................................................................. 397

    locationParameter.......................................................................... 399

    nstrace ....................................................................................... 402

    4

  • reporting ..................................................................................... 412

    server......................................................................................... 414

    service........................................................................................ 421

    serviceGroup ................................................................................ 439

    serviceGroupMember....................................................................... 456

    servicegroupbindings....................................................................... 457

    svcbindings................................................................................... 458

    uiinternal .................................................................................... 459

    vserver ....................................................................................... 462

    Content Accelerator Commands ............................................................... 463

    ca.............................................................................................. 464

    ca action ..................................................................................... 465

    ca global ..................................................................................... 469

    ca policy ..................................................................................... 471

    ca stats ....................................................................................... 475

    Cache Commands ................................................................................ 476

    cache ......................................................................................... 477

    cache contentGroup........................................................................ 478

    cache forwardProxy ........................................................................ 495

    cache global ................................................................................. 497

    cache object................................................................................. 499

    cache parameter............................................................................ 504

    cache policy ................................................................................. 507

    cache policylabel ........................................................................... 513

    cache selector............................................................................... 518

    cache stats................................................................................... 521

    CLI Commands .................................................................................... 522

    alias........................................................................................... 523

    backup........................................................................................ 524

    batch ......................................................................................... 525

    cli attribute.................................................................................. 526

    cli mode...................................................................................... 527

    cli prompt.................................................................................... 530

    cls ............................................................................................. 532

    config ......................................................................................... 533

    exit............................................................................................ 534

    help ........................................................................................... 535

    5

  • history ........................................................................................ 537

    man ........................................................................................... 538

    quit ........................................................................................... 539

    source ........................................................................................ 540

    unalias ........................................................................................ 541

    whoami ....................................................................................... 542

    Cluster Commands ............................................................................... 543

    cluster ........................................................................................ 544

    cluster files .................................................................................. 545

    cluster instance ............................................................................. 548

    cluster node ................................................................................. 555

    cluster nodegroup .......................................................................... 561

    cluster sync .................................................................................. 567

    Compression Commands ........................................................................ 568

    cmp ........................................................................................... 569

    cmp action................................................................................... 570

    cmp global ................................................................................... 576

    cmp parameter.............................................................................. 579

    cmp policy ................................................................................... 583

    cmp policylabel ............................................................................. 589

    cmp stats..................................................................................... 594

    Cache Redirection Commands.................................................................. 595

    cr policy ...................................................................................... 596

    cr vserver .................................................................................... 599

    Content Switching Commands.................................................................. 617

    cs action ..................................................................................... 618

    cs parameter ................................................................................ 622

    cs policy...................................................................................... 624

    cs policylabel................................................................................ 629

    cs vserver .................................................................................... 635

    DB Commands..................................................................................... 659

    db dbProfile ................................................................................. 660

    db user ....................................................................................... 665

    DNS Commands ................................................................................... 668

    dns ............................................................................................ 670

    dns aaaaRec ................................................................................. 671

    dns action.................................................................................... 674

    6

  • dns action64 ................................................................................. 678

    dns addRec................................................................................... 682

    dns cnameRec ............................................................................... 685

    dns global .................................................................................... 688

    dns key ....................................................................................... 690

    dns mxRec ................................................................................... 696

    dns nameServer ............................................................................. 700

    dns naptrRec ................................................................................ 704

    dns nsRec .................................................................................... 708

    dns nsecRec.................................................................................. 710

    dns parameter............................................................................... 711

    dns policy .................................................................................... 715

    dns policy64 ................................................................................. 720

    dns policylabel .............................................................................. 724

    dns proxyRecords ........................................................................... 729

    dns ptrRec ................................................................................... 730

    dns records .................................................................................. 733

    dns soaRec ................................................................................... 734

    dns srvRec.................................................................................... 740

    dns stats...................................................................................... 744

    dns suffix..................................................................................... 745

    dns txtRec ................................................................................... 747

    dns view...................................................................................... 750

    dns zone...................................................................................... 752

    DOS Commands ................................................................................... 757

    dos ............................................................................................ 758

    dos policy .................................................................................... 759

    dos stats...................................................................................... 763

    Event Commands ................................................................................. 764

    Front End Optimization ......................................................................... 768

    feo ............................................................................................ 769

    feo action .................................................................................... 770

    feo global .................................................................................... 775

    feo parameter............................................................................... 777

    feo policy .................................................................................... 780

    feo stats...................................................................................... 783

    Filter Commands ................................................................................. 784

    7

  • filter action.................................................................................. 785

    filter global .................................................................................. 790

    filter htmlinjectionparameter ............................................................ 792

    filter htmlinjectionvariable ............................................................... 794

    filter policy .................................................................................. 797

    filter postbodyInjection ................................................................... 801

    filter prebodyInjection..................................................................... 803

    GSLB Commands.................................................................................. 805

    gslb config ................................................................................... 806

    gslb domain.................................................................................. 808

    gslb ldnsentries ............................................................................. 809

    gslb ldnsentry ............................................................................... 810

    gslb parameter .............................................................................. 811

    gslb runningConfig .......................................................................... 814

    gslb service .................................................................................. 815

    gslb site ...................................................................................... 826

    gslb syncStatus .............................................................................. 833

    gslb vserver .................................................................................. 834

    HA Commands .................................................................................... 851

    HA failover................................................................................... 852

    HA files ....................................................................................... 853

    HA node ...................................................................................... 854

    HA sync....................................................................................... 861

    IPSec Commands ................................................................................. 863

    ipsec counters............................................................................... 864

    ipsec parameter ............................................................................ 865

    ipsec profile ................................................................................. 868

    LB Commands ..................................................................................... 871

    lb group ...................................................................................... 872

    lb metricTable .............................................................................. 878

    lb monbindings .............................................................................. 882

    lb monitor.................................................................................... 883

    lb parameter ................................................................................ 913

    lb persistentSessions ....................................................................... 917

    lb route....................................................................................... 919

    lb route6 ..................................................................................... 922

    lb sipParameters ............................................................................ 924

    8

  • lb vserver .................................................................................... 927

    LLDP Commands .................................................................................. 967

    lldp............................................................................................ 968

    lldp neighbors ............................................................................... 969

    lldp param ................................................................................... 970

    lldp stats ..................................................................................... 972

    Networking Commands .......................................................................... 973

    L3Param...................................................................................... 975

    L4Param...................................................................................... 979

    Networking Commands..................................................................... 981

    arp ............................................................................................ 983

    arpparam..................................................................................... 987

    bridge......................................................................................... 989

    bridgegroup.................................................................................. 990

    bridgetable .................................................................................. 995

    channel....................................................................................... 998

    ci .............................................................................................. 1008

    fis ............................................................................................. 1009

    forwardingSession .......................................................................... 1012

    inat............................................................................................ 1015

    inatparam.................................................................................... 1021

    inatsession ................................................................................... 1024

    interface ..................................................................................... 1025

    interfacePair ................................................................................ 1036

    ip6Tunnel .................................................................................... 1038

    ip6TunnelParam............................................................................. 1041

    ipTunnel...................................................................................... 1043

    ipTunnelParam .............................................................................. 1046

    ipset .......................................................................................... 1049

    ipv6 ........................................................................................... 1053

    lacp ........................................................................................... 1056

    linkset ........................................................................................ 1058

    nat64 ......................................................................................... 1061

    nd6 ............................................................................................ 1065

    nd6RAvariables.............................................................................. 1069

    netProfile .................................................................................... 1075

    netbridge..................................................................................... 1079

    9

  • onLinkIPv6Prefix ............................................................................ 1083

    ptp ............................................................................................ 1088

    rnat ........................................................................................... 1089

    rnat6 .......................................................................................... 1092

    rnatglobal .................................................................................... 1097

    rnatip ......................................................................................... 1099

    rnatparam.................................................................................... 1100

    route.......................................................................................... 1102

    route6 ........................................................................................ 1109

    rsskeytype ................................................................................... 1116

    tunnelip ...................................................................................... 1117

    tunnelip6..................................................................................... 1118

    vPathParam.................................................................................. 1119

    vlan ........................................................................................... 1121

    vpath ......................................................................................... 1128

    vrID............................................................................................ 1131

    vrID6 .......................................................................................... 1138

    vrIDParam.................................................................................... 1142

    vxlan .......................................................................................... 1144

    NS Commands..................................................................................... 1150

    ns.............................................................................................. 1153

    ns acl ......................................................................................... 1154

    ns acl6 ........................................................................................ 1165

    ns acls ........................................................................................ 1176

    ns acls6....................................................................................... 1178

    ns aptlicense ................................................................................ 1180

    ns assignment ............................................................................... 1182

    ns config ..................................................................................... 1186

    ns connectiontable ......................................................................... 1196

    ns consoleloginprompt ..................................................................... 1204

    ns dhcpIp..................................................................................... 1206

    ns dhcpParams .............................................................................. 1207

    ns diameter .................................................................................. 1209

    ns encryptionParams ....................................................................... 1211

    ns events ..................................................................................... 1213

    ns feature .................................................................................... 1214

    ns hardware ................................................................................. 1216

    10

  • ns hostName................................................................................. 1217

    ns httpParam ................................................................................ 1219

    ns httpProfile................................................................................ 1222

    ns info ........................................................................................ 1232

    ns ip........................................................................................... 1234

    ns ip6 ......................................................................................... 1249

    ns license .................................................................................... 1259

    ns limitIdentifier............................................................................ 1260

    ns limitSessions ............................................................................. 1267

    ns memory ................................................................................... 1269

    ns mode ...................................................................................... 1270

    ns ns.conf .................................................................................... 1272

    ns param ..................................................................................... 1273

    ns pbr ......................................................................................... 1282

    ns pbr6 ....................................................................................... 1292

    ns pbrs........................................................................................ 1303

    ns rateControl ............................................................................... 1305

    ns rollbackcmd .............................................................................. 1307

    ns rpcNode................................................................................... 1308

    ns runningConfig ............................................................................ 1311

    ns savedConfig .............................................................................. 1312

    ns simpleacl ................................................................................. 1313

    ns simpleacl6 ................................................................................ 1317

    ns spParams.................................................................................. 1321

    ns stats ....................................................................................... 1323

    ns surgeQ..................................................................................... 1324

    ns tcpParam ................................................................................. 1325

    ns tcpProfile ................................................................................. 1334

    ns tcpbufParam ............................................................................. 1351

    ns timeout ................................................................................... 1353

    ns timer ...................................................................................... 1357

    ns trafficDomain ............................................................................ 1362

    ns variable ................................................................................... 1369

    ns version .................................................................................... 1374

    ns weblogparam............................................................................. 1375

    ns xmlnamespace ........................................................................... 1377

    reboot ........................................................................................ 1380

    11

  • shutdown..................................................................................... 1381

    NTP Commands ................................................................................... 1382

    ntp param.................................................................................... 1383

    ntp server .................................................................................... 1385

    ntp status .................................................................................... 1389

    ntp sync ...................................................................................... 1390

    Policy Commands................................................................................. 1391

    policy dataset ............................................................................... 1392

    policy expression ........................................................................... 1396

    policy httpCallout .......................................................................... 1400

    policy map ................................................................................... 1408

    policy patset................................................................................. 1411

    policy stringmap ............................................................................ 1415

    PQ Commands .................................................................................... 1420

    pq ............................................................................................. 1421

    pq policy ..................................................................................... 1422

    pq stats....................................................................................... 1428

    Protocol Commands.............................................................................. 1429

    protocol http ................................................................................ 1430

    protocol httpBand .......................................................................... 1431

    protocol icmp ............................................................................... 1433

    protocol icmpv6............................................................................. 1434

    protocol ip ................................................................................... 1435

    protocol ipv6 ................................................................................ 1436

    protocol tcp ................................................................................. 1437

    protocol udp................................................................................. 1438

    QOS Commands................................................................................... 1439

    qos ............................................................................................ 1440

    qos stats...................................................................................... 1441

    Responder Commands ........................................................................... 1442

    responder action............................................................................ 1443

    responder global ............................................................................ 1449

    responder htmlpage ........................................................................ 1452

    responder param............................................................................ 1455

    responder policy ............................................................................ 1457

    responder policylabel ...................................................................... 1463

    Rewrite Commands .............................................................................. 1468

    12

  • rewrite action ............................................................................... 1469

    rewrite global ............................................................................... 1478

    rewrite param............................................................................... 1481

    rewrite policy ............................................................................... 1483

    rewrite policylabel ......................................................................... 1490

    RISE Commands................................................................................... 1496

    rise apbrSvc.................................................................................. 1497

    rise param ................................................................................... 1498

    rise profile ................................................................................... 1500

    rise rhi........................................................................................ 1501

    Router Commands................................................................................ 1502

    router dynamicRouting .................................................................... 1503

    vtysh .......................................................................................... 1504

    SC Commands ..................................................................................... 1505

    sc .............................................................................................. 1506

    sc parameter ................................................................................ 1507

    sc policy...................................................................................... 1509

    sc stats ....................................................................................... 1515

    SNMP Commands ................................................................................. 1516

    snmp .......................................................................................... 1517

    snmp alarm .................................................................................. 1518

    snmp community............................................................................ 1528

    snmp engineId............................................................................... 1531

    snmp group .................................................................................. 1533

    snmp manager............................................................................... 1537

    snmp mib..................................................................................... 1541

    snmp oid ..................................................................................... 1544

    snmp option ................................................................................. 1545

    snmp stats ................................................................................... 1547

    snmp trap .................................................................................... 1548

    snmp user .................................................................................... 1557

    snmp view.................................................................................... 1561

    Spillover Commands ............................................................................. 1564

    spillover action.............................................................................. 1565

    spillover policy .............................................................................. 1568

    SSL Commands.................................................................................... 1573

    ssl ............................................................................................. 1575

    13

  • ssl action ..................................................................................... 1576

    ssl cert........................................................................................ 1580

    ssl certChain................................................................................. 1583

    ssl certFile ................................................................................... 1584

    ssl certKey ................................................................................... 1586

    ssl certLink................................................................................... 1595

    ssl certReq ................................................................................... 1596

    ssl cipher ..................................................................................... 1599

    ssl ciphersuite ............................................................................... 1604

    ssl crl ......................................................................................... 1605

    ssl crlFile..................................................................................... 1614

    ssl dhFile ..................................................................................... 1616

    ssl dhParam.................................................................................. 1618

    ssl dsaKey .................................................................................... 1619

    ssl dtlsProfile ................................................................................ 1621

    ssl fips ........................................................................................ 1626

    ssl fipsKey.................................................................................... 1629

    ssl fipsSIMSource ............................................................................ 1634

    ssl fipsSIMTarget ............................................................................ 1636

    ssl global ..................................................................................... 1638

    ssl keyFile.................................................................................... 1640

    ssl ocspResponder .......................................................................... 1642

    ssl parameter................................................................................ 1648

    ssl pkcs12 .................................................................................... 1653

    ssl pkcs8...................................................................................... 1655

    ssl policy ..................................................................................... 1657

    ssl policylabel ............................................................................... 1662

    ssl profile .................................................................................... 1666

    ssl rsakey..................................................................................... 1681

    ssl service .................................................................................... 1683

    ssl serviceGroup............................................................................. 1691

    ssl stats....................................................................................... 1696

    ssl vserver.................................................................................... 1697

    ssl wrapkey .................................................................................. 1705

    Stream Commands ............................................................................... 1707

    stream identifier............................................................................ 1708

    stream selector ............................................................................. 1714

    14

  • stream session............................................................................... 1717

    System Commands ............................................................................... 1718

    system ........................................................................................ 1719

    system backup .............................................................................. 1720

    system bw.................................................................................... 1723

    system cmdPolicy........................................................................... 1724

    system collectionparam ................................................................... 1727

    system core.................................................................................. 1729

    system countergroup....................................................................... 1730

    system counters............................................................................. 1731

    system cpu................................................................................... 1732

    system dataSource.......................................................................... 1733

    system entity ................................................................................ 1734

    system entitydata .......................................................................... 1735

    system entitytype .......................................................................... 1738

    system eventhistory ........................................................................ 1739

    system global................................................................................ 1740

    system globaldata .......................................................................... 1742

    system group ................................................................................ 1744

    system memory ............................................................................. 1749

    system parameter .......................................................................... 1750

    system session............................................................................... 1753

    system user .................................................................................. 1755

    TM Commands .................................................................................... 1760

    tm formSSOAction .......................................................................... 1761

    tm global..................................................................................... 1766

    tm samlSSOProfile .......................................................................... 1768

    tm sessionAction ............................................................................ 1773

    tm sessionParameter ....................................................................... 1778

    tm sessionPolicy ............................................................................ 1781

    tm trafficAction............................................................................. 1785

    tm trafficPolicy ............................................................................. 1790

    Transform Commands ........................................................................... 1794

    transform action ............................................................................ 1795

    transform global ............................................................................ 1799

    transform policy ............................................................................ 1802

    transform policylabel ...................................................................... 1808

    15

  • transform profile ........................................................................... 1813

    Tunnel Commands ............................................................................... 1816

    tunnel global ................................................................................ 1817

    tunnel trafficPolicy......................................................................... 1819

    Utility Commands ................................................................................ 1823

    callhome ..................................................................................... 1824

    grep ........................................................................................... 1826

    install ......................................................................................... 1828

    nstrace ....................................................................................... 1829

    ping ........................................................................................... 1832

    ping6.......................................................................................... 1834

    scp ............................................................................................ 1836

    shell........................................................................................... 1837

    techsupport.................................................................................. 1838

    traceroute ................................................................................... 1839

    traceroute6 .................................................................................. 1842

    VPN Commands ................................................................................... 1845

    vpn ............................................................................................ 1846

    vpn clientlessAccessPolicy ................................................................ 1847

    vpn clientlessAccessProfile................................................................ 1850

    vpn formSSOAction ......................................................................... 1854

    vpn global.................................................................................... 1859

    vpn icaConnection .......................................................................... 1862

    vpn intranetApplication ................................................................... 1863

    vpn nextHopServer ......................................................................... 1866

    vpn parameter .............................................................................. 1869

    vpn samlSSOProfile ......................................................................... 1882

    vpn sessionAction ........................................................................... 1886

    vpn sessionPolicy ........................................................................... 1908

    vpn stats ..................................................................................... 1911

    vpn trafficAction............................................................................ 1912

    vpn trafficPolicy ............................................................................ 1917

    vpn url ........................................................................................ 1921

    vpn vserver .................................................................................. 1925

    WI Commands..................................................................................... 1941

    wi package................................................................................... 1942

    wi site ........................................................................................ 1944

    16

  • 17

    Command Reference

    Provides basic information of the NetScaler command line interface and also provides thecommands to configure and retrieve details of the appliance.

  • 18

    AAA Commands

    This group of commands can be used to perform operations on the following entities:

    aaa

    aaa certParams

    aaa global

    aaa group

    aaa kcdAccount

    aaa ldapParams

    aaa parameter

    aaa preauthenticationaction

    aaa preauthenticationparameter

    aaa preauthenticationpolicy

    aaa radiusParams

    aaa session

    aaa stats

    aaa tacacsParams

    aaa user

  • 19

    aaa

    stat aaaSynopsis

    stat aaa [-detail] [-fullValues] [-ntimes ] [-logFile ][-clearstats ( basic | full )]

    DescriptionDisplay aaa statistics

    Parametersclearstats

    Clear the statsistics / counters

    Possible values: basic, full

  • 20

    aaa certParams

    [ set | unset | show ]

    set aaa certParamsSynopsis

    set aaa certParams [-userNameField ] [-groupNameField ][-defaultAuthenticationGroup ]

    DescriptionModifies the global configuration settings for certificate policies.

    The settings that you specify are used for all SSL-VPN virtual servers unless you useauthentication policies to create a configuration for a specific SSL-VPN virtual server.

    ParametersuserNameField

    Client certificate field that contains the username, in the format :.

    groupNameField

    Client certificate field that specifies the group, in the format :.

    defaultAuthenticationGroup

    This is the default group that is chosen when the authentication succeeds in addition toextracted groups.

    Maximum value: 64

    Example

    To configure the default certificate parameters: set aaa certparams -userNameField "Subject:CN" -groupNameField "Subject:OU"

    Top

    http://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-certparams-ref.html#netscaler-crg-set-aaa-certparamshttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-certparams-ref.html#netscaler-crg-unset-aaa-certparamshttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-certparams-ref.html#netscaler-crg-show-aaa-certparams

  • unset aaa certParamsSynopsis

    unset aaa certParams [-userNameField] [-groupNameField] [-defaultAuthenticationGroup]

    DescriptionUse this command to remove aaa certParams settings.Refer to the set aaa certParamscommand for meanings of the arguments.

    Top

    show aaa certParamsSynopsis

    show aaa certParams

    DescriptionDisplays the current client certificate configuration on the NetScaler appliance.

    Top

    aaa certParams

    21

  • 22

    aaa global

    [ bind | unbind | show ]

    bind aaa globalSynopsis

    bind aaa global [-policy [-priority ]] [-windowsProfile ]

    DescriptionBinds a policy globally.

    Parameterspolicy

    Name of the policy to bind globally.

    windowsProfile

    Name of the negotiate profile to bind globally.

    Example

    bind aaa global -pol pol1

    Top

    unbind aaa globalSynopsis

    unbind aaa global [-policy ] [-windowsProfile ]

    DescriptionUnbind the policy from the global bind point.

    http://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-global-ref.html#netscaler-crg-bind-aaa-globalhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-global-ref.html#netscaler-crg-unbind-aaa-globalhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-global-ref.html#netscaler-crg-show-aaa-global

  • Parameterspolicy

    Name of the policy to be unbound.

    windowsProfile

    Name of the negotiate profile to be bound.

    Top

    show aaa globalSynopsis

    show aaa global

    DescriptionDisplays a list of policies that are currently bound to Global on the NetScaler appliance.

    Top

    aaa global

    23

  • 24

    aaa group

    [ add | rm | bind | unbind | show ]

    add aaa groupSynopsis

    add aaa group

    DescriptionCreates a AAA group and verifies the configuration to ensure that it is correct.

    ParametersgroupName

    Name for the group. Must begin with a letter, number, or the underscore character (_),and must consist only of letters, numbers, and the hyphen (-), period (.) pound (#), space( ), at sign (@), equals (=), colon (:), and underscore characters. Cannot be changed afterthe group is added.

    The following requirement applies only to the NetScaler CLI:

    If the name includes one or more spaces, enclose the name in double or

    single quotation marks (for example, "my aaa group" or 'my aaa

    group).

    Example

    add aaa group group_ad

    Top

    rm aaa groupSynopsis

    rm aaa group

    http://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-group-ref.html#netscaler-crg-add-aaa-grouphttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-group-ref.html#netscaler-crg-rm-aaa-grouphttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-group-ref.html#netscaler-crg-bind-aaa-grouphttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-group-ref.html#netscaler-crg-unbind-aaa-grouphttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-group-ref.html#netscaler-crg-show-aaa-group

  • DescriptionRemoves the specified AAA group.

    ParametersgroupName

    Name of the group that you are removing.

    Top

    bind aaa groupSynopsis

    bind aaa group [-userName ] [-policy [-priority]] [-intranetApplication ] [-urlName ] [-intranetIP ]

    DescriptionBinds the specified AAA group to the specified resource.

    The resource can be a user, an Intranet IP address or range, a policy, or an Intranetapplication.

    ParametersgroupName

    Name of the group that you are binding.

    userName

    Bind a AAA group to the specified AAA user.

    If the specified user is bound to more than one group, the group expressions areevaluated, upon authorization, to determine the appropriate action.

    policy

    Bind a policy to the specified AAA group.

    intranetApplication

    Bind the group to the specified intranet VPN application.

    urlName

    Bind the group to the specified URL.

    aaa group

    25

  • intranetIP

    Bind the group to the specified IP address or IP block.

    Normally you would bind the group to an IP address or range that your users use toaccess intranet resources.

    Example

    To bind an Intranet IP to the group engg: bind aaa group engg -intranetip 10.102.10.0 255.255.255.0

    Top

    unbind aaa groupSynopsis

    unbind aaa group [-userName ...] [-policy ][-intranetApplication ] [-urlName ] [-intranetIP ]

    DescriptionUnbinds the specified AAA group from the specified resource.

    The resource can be a user, an intranet IP address or range, a policy, or an intranetapplication.

    ParametersgroupName

    Name of the group that you are unbinding.

    userName

    Unbind the specified AAA group from the specified AAA user.

    policy

    Unbind the specified policy from the specified AAA group.

    intranetApplication

    Unbind the specified group from the specified intranet VPN application.

    urlName

    Unbind the specified group from the specified URL.

    intranetIP

    aaa group

    26

  • Unbind the specified group from the specified IP address or IP block.

    Example

    unbind aaa group engg -intranetip 10.102.10.0 255.255.255.0

    Top

    show aaa groupSynopsis

    show aaa group [] [-loggedIn]

    DescriptionDisplays the current configuration of a AAA group.

    ParametersgroupName

    Name of the group.

    loggedIn

    Display only the group members who are currently logged in.

    Example

    > show aaa group engg GroupName: engg

    Bound AAA users: UserName: joe UserName: jane

    Intranetip IP: 10.102.10.0 Netmask: 255.255.255.0 Done>

    Top

    aaa group

    27

  • 28

    aaa kcdAccount

    [ add | rm | set | unset | show ]

    add aaa kcdAccountSynopsis

    add aaa kcdAccount {-keytab } {-realmStr } {-delegatedUser} {-kcdPassword } {-usercert } {-cacert } [-userRealm ][-enterpriseRealm ] [-serviceSPN ]

    DescriptionAdd a Kerberos constrained delegation account.

    ParameterskcdAccount

    The name of the KCD account.

    keytab

    The path to the keytab file. If specified other parameters in this command need not begiven

    realmStr

    Kerberos Realm.

    delegatedUser

    Username that can perform kerberos constrained delegation.

    kcdPassword

    Password for Delegated User.

    usercert

    SSL Cert (including private key) for Delegated User.

    cacert

    CA Cert for UserCert or when doing PKINIT backchannel.

    http://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-kcdaccount-ref.html#netscaler-crg-add-aaa-kcdaccounthttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-kcdaccount-ref.html#netscaler-crg-rm-aaa-kcdaccounthttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-kcdaccount-ref.html#netscaler-crg-set-aaa-kcdaccounthttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-kcdaccount-ref.html#netscaler-crg-unset-aaa-kcdaccounthttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-kcdaccount-ref.html#netscaler-crg-show-aaa-kcdaccount

  • userRealm

    Realm of the user

    enterpriseRealm

    Enterprise Realm of the user. This should be given only in certain KDC deploymentswhere KDC expects Enterprise username instead of Principal Name

    serviceSPN

    Service SPN. When specified, this will be used to fetch kerberos tickets. If not specified,Netscaler will construct SPN using service fqdn

    Example

    add aaa kcdaccount my_kcd_acct -keytab /var/mykcd.keytabadd aaa kcdaccount my_kcd_acct -keytabThe above example adds a Kerberos constrained delegation account my_kcd_acct, with the keytab file located at /var/mykcd.keytab

    Top

    rm aaa kcdAccountSynopsis

    rm aaa kcdAccount

    DescriptionRemove the KCD account.

    ParameterskcdAccount

    The KCD account name.

    Top

    set aaa kcdAccountSynopsis

    set aaa kcdAccount [-keytab ] [-realmStr ] [-delegatedUser] [-kcdPassword ] [-usercert ] [-cacert ] [-userRealm ][-enterpriseRealm ] [-serviceSPN ]

    aaa kcdAccount

    29

  • DescriptionSet the KCD account information.

    ParameterskcdAccount

    The name of the KCD account.

    keytab

    The path to the keytab file. If specified other parameters in this command need not begiven

    realmStr

    Kerberos Realm.

    delegatedUser

    Username that can perform kerberos constrained delegation.

    kcdPassword

    Password for Delegated User.

    usercert

    SSL Cert (including private key) for Delegated User.

    cacert

    CA Cert for UserCert or when doing PKINIT backchannel.

    userRealm

    Realm of the user

    enterpriseRealm

    Enterprise Realm of the user. This should be given only in certain KDC deploymentswhere KDC expects Enterprise username instead of Principal Name

    serviceSPN

    Service SPN. When specified, this will be used to fetch kerberos tickets. If not specified,Netscaler will construct SPN using service fqdn

    Example

    set aaa kcdaccount my_kcd_acct -keytab /var/hiskcd.keytabThe above command sets the keytab location for KCD account my_kcd_acct to /var/hiskcd.keytab

    aaa kcdAccount

    30

  • Top

    unset aaa kcdAccountSynopsis

    unset aaa kcdAccount [-usercert] [-cacert] [-userRealm] [-enterpriseRealm][-serviceSPN]

    DescriptionUnset the KCD account information..Refer to the set aaa kcdAccount command formeanings of the arguments.

    Top

    show aaa kcdAccountSynopsis

    show aaa kcdAccount []

    DescriptionDisplay KCD accounts.

    ParameterskcdAccount

    The KCD account name.

    Example

    Example> show aaa kcdaccount my_kcd_acct KcdAccount: my_kcd_acct Keytab: /var/mykcd.keytab Done>

    Top

    aaa kcdAccount

    31

  • 32

    aaa ldapParams

    [ set | unset | show ]

    set aaa ldapParamsSynopsis

    set aaa ldapParams [-serverIP ] [-serverPort ] [-authTimeout] [-ldapBase ] [-ldapBindDn ] {-ldapBindDnPassword }[-ldapLoginName ] [-searchFilter ] [-groupAttrName ][-subAttributeName ] [-secType ] [-svrType ( AD | NDS )][-ssoNameAttribute ] [-passwdChange ( ENABLED | DISABLED )][-nestedGroupExtraction ( ON | OFF )] [-maxNestingLevel ][-groupNameIdentifier ] [-groupSearchAttribute [-groupSearchSubAttribute]] [-groupSearchFilter ] [-defaultAuthenticationGroup ]

    DescriptionModifies the global configuration settings for the LDAP server.

    The settings that you specify are used for all SSL-VPN virtual servers unless you useauthentication policies to create a configuration for a specific SSL-VPN virtual server.

    ParametersserverIP

    IP address of your LDAP server.

    serverPort

    Port number on which the LDAP server listens for connections.

    Default value: 389

    Minimum value: 1

    authTimeout

    Maximum number of seconds that the NetScaler appliance waits for a response from theLDAP server.

    Default value: 3

    Minimum value: 1

    http://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-ldapparams-ref.html#netscaler-crg-set-aaa-ldapparamshttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-ldapparams-ref.html#netscaler-crg-unset-aaa-ldapparamshttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-ldapparams-ref.html#netscaler-crg-show-aaa-ldapparams

  • ldapBase

    Base (the server and location) from which LDAP search commands should start.

    If the LDAP server is running locally, the default value of base is dc=netscaler, dc=com.

    ldapBindDn

    Complete distinguished name (DN) string used for binding to the LDAP server.

    ldapBindDnPassword

    Password for binding to the LDAP server.

    ldapLoginName

    Name attribute that the NetScaler appliance uses to query the external LDAP server oran Active Directory.

    searchFilter

    String to be combined with the default LDAP user search string to form the value to usewhen executing an LDAP search.

    For example, the following values:

    vpnallowed=true,

    ldaploginame=""samaccount""

    when combined with the user-supplied username ""bob"", yield the following LDAP searchstring:

    ""(&(vpnallowed=true)(samaccount=bob)""

    groupAttrName

    Attribute name used for group extraction from the LDAP server.

    subAttributeName

    Subattribute name used for group extraction from the LDAP server.

    secType

    Type of security used for communications between the NetScaler appliance and the LDAPserver. For the PLAINTEXT setting, no encryption is required.

    Possible values: PLAINTEXT, TLS, SSL

    Default value: AAA_LDAP_PLAINTEXT

    svrType

    The type of LDAP server.

    aaa ldapParams

    33

  • Possible values: AD, NDS

    Default value: AAA_LDAP_SERVER_TYPE_DEFAULT

    ssoNameAttribute

    Attribute used by the NetScaler appliance to query an external LDAP server or ActiveDirectory for an alternative username.

    This alternative username is then used for single sign-on (SSO).

    passwdChange

    Accept password change requests.

    Possible values: ENABLED, DISABLED

    Default value: DISABLED

    nestedGroupExtraction

    Queries the external LDAP server to determine whether the specified group belongs toanother group.

    Possible values: ON, OFF

    Default value: OFF

    defaultAuthenticationGroup

    This is the default group that is chosen when the authentication succeeds in addition toextracted groups.

    Maximum value: 64

    Example

    To configure authentication in the LDAP server running at 192.40.1.2:set aaa ldapparams -serverip 192.40.1.2 -ldapbase "dc=netscaler,dc=com" -ldapBindDN "cn=Manager,dc=netscaler,dc=com" -ldapBindDnPassword secret -ldaploginname uid

    Top

    aaa ldapParams

    34

  • unset aaa ldapParamsSynopsis

    unset aaa ldapParams [-serverIP] [-serverPort] [-authTimeout] [-ldapBase] [-ldapBindDn][-ldapBindDnPassword] [-ldapLoginName] [-searchFilter] [-groupAttrName][-subAttributeName] [-secType] [-svrType] [-ssoNameAttribute] [-passwdChange][-nestedGroupExtraction] [-maxNestingLevel] [-groupNameIdentifier][-groupSearchAttribute] [-groupSearchSubAttribute] [-groupSearchFilter][-defaultAuthenticationGroup]

    DescriptionUse this command to remove aaa ldapParams settings.Refer to the set aaa ldapParamscommand for meanings of the arguments.

    Top

    show aaa ldapParamsSynopsis

    show aaa ldapParams

    DescriptionDisplays the current LDAP configuration on the NetScaler appliance.

    Example

    > show aaa ldapparamsConfigured LDAP parameters Server IP: 127.0.0.1 Port: 389 Timeout: 1 BindDn: cn=Manager,dc=florazel,dc=com login: uid Base: dc=florazel,dc=com Secure Type: PLAINTEXTDone>

    Top

    aaa ldapParams

    35

  • 36

    aaa parameter

    [ set | unset | show ]

    set aaa parameterSynopsis

    set aaa parameter [-enableStaticPageCaching ( YES | NO )] [-enableEnhancedAuthFeedback( YES | NO )] [-defaultAuthType ] [-maxAAAUsers ][-maxLoginAttempts [-failedLoginTimeout ]] [-aaadnatIp] [-enableSessionStickiness ( YES | NO )]

    DescriptionSets the global AAA configuration. Any configuration settings made at this level overridesconfiguration settings for the authentication server.

    ParametersenableStaticPageCaching

    The default state of VPN Static Page caching. If nothing is specified, the default value isset to YES.

    Possible values: YES, NO

    Default value: STATIC_PAGE_CACHING_ENABLED

    enableEnhancedAuthFeedback

    Enhanced auth feedback provides more information to the end user about the reason foran authentication failure. The default value is set to NO.

    Possible values: YES, NO

    Default value: ENHANCED_AUTH_FEEDBACK_DISABLED

    defaultAuthType

    The default authentication server type.

    Possible values: LOCAL, LDAP, RADIUS, TACACS, CERT

    http://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-parameter-ref.html#netscaler-crg-set-aaa-parameterhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-parameter-ref.html#netscaler-crg-unset-aaa-parameterhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-parameter-ref.html#netscaler-crg-show-aaa-parameter

  • Default value: LOCAL_AUTH

    maxAAAUsers

    Maximum number of concurrent users allowed to log on to VPN simultaneously.

    Minimum value: 1

    maxLoginAttempts

    Maximum Number of login Attempts

    Minimum value: 1

    aaadnatIp

    Source IP address to use for traffic that is sent to the authentication server.

    enableSessionStickiness

    Enables/Disables stickiness to authentication servers

    Possible values: YES, NO

    Default value: SESSION_STICKINESS_DISABLED

    Example

    set aaa parameter -defaultAuthType RADIUS -maxAAAUSers 100

    Top

    unset aaa parameterSynopsis

    unset aaa parameter [-enableStaticPageCaching] [-enableEnhancedAuthFeedback][-defaultAuthType] [-maxAAAUsers] [-aaadnatIp] [-maxLoginAttempts][-enableSessionStickiness]

    DescriptionResets the global AAA parameter settings on the NetScaler appliance. Attributes for which adefault value is available revert to their default values. See the set aaa parametercommand for descriptions of the parameters..Refer to the set aaa parameter command formeanings of the arguments.

    Top

    aaa parameter

    37

  • show aaa parameterSynopsis

    show aaa parameter

    DescriptionDisplays the current AAA global configuration.

    Example

    > show aaa parameterConfigured AAA parameters DefaultAuthType: LDAP MaxAAAUsers: 5 Done>

    Top

    aaa parameter

    38

  • 39

    aaa preauthenticationaction

    [ add | rm | set | unset | show ]

    add aaa preauthenticationactionSynopsis

    add aaa preauthenticationaction [] [-killProcess ][-deletefiles ]

    DescriptionAdds an action (profile) for endpoint analysis (EPA) clients before authentication.

    Parametersname

    Name for the preauthentication action. Must begin with a letter, number, or theunderscore character (_), and must consist only of letters, numbers, and the hyphen (-),period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters.Cannot be changed after preauthentication action is created.

    The following requirement applies only to the NetScaler CLI:

    If the name includes one or more spaces, enclose the name in double or single quotationmarks (for example, "my aaa action" or 'my aaa action).

    preauthenticationaction

    Allow or deny logon after endpoint analysis (EPA) results.

    Possible values: ALLOW, DENY

    killProcess

    String specifying the name of a process to be terminated by the endpoint analysis (EPA)tool.

    deletefiles

    String specifying the path(s) and name(s) of the files to be deleted by the endpointanalysis (EPA) tool.

    http://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationaction-ref.html#netscaler-crg-add-aaa-preauthenticationactionhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationaction-ref.html#netscaler-crg-rm-aaa-preauthenticationactionhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationaction-ref.html#netscaler-crg-set-aaa-preauthenticationactionhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationaction-ref.html#netscaler-crg-unset-aaa-preauthenticationactionhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationaction-ref.html#netscaler-crg-show-aaa-preauthenticationaction

  • Top

    rm aaa preauthenticationactionSynopsis

    rm aaa preauthenticationaction

    DescriptionRemoves a preauthentication action.

    NOTE: A preauthentication action cannot be removed if it is bound to a policy.

    Parametersname

    Name of the preauthentication action to remove.

    Top

    set aaa preauthenticationactionSynopsis

    set aaa preauthenticationaction [] [-killProcess ][-deletefiles ]

    DescriptionModifies an existing preauthentication action (profile).

    Parametersname

    Name of the preauthentication action to modify.

    preauthenticationaction

    Allow or deny logon after endpoint analysis (EPA) results.

    Possible values: ALLOW, DENY

    killProcess

    aaa preauthenticationaction

    40

  • String specifying the name of a process to be terminated by the endpoint analysis (EPA)tool.

    deletefiles

    String specifying the path(s) and name(s) of the files to be deleted by the endpointanalysis (EPA) tool.

    Top

    unset aaa preauthenticationactionSynopsis

    unset aaa preauthenticationaction [-killProcess] [-deletefiles]

    DescriptionUse this command to remove aaa preauthenticationaction settings.Refer to the set aaapreauthenticationaction command for meanings of the arguments.

    Top

    show aaa preauthenticationactionSynopsis

    show aaa preauthenticationaction []

    DescriptionDisplays details of the specified preauthentication action.

    Parametersname

    Name of the preauthentication action.

    Top

    aaa preauthenticationaction

    41

  • 42

    aaa preauthenticationparameter

    [ set | unset | show ]

    set aaa preauthenticationparameterSynopsis

    set aaa preauthenticationparameter [-preauthenticationaction ( ALLOW | DENY )] [-rule] [-killProcess ] [-deletefiles ]

    DescriptionConfigures the default end point analysis (EPA) parameters that are applied beforeauthentication.

    Parameterspreauthenticationaction

    Deny or allow login on the basis of end point analysis results.

    Possible values: ALLOW, DENY

    rule

    Name of the NetScaler named rule, or a default syntax expression, to be evaluated bythe EPA tool.

    killProcess

    String specifying the name of a process to be terminated by the EPA tool.

    deletefiles

    String specifying the path(s) to and name(s) of the files to be deleted by the EPA tool, asa string of between 1 and 1023 characters.

    Top

    http://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationparameter-ref.html#netscaler-crg-set-aaa-preauthenticationparameterhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationparameter-ref.html#netscaler-crg-unset-aaa-preauthenticationparameterhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationparameter-ref.html#netscaler-crg-show-aaa-preauthenticationparameter

  • unset aaa preauthenticationparameterSynopsis

    unset aaa preauthenticationparameter [-rule] [-preauthenticationaction] [-killProcess][-deletefiles]

    DescriptionResets the default end point analysis(EPA) configuration settings on the NetScalerappliance.

    Attributes for which a default value is available revert to their default values. See the setaaa preauthenticationparameter command for descriptions of the parameters..Refer to theset aaa preauthenticationparameter command for meanings of the arguments.

    Top

    show aaa preauthenticationparameterSynopsis

    show aaa preauthenticationparameter

    DescriptionDisplays the current preauthentication configuration.

    Top

    aaa preauthenticationparameter

    43

  • 44

    aaa preauthenticationpolicy

    [ add | rm | set | show ]

    add aaa preauthenticationpolicySynopsis

    add aaa preauthenticationpolicy []

    DescriptionAdds a preauthentication policy. The policy defines expressions to be evaluated by theendpoint analysis (EPA) tool.

    Parametersname

    Name for the preauthentication policy. Must begin with a letter, number, or theunderscore character (_), and must consist only of letters, numbers, and the hyphen (-),period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscorecharacters. Cannot be changed after the preauthentication policy is created.

    The following requirement applies only to the NetScaler CLI:

    If the name includes one or more spaces, enclose the name in double or single quotationmarks (for example, "my policy" or 'my policy').

    rule

    Name of the NetScaler named rule, or a default syntax expression, defining connectionsthat match the policy.

    reqAction

    Name of the action that the policy is to invoke when a connection matches the policy.

    Top

    http://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationpolicy-ref.html#netscaler-crg-add-aaa-preauthenticationpolicyhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationpolicy-ref.html#netscaler-crg-rm-aaa-preauthenticationpolicyhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationpolicy-ref.html#netscaler-crg-set-aaa-preauthenticationpolicyhttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-preauthenticationpolicy-ref.html#netscaler-crg-show-aaa-preauthenticationpolicy

  • rm aaa preauthenticationpolicySynopsis

    rm aaa preauthenticationpolicy

    DescriptionRemoves the specified preauthentication policy.

    Parametersname

    Name of the preauthentication policy to remove.

    Top

    set aaa preauthenticationpolicySynopsis

    set aaa preauthenticationpolicy [-rule ] [-reqAction ]

    DescriptionModifies the Request Action of a preauthentication policy.

    Parametersname

    Name of the preauthentication policy to modifiy.

    rule

    The new rule to be associated with the policy.

    reqAction

    Name of the action that the policy is to invoke when a connection matches the policy.

    Top

    aaa preauthenticationpolicy

    45

  • show aaa preauthenticationpolicySynopsis

    show aaa preauthenticationpolicy []

    DescriptionDisplays the properties of either the specified preauthentication policy or (if none isspecified) a list of all configured preauthentication policies.

    Parametersname

    Name of the preauthentication policy whose properties you want to view.

    Top

    aaa preauthenticationpolicy

    46

  • 47

    aaa radiusParams

    [ set | unset | show ]

    set aaa radiusParamsSynopsis

    set aaa radiusParams [-serverIP ] [-serverPort ] [-authTimeout] {-radKey } [-radNASip ( ENABLED | DISABLED )] [-radNASid ][-radVendorID ] [-radAttributeType ] [-radGroupsPrefix] [-radGroupSeparator ] [-passEncoding ] [-ipVendorID] [-ipAttributeType ] [-accounting ( ON | OFF )][-pwdVendorID ] [-pwdAttributeType ][-defaultAuthenticationGroup ] [-callingstationid ( ENABLED | DISABLED )]

    DescriptionModifies the global configuration settings for the RADIUS server. The settings that youspecify are used for all SSL-VPN virtual servers unless you use authentication policies tocreate a configuration for a specific SSL-VPN virtual server.

    ParametersserverIP

    IP address of your RADIUS server.

    serverPort

    Port number on which the RADIUS server listens for connections.

    Default value: 1812

    Minimum value: 1

    authTimeout

    Maximum number of seconds that the NetScaler appliance waits for a response from theRADIUS server.

    Default value: 3

    Minimum value: 1

    radKey

    http://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-radiusparams-ref.html#netscaler-crg-set-aaa-radiusparamshttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-radiusparams-ref.html#netscaler-crg-unset-aaa-radiusparamshttp://support.citrix.com/proddocs/topic/ns-reference-map-10-5/netscaler-crg-aaa-radiusparams-ref.html#netscaler-crg-show-aaa-radiusparams

  • The key shared between the RADIUS server and clients.

    Required for allowing the NetScaler appliance to communicate with the RADIUS server.

    radNASip

    Send the NetScaler IP (NSIP) address to the RADIUS server as the Network Access ServerIP (NASIP) part of the Radius protocol.

    Possible values: ENABLED, DISABLED

    radNASid

    Send the Network Access Server ID (NASID) for your NetScaler appliance to the RADIUSserver as the nasid part of the Radius protocol.

    radVendorID

    Vendor ID for RADIUS group extraction.

    Minimum value: 1

    radAttributeType

    Attribute type for RADIUS group extraction.

    Minimum value: 1

    radGroupsPrefix

    Prefix string that precedes group names within a RADIUS attribute for RADIUS groupex