Statement Summary

This section provides a reference for each of the SDK configuration statements.

The statements are organized alphabetically.


control-cores

Syntax

control-cores control-number;

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package extension-provider]

Release Information

Statement introduced in JUNOS Release 8.5.

Description

Configure control cores. Any cores not configured as either control or data cores are treated as user cores. If the number of control cores is changed, the PIC will reboot.

Options

control-number—Number of control cores. At least one core must be a control core.
Range: 1 through 8

Required Privilege Level

interface—To view this statement in the configuration.
interface-control—To add this statement to the configuration.

Related Topics

Control and Data Cores

extension-provider

data-cores

Return to top of page


data-cores

Syntax

data-cores data-number;

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package extension-provider]

Release Information

Statement introduced in JUNOS Release 8.5.

Description

Configure data cores. Any cores not configured as either data or control cores are treated as user cores. If the number of data cores is changed, the PIC will reboot.

Options

data-number—Number of data cores. Although it is not mandatory to dedicate any cores as data cores, it is advisable, depending on the nature of the application, to dedicate a minimum of five as data cores to achieve good performance.
Range: 0 through 7

Required Privilege Level

interface—To view this statement in the configuration.
interface-control—To add this statement to the configuration.

Related Topics

Control and Data Cores

extension-provider

control-cores

Return to top of page


data-flow-affinity

Syntax

data-flow-affinity {
   hash-key (layer-3 | layer-4);
}

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package extension-provider]

Release Information

Statement introduced in JUNOS Release 9.5.

Description

Enable flow affinity distribution for packets over data CPUs on the PIC. Once enabled, the default behavior for distributing data packets changes from a round-robin distribution to a flow affinity distribution based on a hash distribution. Adding or deleting this statement will cause the PIC to reboot.

The statements are explained separately.

Required Privilege Level

interface—To view this statement in the configuration.
interface-control—To add this statement to the configuration.

Related Topics

extension-provider

hash-key

Return to top of page


destination

Syntax

destination destination;

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package extension-provider syslog facility severity]

Release Information

Statement introduced in JUNOS Release 10.1.

Description

Configure where log messages go. By default, all messages go to the /var/log directory on the Routing Engine. Enhancements to the existing infrastructure make debugging on the Multiservices PIC easier by giving the user the option of redirecting log messages. When the syslog destination statement is configured to redirect the log messages, you can use the set system syslog command, a command available in the native JUNOS Software CLI, to override the syslog settings made on the Multiservices PIC.

Options

destination—Choose one of the following options:

Required Privilege Level

interface—To view this statement in the configuration.
interface-control—To add this statement to the configuration.

Related Topics

System Log Messages

extension-provider

syslog

Return to top of page


extension-provider

Syntax

extension-provider {
   control-cores control-number; 
   data-cores data-number; 
   data-flow-affinity {
      hash-key (layer-3 | layer-4);
   }
   forwarding-db-size size;
   object-cache-size value;
   package package-name; 
   policy-db-size size;
   syslog {
      facility {
         severity;
         description description;
      }
   }
   wired-process-mem-size size;
}

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package]

Release Information

Statement introduced in JUNOS Release 8.5.

Description

Configure SDK application packages on the PIC. When extension-provider is first configured, the PIC will reboot.

The statements are explained separately.

Required Privilege Level

interface—To view this statement in the configuration.
interface-control—To add this statement to the configuration.

Related Topics

Configuring the Multiservices PIC

Return to top of page


extension-service

Syntax

extension-service service-name {
   provider-defined rules;

Hierarchy Level

[edit services service-set service-set-name],
[edit forwarding-options sampling output]

Release Information

Statement introduced in JUNOS Release 9.0.

Description

Define provider-defined configuration for SDK applications.

Note:
If the extension-service statement is specified, the service-order statement is mandatory.

Options

provider-defined rules—Subhierarchy for services created by the provider.

service-name—Name of service.

Usage Guidelines

See Configuring SDK Service Sets.

Required Privilege Level

system—To view this statement in the configuration.
system-control—To add this statement to the configuration.

Related Topics

service-order

Return to top of page


extensions

Syntax

 
extensions {
   providers {
      provider-id;
   }
   resource-limits {
      package package-name {
         resources {
            cpu {
               priority number;
               time seconds;
            }
            file {
               core-size bytes;
               open number;
               size bytes;
            }
            memory {
               data-size bytes;
               locked-in bytes;
               resident-set-size bytes;
               socket-buffers bytes;
               stack-size bytes;
            }
         }
      }
      process process-ui-name {
         resources {
            cpu {
               priority number;
               time seconds;
            }
            file {
               core-size bytes;
               open number;
               size bytes;
            }
            memory {
               data-size bytes;
               locked-in bytes;
               resident-set-size bytes;
               socket-buffers bytes;
               stack-size bytes;
            }
         }
      }
   }
)
   

Hierarchy Level

[edit system]

Release Information

Statement introduced in JUNOS Release 9.0.

Description

Configure extensions to the JUNOS Software. You must turn on the SDK service process (ssd) and configure the providers provider-id statement to enable SDK application packages to be deployed and run on the router.

The statements are explained separately.

Usage Guidelines

See Enabling the SDK Service Daemon.

Required Privilege Level

admin—To view this statement in the configuration.
admin-control—To add this statement to the configuration.

Return to top of page


forwaring-db-size

Syntax

forwarding-db-size size;

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package extension-provider]

Release Information

Statement introduced in JUNOS Release 9.2.

Description

Configure the size of the forwarding database (FDB). If this setting is changed, the PIC will reboot.

Note:
You need to enable the forwarding-options sampling statement for the FDB to be created.

Options

size—Size of the FDB, in MB. The size of the FDB and the policy database together must be less than the size of object cache.
Range: 0 through 1279 MB

Required Privilege Level

interface—To view this statement in the configuration.
interface-control—To add this statement to the configuration.

Related Topics

Memory Settings

extension-provider

policy-db-size

object-cache-size

wired-process-mem-size

Return to top of page


hash-key

Syntax

hash-key (layer-3 | layer-4);

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package extension-provider]

Release Information

Statement introduced in JUNOS Release 10.2.

Description

Set the hashing distribution of flow affinity. This is an optional setting. Once the data-flow-affinity statement is enabled, you may need to choose the hashing distribution. Modifying this statement will cause the PIC to reboot.

Default

layer-4

Options

layer-3—3-tuple hashing (source IP address, destination IP address, and IP protocol).

layer-4—5-tuple hashing (3-tuple plus source and destination TCP or UDP ports). This is the default.

Required Privilege Level

interface—To view this statement in the configuration.
interface-controlmdash;To add this statement to the configuration.

Related Topics

Flow Affinity on the Data Plane

data-flow-affinity

extension-provider

Return to top of page


<<<<<<< .mine

license-type

Syntax

license-type license deployment-scope [ deployments ];

Hierarchy Level

[edit system extensions providers providers-id]

Release Information

Statement introduced in JUNOS Release 10.2.

Description

Configure the type and scope of a certificate to use the JUNOS SDK.

Options

license—Type of license. Obtain correct value from the application’s provider.

deployment—Scope of license’s deployment. You can configure a set of deployment scopes. Obtain correct value from the application’s provider.

Required Privilege Level

admin—To view this statement in the configuration.
admin-control—To add this statement to the configuration.

Related Topics

Configuring the Provider ID, License Type, and Deployment Scope

extensions

providers

Return to top of page


||||||| .r373337 =======

license-type

Syntax

license-type license deployment-scope [ deployments ];

Hierarchy Level

[edit system extensions providers providers-id]

Release Information

Statement introduced in JUNOS Release 10.2.

Description

Configure the type and scope of a certificate to use the JUNOS SDK.

Options

license—Type of license. Obtain correct value from the application’s provider.

deployment—Scope of license’s deployment. You can configure a set of deployment scopes. Obtain correct value from the application’s provider.

Required Privilege Level

adminTo view this statement in the configuration.
admin-control—To add this statement to the configuration.

Related Topics

Configuring the Provider ID, License Type, and Deployment Scope

extensions

providers

Return to top of page


>>>>>>> .r374513

object-cache-size

Syntax

object-cache-size value;

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package extension-provider]

Description

Configure the amount of object cache. If this setting is changed the, PIC will reboot.

Options

value—Amount of object cache, in MB. Only values in increments of 128 MB are allowed.
Range: For Multiservices 100 PIC, range is 128 MB through 512 MB. If there is a configured wired-process-mem-size of 512 MB, the maximum value of object-cache-size is 128 MB.
Range: For Multiservices 400 PIC and the Multiservices DPC, range is 128 MB through 1280 MB. If there is a configured wired-process-mem-size of 512 MB, the maximum value of object-cache-size is 512 MB.

Required Privilege Level

interface—To view this statement in the configuration.
interface-control—To add this statement to the configuration.

Related Topics

Memory Settings

extension-provider

forwaring-db-size

policy-db-size

wired-process-mem-size

Return to top of page


package

See the following sections:


package (Loading on PIC)

Syntax

package package-name;

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package extension-provider]

Release Information

Statement introduced in JUNOS Release 9.1.

Description

Identify a package to be loaded on the PIC. If any package setting is added or removed, the PIC will reboot.

Options

package-name—Name of the package to be loaded on the PIC. There can be up to eight packages loaded on a PIC; however, only one data package is allowed per PIC. An error message is displayed if more than eight packages are specified.

Required Privilege Level

interface—To view this statement in the configuration.
interface-control—To add this statement to the configuration.

Related Topics

Packages on the PIC

extension-provider

Return to package

Return to top of page


package (Resource Limits)

Syntax

package package-name {
   resources {
      cpu {
         priority number;
         time seconds;
      }
      file {
         core-size bytes;
         open number;
         size bytes;
      }
      memory {
         data-size bytes;
         locked-in bytes;
         resident-set-size bytes;
         socket-buffers bytes;
         stack-size bytes;
      }
   }
}

Hierarchy Level

[edit system extensions resource-limits]

pack-rl-release

Release Information Statement introduced in JUNOS Release 9.6.

Description

Set resource limits for an entire package of a JUNOS SDK application.

Options

package-name—Name of the JUNOS SDK application package.

The statements are explained separately.

Required Privilege Level

admin—To view this statement in the configuration.
admin-control—To add this statement to the configuration.

Related Topics

Setting Administrator-Defined Resource Limits for SDK Applications

resource-limits

resources

process

Return to package

Return to top of page


policy-db-size

Syntax

policy-db-size size;

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package extension-provider]

Description

Configure the size of the policy database. If this setting is changed the, PIC will reboot.

Note:
At least one data core must be configured to configure the size of the policy database.

Options

size—Size of the policy database, in MB. The size of the FDB and the policy database together must be less than the size of object cache.
Range: 0 through 1279 MB

Required Privilege Level

interface—To view this statement in the configuration.
interface-control—To add this statement to the configuration.

Related Topics

Memory Settings

extension-provider

forwaring-db-size

object-cache-size

wired-process-mem-size

Return to top of page


process

Syntax

process process-ui-name {
   resources {
      cpu {
         priority number;
         time seconds;
      }
      file {
         core-size bytes;
         open number;
         size bytes;
      }
      memory {
         data-size bytes;
         locked-in bytes;
         resident-set-size bytes;
         socket-buffers bytes;
         stack-size bytes;
      }
   }
}

Hierarchy Level

[edit system extensions resource-limits]

Release Information

Statement introduced in JUNOS Release 9.6.

Description

Set resource limits for a process in an SDK application package. Limits defined for individual processes override the limits defined for an entire package.

Options

process-ui-name—Name of the process.

The remaining statements are explained separately.

Required Privilege Level

admin—To view this statement in the configuration.
admin-control—To add this statement to the configuration.

Related Topics

Setting Administrator-Defined Resource Limits for SDK Applications

resources

resource-limits

package (Resource Limits)

Return to top of page


process-monitor

Syntax

process-monitor {
   disable;
   traceoptions {
      file filename files number match regex size size (world-readable | no-world-readable); 
      flag flag;
      level level;
      no-remote-trace;
   }
}

Hierarchy Level

[edit system processes]

Release Information

Statement introduced in JUNOS Release 9.0.

Description

Define tracing options for the process health monitor (pmond).

Options

disable— Disable process health monitor process.

The remaining statements are explained separately.

Required Privilege Level

trace—To view this statement in the configuration. trace-control—To add this statement to the configuration.

Related Topics

Tracing Process Monitoring Operations

traceoptions (Process Monitor)

Return to top of page


providers

Syntax

providers {
   provider-id {
      license-type license deployment-scope [ deployments ];
   }
}

Hierarchy Level

[edit system extensions]

Description

Activate the provider ID of the provider of the SDK application and enable the PIC for loading of the SDK application.

Options

provider-id—Provider ID for the SDK application package. The provider ID identifies the provider of the application to the system. The provider ID must be activated on the router to allow the SDK application to be deployed on the router and run.

The remaining statements are explained separately.

Required Privilege Level

admin—To view this statement in the configuration.
admin-control—To add this statement to the configuration.

Related Topics

Configuring the Provider ID, License Type, and Deployment Scope

extensions

Return to top of page


resource-cleanup

Syntax

resource-cleanup {
   disable;
   traceoptions {
      file filename files number match regex size size (world-readable | no-world-readable);      
      flag flag;
      level level;
      no-remote-trace;
   }
}

Hierarchy Level

[edit system processes]

Release information

Statement introduced in JUNOS Release 9.3.

Description

Enable resource cleanup process. As of JUNOS Release 9.3, traceoptions is the only CLI statement for resource-cleanup.

Options

disable—Disable resource cleanup process.

The remaining statements are explained separately.

Required Privilege Level

trace—To view this statement in the configuration.
trace-control—To add this statement to the configuration.

Related Topics

Tracing System Resource Cleanup Operations

traceoptions (Resource Cleanup)

Return to top of page


resource-limits

Syntax

 
resource-limits {
   package package-name {
      resources {
         cpu {
            priority number;
            time seconds;
         }
         file {
            core-size bytes;
            open number;
            size bytes;
         }
         memory {
            data-size bytes;
            locked-in bytes;
            resident-set-size bytes;
            socket-buffers bytes;
            stack-size bytes;
         }
      }
   }
   process process-ui-name {
      resources {
         cpu {
            priority number;
            time seconds;
         }
         file {
            core-size bytes;
            open number;
            size bytes;
         }
         memory {
            data-size bytes;
            locked-in bytes;
            resident-set-size bytes;
            socket-buffers bytes;
            stack-size bytes;
         }
      }
   }
}

Hierarchy Level

[edit system extensions]

Release Information

Statement introduced in JUNOS Release 9.6.

Description

Set resource limits for JUNOS SDK applications using the CLI. You can set limits for all SDK applications listed in the SDK application package's manifest or define limits for individual applications in the package.

The statements are explained separately.

Usage Guidelines

See Setting Administrator-Defined Resource Limits for SDK Applications.

Required Privilege Level

admin—To view this statement in the configuration.
admin-control—To add this statement to the configuration.

Return to top of page


resources

Syntax

resources {
   cpu {
      priority number;
      time seconds;
   }
   file {
      core-size bytes;
      open number;
      size bytes;
   }
   memory {
      data-size bytes;
      locked-in bytes;
      resident-set-size bytes;
      socket-buffers bytes;
      stack-size bytes;
   }
}

Hierarchy Level

[edit system extensions resource-limits package package-name],
[edit system extensions resource-limits process process-ui-name]

Release Information

Statement introduced in JUNOS Release 9.6.

Description

Set resource limits for JUNOS SDK applications.

Options

bytes—Maximum size of each file, in kilobytes (KB) or megabytes (MB).
Syntax: (where x is some number) xk to specify KB or xm to specify MB

cpu—CPU resources.

file—File system resources.

memory—Memory resources.

Usage Guidelines

See Setting Administrator-Defined Resource Limits for SDK Applications.

Required Privilege Level

admin—To view this statement in the configuration.
admin-control—To add this statement to the configuration.

Related Topics

process

resource-limits

resources

Return to top of page


service-order

Syntax

service-order {
    forward-flow [ service-name1 service-name2 ];
    reverse-flow [ service-name1 service-name2 ];
}

Hierarchy Level

[edit services service-set service-set-name]

Release Information

Statement introduced in JUNOS Release 9.3.

Description

Define order of services in service set to be applied to traffic coming to the PIC. The service-order statement must include all services defined in the service set.

Note:
If the extension-service statement is specified, the service-order statement is mandatory.

Options

forward-flow—Order of services in service set to be applied in forward flow. It is mandatory to specify the forward-flow service order.

reverse-flow—Order of services in service set to be applied in reverse flow. If you want the order to be the reverse of that specified for forward flow, this is optional. But if, for example, you want the order to be the same regardless of direction of flow, you need to include this statement. (The exception to this is for the sampling service set type. If a service set is a sampling service set and the reverse-flow service order is not configured, all sampled traffic is considered to be forward traffic.)

Usage Guidelines

See Configuring SDK Service Sets.

Required Privilege Level

system—To view this statement in the configuration.
system-control—To add this statement to the configuration.

Related Topics

extension-service

Return to top of page


syslog

Syntax

syslog {
   facility {
       severity;
       destination destination;
   }
}

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package extension-provider]

Release Information

Statement introduced in JUNOS Release 9.2.
Options daemon and kernel (for facility) introduced in JUNOS Release 9.5.

Description

Enable PIC system logging to record or view system log messages on a specific PIC, The system log information is passed to the kernel for logging in the /var/log directory.

Options

facility—Group of messages that are either generated by the same software process or concern a similar condition or activity. Possible values:

severity—Classification of effect on functioning. Possible values are the same as for the native JUNOS software. See the JUNOS System Basics Configuration Guide. Possible values include the following:

The remaining statement is explained separately.

Usage Guidelines

See Configuring the Multiservices PIC.

Required Privilege Level

system—To view this statement in the configuration.
system-control—To add this statement to the configuration.

Related Topics

extension-provider

Return to top of page


traceoptions

See the following sections:


traceoptions (Process Monitor)

Syntax

traceoptions {
   file filename files number match regex size size (world-readable | no-world-readable);
   flag flag;
   level level;
   no-remote-trace;
}

Hierarchy Level

[edit system processes process-monitor]

Release Information

Statement introduced in JUNOS Release 9.0.

Description

Enable tracing options for the process health monitor (pmond).

Options

file—Information you want to specify about the trace file or files. See the JUNOS System Basics Configuration Guide for information about configuring this file information.

flag flag—Area of the process health monitor for which you want to enable tracing. To specify more than one tracing operation, include multiple flag statements. You can include the following flags:

level level—Level of debugging output:

match regex—(Optional) Refine the output to include lines that contain the regular expression.

no-remote-trace—Disable remote tracing.

size size—(Optional) Maximum size of each trace file, in kilobytes (KB), megabytes (MB), or gigabytes (GB). If you specify a maximum file size, you also must specify a maximum number of trace files with the files number option.
Syntax: xk to specify KB, xm to specify MB, or xg to specify GB
Range: 10 KB through 1 GB
Default: 128 KB

world-readable | no-world-readable—(Optional). Grant all users permission to read log files, or restrict the permission only to the root user and users who have the JUNOS maintenance permission.

Usage Guidelines

See Tracing Process Monitoring Operations.

Required Privilege Level

trace—To view this statement in the configuration.
trace-control—To add this statement to the configuration.

Related Topics

process-monitor

Return to traceoptions

Return to top of page


traceoptions (Resource Cleanup)

Syntax

traceoptions {
   file filename files number match regex size size (world-readable | no-world-readable);
   flag flag;
   level level;
   no-remote-trace;
}

Hierarchy Level

[edit system processes resource-cleanup]

Release information

Statement introduced in JUNOS Release 9.3.

Description

Enable debugging tracing for resource cleanup process.

Options

file—Information you want to specify about the trace file or files. See the JUNOS System Basics Configuration Guide for information about configuring this file information.

flag—Specify which tracing operation to perform. To specify more than one tracing operation, include multiple flag statements. You can include the following flags:

match regex—(Optional) Refine the output to include lines that contain the regular expression.

no-remote-trace—Disable remote tracing.

size size—(Optional) Maximum size of each trace file, in kilobytes (KB), megabytes (MB), or gigabytes (GB). If you specify a maximum file size, you also must specify a maximum number of trace files with the files number option.
Syntax: xk to specify KB, xm to specify MB, or xg to specify GB
Range: 10 KB through 1 GB
Default: 128 KB

world-readable | no-world-readable—(Optional). Grant all users permission to read log files, or restrict the permission only to the root user and users who have the JUNOS maintenance permission.

Usage Guidelines

See Tracing System Resource Cleanup Operations.

Required Privilege Level

trace—To view this statement in the configuration.
trace-control—To add this statement to the configuration.

Return to traceoptions

Return to top of page


wired-process-mem-size

Syntax

wired-process-mem-size size;

Hierarchy Level

[edit chassis fpc slot-number pic slot-number adaptive-services service-package extension-provider]

Description

Configure to size of the reserved wired process memory. You can also configure object cache. If this setting is changed the, PIC will reboot.

Options

mem-size—Size of the reserved wired process memory, in MB. The only size you can set for this statement is 512 MB.
Default: 512 MB
Range: 0 through 512 MB

Required Privilege Level

interface—To view this statement in the configuration.
interface-control—To add this statement to the configuration.

Related Topics

Memory Settings

extension-provider

forwaring-db-size

object-cache-size

policy-db-size

Return to top of page


See also:
Configuration Command Summary

Operational Command Reference

SDK CLI Configuration

Guidelines for Configuring SDK Applications


© 2007-2009 Juniper Networks, Inc. All rights reserved. The information contained herein is confidential information of Juniper Networks, Inc., and may not be used, disclosed, distributed, modified, or copied without the prior written consent of Juniper Networks, Inc. in an express license. This information is subject to change by Juniper Networks, Inc. Juniper Networks, the Juniper Networks logo, and JUNOS are registered trademarks of Juniper Networks, Inc. in the United States and other countries. All other trademarks, service marks, registered trademarks, or registered service marks are the property of their respective owners.
Generated on Sun May 30 20:26:47 2010 for Juniper Networks Partner Solution Development Platform JUNOS SDK 10.2R1 by Doxygen 1.4.5