code
stringlengths 10
58.5k
| file_path
stringlengths 53
173
|
|---|---|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_ovsdb_config(self, **kwargs):
r'''
#Procedure Header
Name:
emulation_ovsdb_config
Description:
This procedure will add OVSDB Controller(s) to a particular Ixia Interface.
Synopsis:
emulation_ovsdb_config
x [-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
x [-reset FLAG]
[-handle ANY]
x [-return_detailed_handles CHOICES 0 1
x DEFAULT 0]
[-mode CHOICES create
CHOICES modify
CHOICES delete
CHOICES getAttribute
DEFAULT create]
x [-attributeName CHOICES role
x CHOICES errorCode
x CHOICES errorTimeStamp
x CHOICES errorDesc
x CHOICES errorPhysicalSwitchName
x CHOICES errorLogicalSwitchName
x CHOICES serverAddDeleteStatus
x CHOICES latestDumpDbFileNames
x CHOICES latestErrorFileNames
x CHOICES serverAddDeleteConnectionError
x CHOICES bindingStatus
x CHOICES progressStatus
x CHOICES errorStatus]
x [-name ALPHA]
[-count RANGE 1-8000
DEFAULT 1]
x [-connection_type CHOICES tcp tls]
x [-controller_tcp_port RANGE 1-66535
x DEFAULT 6640]
x [-directory_name ANY]
x [-file_private_key ANY]
x [-file_certificate ANY]
x [-verify_peer_certificate CHOICES 0 1
x DEFAULT 0]
x [-file_ca_certificate ANY]
x [-verify_hw_gateway_certificate CHOICES 0 1
x DEFAULT 0]
x [-file_hw_gateway_certificate ANY]
x [-time_out NUMERIC]
x [-dumpdb_directory_name ANY]
x [-enable_ovsdb_server_ip CHOICES 0 1
x DEFAULT 0]
x [-enable_logging CHOICES 0 1
x DEFAULT 0]
x [-ovsdb_server_ip IPV4
x DEFAULT 0.0.0.0]
x [-clear_dump_db_files CHOICES 0 1
x DEFAULT 1]
x [-error_log_directory_name ANY]
x [-server_connection_ip IPV4
x DEFAULT 0.0.0.0]
x [-bindings_count NUMERIC]
x [-attach_at_start CHOICES 0 1
x DEFAULT 1]
x [-logical_switch_name ANY]
x [-vni ANY]
x [-physical_switch_name ANY]
x [-physical_port_name ANY]
x [-sessions_per_vxlan RANGE 1-1600
x DEFAULT 1]
x [-pseudo_connected_to ANY]
x [-pseudo_connected_to_vxlan_replicator ANY]
x [-pseudo_connected_to_bfd ANY]
x [-vxlan ANY]
x [-vxlan_replicator ANY]
x [-cluster_vlan_id RANGE 0-4096]
x [-create_full_stack CHOICES 0 1
x DEFAULT 0]
x [-table_names CHOICES all
x CHOICES global
x CHOICES manager
x CHOICES physical_switch
x CHOICES physical_port
x CHOICES physical_locator
x CHOICES physical_locator_set
x CHOICES tunnel
x CHOICES logical_switch
x CHOICES ucast_mac_local
x CHOICES ucast_mac_remote
x CHOICES mcast_mac_local
x CHOICES mcast_mac_remote]
Arguments:
x -port_handle
x Ixia interface upon which to act.
x -reset
x If this option is selected, this will clear any Ovsdb Controller.
-handle
Ovsdb Controller handle for using the modes delete, modify, enable, and disable.
x -return_detailed_handles
x This argument determines if individual interface, session or router handles are returned by the current command.
x This applies only to the command on which it is specified.
x Setting this to 0 means that only NGPF-specific protocol stack handles will be returned. This will significantly
x decrease the size of command results and speed up script execution.
x The default is 0, meaning only protocol stack handles will be returned.
-mode
Action to take on the port specified the handle argument.
x -attributeName
x attribute name for fetching value.
x -name
x Name of NGPF element, guaranteed to be unique in Scenario
-count
Defines the number of ovsdb controller to configure on the -port_handle.
x -connection_type
x Connection should use TCP or TLS
x -controller_tcp_port
x Specify the TCP port for the Controller
x -directory_name
x Location of Directory in Client where the Certificate and Key Files are available
x -file_private_key
x Private Key File
x -file_certificate
x Certificate File
x -verify_peer_certificate
x Verify Peer Certificate
x -file_ca_certificate
x CA Certificate File
x -verify_hw_gateway_certificate
x Verify HW Gateway Certificate
x -file_hw_gateway_certificate
x HW Gateway Certificate File
x -time_out
x Transact request Time Out in seconds. For scale scenarios increase this Timeout value.
x -dumpdb_directory_name
x Location of Directory in Client where the DumpDb Files are available
x -enable_ovsdb_server_ip
x -enable_logging
x If true, Port debug logs will be recorded.
x -ovsdb_server_ip
x The IP address of the DUT or Ovs Server.
x -clear_dump_db_files
x -error_log_directory_name
x Location of Directory in Client where the ErrorLog Files are available
x -server_connection_ip
x The IP address of the DUT or Ovs Server which needs to be Added/Deleted.
x -bindings_count
x Bindings Count
x -attach_at_start
x Attach at Start
x -logical_switch_name
x Logical_Switch Name
x -vni
x VNI
x -physical_switch_name
x Physical_Switch name
x -physical_port_name
x Physical_Port name
x -sessions_per_vxlan
x Indicates the multiplier per VXLAN entity for behind VM clients emulated.
x -pseudo_connected_to
x GUI-only connection
x -pseudo_connected_to_vxlan_replicator
x GUI-only connection
x -pseudo_connected_to_bfd
x GUI-only connection
x -vxlan
x -vxlan_replicator
x -cluster_vlan_id
x Cluster Data VLAN ID
x -create_full_stack
x flag to create full stack. this flag is introduced mainly for Scripgen Issue.
x -table_names
Return Values:
A list containing the ovsdb controller protocol stack handles that were added by the command (if any).
x key:ovsdb_controller_handle value:A list containing the ovsdb controller protocol stack handles that were added by the command (if any).
$::SUCCESS or $::FAILURE
key:status value:$::SUCCESS or $::FAILURE
If failure, will contain more information
key:log value:If failure, will contain more information
Ovsdb Controller Handles Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
key:handle value:Ovsdb Controller Handles Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Cluster Data Handles Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
key:clusterdata_handle value:Cluster Data Handles Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Examples:
Sample Input:
Sample Output:
Notes:
1) Coded versus functional specification.
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: handle, clusterdata_handle
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_ovsdb_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ovsdb_config.py_part1
|
x Transact request Time Out in seconds. For scale scenarios increase this Timeout value.
x -dumpdb_directory_name
x Location of Directory in Client where the DumpDb Files are available
x -enable_ovsdb_server_ip
x -enable_logging
x If true, Port debug logs will be recorded.
x -ovsdb_server_ip
x The IP address of the DUT or Ovs Server.
x -clear_dump_db_files
x -error_log_directory_name
x Location of Directory in Client where the ErrorLog Files are available
x -server_connection_ip
x The IP address of the DUT or Ovs Server which needs to be Added/Deleted.
x -bindings_count
x Bindings Count
x -attach_at_start
x Attach at Start
x -logical_switch_name
x Logical_Switch Name
x -vni
x VNI
x -physical_switch_name
x Physical_Switch name
x -physical_port_name
x Physical_Port name
x -sessions_per_vxlan
x Indicates the multiplier per VXLAN entity for behind VM clients emulated.
x -pseudo_connected_to
x GUI-only connection
x -pseudo_connected_to_vxlan_replicator
x GUI-only connection
x -pseudo_connected_to_bfd
x GUI-only connection
x -vxlan
x -vxlan_replicator
x -cluster_vlan_id
x Cluster Data VLAN ID
x -create_full_stack
x flag to create full stack. this flag is introduced mainly for Scripgen Issue.
x -table_names
Return Values:
A list containing the ovsdb controller protocol stack handles that were added by the command (if any).
x key:ovsdb_controller_handle value:A list containing the ovsdb controller protocol stack handles that were added by the command (if any).
$::SUCCESS or $::FAILURE
key:status value:$::SUCCESS or $::FAILURE
If failure, will contain more information
key:log value:If failure, will contain more information
Ovsdb Controller Handles Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
key:handle value:Ovsdb Controller Handles Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Cluster Data Handles Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
key:clusterdata_handle value:Cluster Data Handles Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Examples:
Sample Input:
Sample Output:
Notes:
1) Coded versus functional specification.
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: handle, clusterdata_handle
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_ovsdb_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ovsdb_config.py_part2
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_igmp_control(self, mode, **kwargs):
r'''
#Procedure Header
Name:
emulation_igmp_control
Description:
This procedure starts, stops and restarts the IGMP protocol on specific Ixia ports with CPUs.
Synopsis:
emulation_igmp_control
-mode CHOICES stop
CHOICES start
CHOICES restart
CHOICES join
CHOICES leave
CHOICES rejoin
CHOICES releave
CHOICES igmpSendSpecificQuery
CHOICES igmpResumePeriodicGenQuery
CHOICES igmpStopPeriodicGenQuery
[-group_member_handle ANY]
x [-source_member_handle ANY]
[-handle ANY]
[-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
x [-start_group_address IPV4
x DEFAULT 125.0.0.1]
x [-group_count NUMERIC
x DEFAULT 1]
x [-start_source_address IPV4
x DEFAULT 10.10.10.0]
x [-source_count NUMERIC
x DEFAULT 0]
x [-source_increment_step NUMERIC
x DEFAULT 1]
Arguments:
-mode
The action that will be performed on the protocol instances.
-group_member_handle
The IGMP group range handle. This option is available when using IxTclProtocol or IxTclNetwork path.
When using IxTclNetwork, this parameter can be also given as an element or a list of elements in the following
format: (source IP)/(source IP step)/(source count). Eg: 50.0.1.2/0.0.0.1/3.
x -source_member_handle
x The IGMP source range handle. This option is available when using IxTclProtocol or IxTclNetwork path.
x When using IxTclNetwork, this parameter can be also given as an element or a list of elements in the following
x format: (group IP)/(group IP step)/(group count). Eg: 50.0.1.2/0.0.0.1/3.
-handle
The IGMP session handle (host or querier). When this parameter is used
with IxTclNetwork, it can also be provided as an IGMP host IP or a list
of IGMP host IPs.
-port_handle
The port where the IGMP is to be controlled. If IxTclNetwork path is used, and port_handle is used
with mode join/leave, the group members on each ports will be enabled/disabled.
x -start_group_address
x This attribute is used when -mode is "igmp_send_specific_query". The parameter represents the start group address.
x -group_count
x This attribute is used when -mode is "igmp_send_specific_query". The parameter represents the group count.
x -start_source_address
x This attribute is used when -mode is "igmp_send_specific_query". The parameter represents the start source address.
x -source_count
x This attribute is used when -mode is "igmp_send_specific_query". The parameter represents the source count.
x -source_increment_step
x This attribute is used when -mode is "igmp_send_specific_query". The parameter represents the source increment step.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
If status is failure, detailed information provided.
key:log value:If status is failure, detailed information provided.
Examples:
Sample Input:
Sample Output:
Notes:
If neither -handle nor -port_handle is provided, the protocol will start on all ports that have IGMP configured. This is valid for IxTclNetwork path only.
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_igmp_control',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_igmp_control.py_part1
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_ospf_lsa_config(self, mode, handle, **kwargs):
r'''
#Procedure Header
Name:
emulation_ospf_lsa_config
Description:
This procedure is not supported in ixiangpf namespace
Synopsis:
emulation_ospf_lsa_config
-mode CHOICES create modify delete reset
DEFAULT create
-handle ANY
[-lsa_handle ANY]
[-adv_router_id IP
DEFAULT 198.18.1.1]
x [-area_id IP
x DEFAULT 0.0.0.0]
[-attached_router_id IP
DEFAULT 14.0.0.1]
[-external_number_of_prefix ANY
DEFAULT 16]
[-external_prefix_start IP]
[-external_prefix_length ANY
DEFAULT 16]
[-external_prefix_step IP
DEFAULT 0.0.0.1]
[-external_prefix_metric RANGE 0-16777215
DEFAULT 1]
[-external_prefix_type CHOICES 1 2
DEFAULT 1]
[-external_prefix_forward_addr IP]
[-external_route_tag IP
DEFAULT 17.0.0.1]
x [-external_metric_fbit CHOICES 1 0
x DEFAULT 1]
x [-external_metric_tbit CHOICES 1 0
x DEFAULT 1]
x [-external_metric_ebit CHOICES 1 0
x DEFAULT 0]
[-link_state_id IP
DEFAULT 199.18.1.1]
[-link_state_id_step IPV4]
[-ls_type_function_code RANGE 0-8191
DEFAULT 0]
x [-lsa_group_mode CHOICES append create
x DEFAULT append]
[-net_prefix_length ANY
DEFAULT 16]
[-net_attached_router CHOICES create delete reset
DEFAULT create]
x [-no_write FLAG]
[-opaque_enable_link_id CHOICES 0 1
DEFAULT 0]
[-opaque_enable_link_local_ip_addr CHOICES 0 1
DEFAULT 0]
[-opaque_enable_link_max_bw CHOICES 0 1
DEFAULT 0]
[-opaque_enable_link_max_resv_bw CHOICES 0 1
DEFAULT 0]
[-opaque_enable_link_metric CHOICES 0 1
DEFAULT 0]
[-opaque_enable_link_remote_ip_addr CHOICES 0 1
DEFAULT 0]
[-opaque_enable_link_resource_class CHOICES 0 1
DEFAULT 0]
[-opaque_enable_link_type CHOICES 0 1
DEFAULT 0]
[-opaque_enable_link_unresv_bw CHOICES 0 1
DEFAULT 0]
[-opaque_link_id IP
DEFAULT 0.0.0.0]
[-opaque_link_local_ip_addr IP
DEFAULT 0.0.0.0]
[-opaque_link_max_bw ANY
DEFAULT 0]
[-opaque_link_max_resv_bw ANY
DEFAULT 0]
[-opaque_link_metric NUMERIC
DEFAULT 0]
[-opaque_link_remote_ip_addr IP
DEFAULT 0.0.0.0]
[-opaque_link_resource_class HEX
DEFAULT 0x00000000]
[-opaque_link_type CHOICES ptop multiaccess
DEFAULT ptop]
[-opaque_link_subtlvs IP
DEFAULT 0.0.0.0]
x [-opaque_link_other_subtlvs REGEXP ^(0x[0-9a-fA-F]+:[0-9]+:[0-9]+ )*0x[0-9a-fA-F]+:[0-9]+:[0-9]+$]
[-opaque_link_unresv_bw_priority ANY
DEFAULT 0]
[-opaque_router_addr IP
DEFAULT 0.0.0.0]
[-opaque_tlv_type CHOICES link router
DEFAULT router]
[-options RANGE 0-255]
x [-prefix_options RANGE 0-255]
[-router_abr CHOICES 0 1
DEFAULT 0]
[-router_asbr CHOICES 0 1
DEFAULT 0]
[-router_virtual_link_endpt CHOICES 0 1
DEFAULT 0]
x [-router_wildcard CHOICES 0 1
x DEFAULT 0]
[-router_link_mode CHOICES create modify delete
DEFAULT create]
[-router_link_id IP
DEFAULT 12.0.0.1]
[-router_link_data IP
DEFAULT 13.0.0.1]
[-router_link_type CHOICES ptop transit stub virtual
DEFAULT ptop]
[-router_link_metric RANGE 1-65535
DEFAULT 1]
[-session_type CHOICES ospfv2 ospfv3
DEFAULT ospfv2]
[-summary_number_of_prefix ANY
DEFAULT 16]
[-summary_prefix_start IP
DEFAULT 15.0.0.1]
[-summary_prefix_length ANY
DEFAULT 16]
[-summary_prefix_step IP
DEFAULT 0.0.0.1]
[-summary_prefix_metric RANGE 0-16777215
DEFAULT 1]
[-type CHOICES router
CHOICES network
CHOICES summary_pool
CHOICES asbr_summary
CHOICES ext_pool
CHOICES opaque_type_9
CHOICES opaque_type_10
CHOICES opaque_type_11
DEFAULT router]
n [-auto_ls_age ANY]
n [-auto_ls_checksum ANY]
n [-auto_ls_seq ANY]
n [-auto_update ANY]
n [-ls_age ANY]
n [-ls_checksum ANY]
n [-ls_seq ANY]
n [-ls_type_s_bits ANY]
n [-ls_type_u_bit ANY]
n [-nssa_number_of_prefix ANY]
n [-nssa_prefix_forward_addr ANY]
n [-nssa_prefix_length ANY]
n [-nssa_prefix_metric ANY]
n [-nssa_prefix_start ANY]
n [-nssa_prefix_step ANY]
n [-nssa_prefix_type ANY]
n [-router_link_idx ANY]
n [-te_tlv_type ANY]
n [-te_instance_id ANY]
n [-te_router_address ANY]
n [-te_link_id ANY]
n [-te_link_type ANY]
n [-te_metric ANY]
n [-te_local_ip ANY]
n [-te_remote_ip ANY]
n [-te_admin_group ANY]
n [-te_max_bw ANY]
n [-te_max_resv_bw ANY]
n [-te_max_resv_priority0 ANY]
n [-te_max_resv_priority1 ANY]
n [-te_max_resv_priority2 ANY]
n [-te_max_resv_priority3 ANY]
n [-te_max_resv_priority4 ANY]
n [-te_max_resv_priority5 ANY]
n [-te_max_resv_priority6 ANY]
n [-te_max_resv_priority7 ANY]
Arguments:
-mode
Mode of the procedure call.Valid options are:
create
modify
delete
-handle
This option represents the handle the user *must* pass to the
"emulation_ospf_lsa_config" procedure. This option specifies
on which OSPF router to configure the OSPF User LSA.
The OSPF router handle(s) are returned by the procedure
"emulation_ospf_config" when configuring OSPF routers on the
Ixia interface.
-lsa_handle
This option specifies on which OSPF User LSA to configure. This option
*must* be passed if the -mode option is modify or delete.
The OSPF LSA handle(s) are returned by the procedure
"emulation_ospf_lsa_config" when creating OSPF user LSA(s) on the Ixia
interface.
-adv_router_id
The router ID of the router that is originating the LSA.
x -area_id
x The area ID of the User LSA Group.
x This option is valid only for IxTclNetwork API.
-attached_router_id
A list of router IDs in the area, in IP address format separated by
spaces.
-external_number_of_prefix
The number of External IP LSAs to generate.
-external_prefix_start
This option is valid for OSPFv3 external route type. The prefix
address to be advertised in the LSA. Although only prefixLength
bits of the IPv6 address are meaningful, a full IPv6 address should
be specified.
-external_prefix_length
The number of high-order bits of prefixAddress that are significant.
-external_prefix_step
If external_number_of_prefix is greater than 1,this is the value that
will be added to the most significant external_prefix_length bits of
external_prefix_start between generated LSAs. This is also the value
to increment the link_state_id.
-external_prefix_metric
The cost of the route for all TOS levels.
-external_prefix_type
The type of external metric. A value of 1 implies type 2 metric.A
value of 0 implies type 1.
-external_prefix_forward_addr
If the external_metric_fbit is true, data traffic for the advertised
destination will be forwarded to this fully qualified IPv6 address.
-external_route_tag
If the external_metric_tbit is true, an additional value to be used for
external routes between AS boundary routers. This field is not used
within OSPF.
x -external_metric_fbit
x The value of the external metric's F-bit. If true, then the
x forwardingAddress field is to be included in the LSA.
x -external_metric_tbit
x The value of the external metric's T-bit. If true, then the
x externalRouteTag field will be included in the LSA.
x -external_metric_ebit
x The value of the external metric's E-bit.
-link_state_id
The router ID of the originating router. This field uniquely identified
the LSA in the link-state database.
-link_state_id_step
If summary_number_of_prefix is greater than 1, the value to increment
the link_state_id by for each LSA. The value is expressed in IPv4 format.
-ls_type_function_code
x -lsa_group_mode
x The two modes are append or create. Append means appending the new LSA
x to the last LSA group created. Create means creating a new LSA group
x for the newly added LSA.
x This option is valid only for -mode create.
x This option is valid only for IxTclNetwork API.
-net_prefix_length
The length in bits of the IP address mask for the network.
-net_attached_router
The option specifies the mode in configuring router IDs in the area.
Note that delete and reset does not work. Valid options are:
create
delete
reset
x -no_write
x If this option is present, the protocol configuration will not be
x written to the server.
-opaque_enable_link_id
This will enable usage of link id. TLV Type 2. If checked, this will
be the 4-octet IP address which identifies the other end of the link.
For Point to Point, the Neighbor's Router ID.
For Multi-access, the interface of the DR.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_local_ip_addr
This will enable the usage of local IP address. TLV Type 3.
The IP address of the local interface for this link. Each address is
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_lsa_config.py_part1
|
n [-auto_ls_age ANY]
n [-auto_ls_checksum ANY]
n [-auto_ls_seq ANY]
n [-auto_update ANY]
n [-ls_age ANY]
n [-ls_checksum ANY]
n [-ls_seq ANY]
n [-ls_type_s_bits ANY]
n [-ls_type_u_bit ANY]
n [-nssa_number_of_prefix ANY]
n [-nssa_prefix_forward_addr ANY]
n [-nssa_prefix_length ANY]
n [-nssa_prefix_metric ANY]
n [-nssa_prefix_start ANY]
n [-nssa_prefix_step ANY]
n [-nssa_prefix_type ANY]
n [-router_link_idx ANY]
n [-te_tlv_type ANY]
n [-te_instance_id ANY]
n [-te_router_address ANY]
n [-te_link_id ANY]
n [-te_link_type ANY]
n [-te_metric ANY]
n [-te_local_ip ANY]
n [-te_remote_ip ANY]
n [-te_admin_group ANY]
n [-te_max_bw ANY]
n [-te_max_resv_bw ANY]
n [-te_max_resv_priority0 ANY]
n [-te_max_resv_priority1 ANY]
n [-te_max_resv_priority2 ANY]
n [-te_max_resv_priority3 ANY]
n [-te_max_resv_priority4 ANY]
n [-te_max_resv_priority5 ANY]
n [-te_max_resv_priority6 ANY]
n [-te_max_resv_priority7 ANY]
Arguments:
-mode
Mode of the procedure call.Valid options are:
create
modify
delete
-handle
This option represents the handle the user *must* pass to the
"emulation_ospf_lsa_config" procedure. This option specifies
on which OSPF router to configure the OSPF User LSA.
The OSPF router handle(s) are returned by the procedure
"emulation_ospf_config" when configuring OSPF routers on the
Ixia interface.
-lsa_handle
This option specifies on which OSPF User LSA to configure. This option
*must* be passed if the -mode option is modify or delete.
The OSPF LSA handle(s) are returned by the procedure
"emulation_ospf_lsa_config" when creating OSPF user LSA(s) on the Ixia
interface.
-adv_router_id
The router ID of the router that is originating the LSA.
x -area_id
x The area ID of the User LSA Group.
x This option is valid only for IxTclNetwork API.
-attached_router_id
A list of router IDs in the area, in IP address format separated by
spaces.
-external_number_of_prefix
The number of External IP LSAs to generate.
-external_prefix_start
This option is valid for OSPFv3 external route type. The prefix
address to be advertised in the LSA. Although only prefixLength
bits of the IPv6 address are meaningful, a full IPv6 address should
be specified.
-external_prefix_length
The number of high-order bits of prefixAddress that are significant.
-external_prefix_step
If external_number_of_prefix is greater than 1,this is the value that
will be added to the most significant external_prefix_length bits of
external_prefix_start between generated LSAs. This is also the value
to increment the link_state_id.
-external_prefix_metric
The cost of the route for all TOS levels.
-external_prefix_type
The type of external metric. A value of 1 implies type 2 metric.A
value of 0 implies type 1.
-external_prefix_forward_addr
If the external_metric_fbit is true, data traffic for the advertised
destination will be forwarded to this fully qualified IPv6 address.
-external_route_tag
If the external_metric_tbit is true, an additional value to be used for
external routes between AS boundary routers. This field is not used
within OSPF.
x -external_metric_fbit
x The value of the external metric's F-bit. If true, then the
x forwardingAddress field is to be included in the LSA.
x -external_metric_tbit
x The value of the external metric's T-bit. If true, then the
x externalRouteTag field will be included in the LSA.
x -external_metric_ebit
x The value of the external metric's E-bit.
-link_state_id
The router ID of the originating router. This field uniquely identified
the LSA in the link-state database.
-link_state_id_step
If summary_number_of_prefix is greater than 1, the value to increment
the link_state_id by for each LSA. The value is expressed in IPv4 format.
-ls_type_function_code
x -lsa_group_mode
x The two modes are append or create. Append means appending the new LSA
x to the last LSA group created. Create means creating a new LSA group
x for the newly added LSA.
x This option is valid only for -mode create.
x This option is valid only for IxTclNetwork API.
-net_prefix_length
The length in bits of the IP address mask for the network.
-net_attached_router
The option specifies the mode in configuring router IDs in the area.
Note that delete and reset does not work. Valid options are:
create
delete
reset
x -no_write
x If this option is present, the protocol configuration will not be
x written to the server.
-opaque_enable_link_id
This will enable usage of link id. TLV Type 2. If checked, this will
be the 4-octet IP address which identifies the other end of the link.
For Point to Point, the Neighbor's Router ID.
For Multi-access, the interface of the DR.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_local_ip_addr
This will enable the usage of local IP address. TLV Type 3.
The IP address of the local interface for this link. Each address is
a 4-octet value. The total length is N times 4 octets, where N is the
number of addresses.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_max_bw
This will enable the usage of max bandwidth. TLV Type 6.
Units are in bytes per second. The maximum bandwidth that can be used
on this link in this direction (from originator to the neighbor).
Four octets in length, expressed in IEEE floating point format.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_max_resv_bw
This will enable the usage of max reservable bandwidth. TLV Type 7.
Units in bytes per second. The maximum bandwidth that can be reserved
on this link in this direction (from originator to the neighbor).
Four octets in length, expressed in IEEE floating point format. This
may be greater than the maximum bandwidth.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_metric
This will enable the usage of link metric. TLV Type 5.
The Traffic Engineering Metric.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_remote_ip_addr
This will enable the usage of the remote IP address. TLV Type 4.
The IP address of the neighbor's interface for this link. The total
length is N times four octets, where N is the number of addresses.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_resource_class
This will enable the usage of link resource class. TLV Type 9.
A bit mask value, four octets in length, which specifies
administrative group membership for this link.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_type
This will enable the usage of link type. TLV Type 1. Defines the type
of link and is one octet in length.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_unresv_bw
This will enable the usage of the unreserved bandwidth. TLV Type 8.
The amount of bandwidth not yet reserved at each of the eight
priority levels. This value will be less than or equal to the maximum
reservable bandwidth. 32 octets in length, expressed in IEEE floating
point format. If checked, unreserved bandwidth may be assigned to
each of the 8 priority levels (0 through 7).
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_id
TLV Type 2. If checked, this will be the 4-octet IP address which
identifies the other end of the link.
For Point to Point, the Neighbor's Router ID.
For Multiaccess, the interface of the DR.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_local_ip_addr
TLV Type 3. The IP address of the local interface for this link.
Each address is a 4-octet value. The total length is N times 4 octets,
where N is the number of addresses.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_max_bw
TLV Type 6. Units are in bytes per second. The maximum bandwidth that
can be used on this link in this direction (from originator to the
neighbor). Four octets in length, expressed in IEEE floating point
format.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_max_resv_bw
TLV Type 7. Units in bytes per second. The maximum bandwidth that can
be reserved on this link in this direction (from originator to the
neighbor). Four octets in length, expressed in IEEE floating point
format. This may be greater than the maximum bandwidth.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_metric
TLV Type 5. The Traffic Engineering Metric. Four octets in length.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_remote_ip_addr
TLV Type 4. The IP address of the neighbor's interface for this link.
The total length is N times four octets, where N is the number of
addresses.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_resource_class
TLV Type 9. A bit mask value, four octets in length, which specifies
administrative group membership for this link.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_type
TLV Type 1. Defines the type of link and is one octet in length.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_subtlvs
Allows the user to create custom type 10 Sub-TLVs with length 4 - for Traffic Engineering.
When both -opaque_link_subtlvs and -opaque_link_other_subtlvs are
provided then -opaque_link_subtlvs has a greater priority.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_lsa_config.py_part2
|
The IP address of the local interface for this link. Each address is
a 4-octet value. The total length is N times 4 octets, where N is the
number of addresses.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_max_bw
This will enable the usage of max bandwidth. TLV Type 6.
Units are in bytes per second. The maximum bandwidth that can be used
on this link in this direction (from originator to the neighbor).
Four octets in length, expressed in IEEE floating point format.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_max_resv_bw
This will enable the usage of max reservable bandwidth. TLV Type 7.
Units in bytes per second. The maximum bandwidth that can be reserved
on this link in this direction (from originator to the neighbor).
Four octets in length, expressed in IEEE floating point format. This
may be greater than the maximum bandwidth.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_metric
This will enable the usage of link metric. TLV Type 5.
The Traffic Engineering Metric.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_remote_ip_addr
This will enable the usage of the remote IP address. TLV Type 4.
The IP address of the neighbor's interface for this link. The total
length is N times four octets, where N is the number of addresses.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_resource_class
This will enable the usage of link resource class. TLV Type 9.
A bit mask value, four octets in length, which specifies
administrative group membership for this link.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_type
This will enable the usage of link type. TLV Type 1. Defines the type
of link and is one octet in length.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_enable_link_unresv_bw
This will enable the usage of the unreserved bandwidth. TLV Type 8.
The amount of bandwidth not yet reserved at each of the eight
priority levels. This value will be less than or equal to the maximum
reservable bandwidth. 32 octets in length, expressed in IEEE floating
point format. If checked, unreserved bandwidth may be assigned to
each of the 8 priority levels (0 through 7).
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_id
TLV Type 2. If checked, this will be the 4-octet IP address which
identifies the other end of the link.
For Point to Point, the Neighbor's Router ID.
For Multiaccess, the interface of the DR.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_local_ip_addr
TLV Type 3. The IP address of the local interface for this link.
Each address is a 4-octet value. The total length is N times 4 octets,
where N is the number of addresses.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_max_bw
TLV Type 6. Units are in bytes per second. The maximum bandwidth that
can be used on this link in this direction (from originator to the
neighbor). Four octets in length, expressed in IEEE floating point
format.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_max_resv_bw
TLV Type 7. Units in bytes per second. The maximum bandwidth that can
be reserved on this link in this direction (from originator to the
neighbor). Four octets in length, expressed in IEEE floating point
format. This may be greater than the maximum bandwidth.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_metric
TLV Type 5. The Traffic Engineering Metric. Four octets in length.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_remote_ip_addr
TLV Type 4. The IP address of the neighbor's interface for this link.
The total length is N times four octets, where N is the number of
addresses.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_resource_class
TLV Type 9. A bit mask value, four octets in length, which specifies
administrative group membership for this link.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_type
TLV Type 1. Defines the type of link and is one octet in length.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_link_subtlvs
Allows the user to create custom type 10 Sub-TLVs with length 4 - for Traffic Engineering.
When both -opaque_link_subtlvs and -opaque_link_other_subtlvs are
provided then -opaque_link_subtlvs has a greater priority.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
x -opaque_link_other_subtlvs
x Allows the user to create custom Sub-TLVs - for Traffic Engineering.
x To be provided with a list of parameters in the following format:
x <type>:<length>:<value>, where type is from 0 to 65535, length is a
x value from 0 to 65535 and value is a hex number preceeded by 0x with
x the length specified by <length> parameter.
x When both -opaque_link_subtlvs and -opaque_link_other_subtlvs are
x provided then -opaque_link_subtlvs has a greater priority.
x This option is valid only when type is opaque and opaque_tlv_type is link.
x This option is valid only for IxTclNetwork API.
-opaque_link_unresv_bw_priority
Unreserved Bandwidth in bytes per second per priority level.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_router_addr
TLVs are Type/Length/Value field combinations that make up part of the
LSA payload and enable OSPF Traffic Engineering (OSPF-TE).
If opaque_tlv_type is router, the field is for the four-octet IP
address of the advertising router.
This option is valid only when type is opaque and opaque_tlv_type is router.
This option is valid only for IxTclNetwork API.
-opaque_tlv_type
TLVs are Type/Length/Value field combinations that make up part of the
LSA payload and enable OSPF Traffic Engineering (OSPF-TE).
If opaque_tlv_type is router, the field is for the four-octet IP
address of the advertising router.
Otherwise, if opaque_tlv_type is link, all the other TLVs from 1-9 can
be enabled and used.
This option is valid only when type is opaque.
This option is valid only for IxTclNetwork API.
-options
The optional capabilities supported by the OSPFv2 router. For OSPFv3,
use OSPFv3 specific options.
Multiple options may becombined using a logical "or".
Valid choices are:
ospfOptionBitTypeOfService - 0x01
ospfOptionBitExternalRouting - 0x02
ospfOptionBitMulticast - 0x04
ospfOptionBitNSSACapability - 0x08
ospfOptionBitExternalAttributes - 0x10
ospfOptionBitDemandCircuit - 0x20
ospfOptionBitLSANoForward - 0x40
ospfOptionBitUnused - 0x80
x -prefix_options
x An 8-bit quantity with options related to the prefixAddress. Multiple
x bits may becombined using a logical or. If both options and prefix_options
x are provided, the options value takes priority.
x Valid choices are:
x ospfV3PrefixOptionPBit - 0x08--The propagate bit, which is set on
x NSSA area prefixes that should be re-advertised at
x the NSSA area border.
x ospfV3PrefixOptionMCBit - 0x04--The multicast capability bit, which
x should be set if the prefix should be included in IPv6
x multicast routing calculations.
x ospfV3PrefixOptionLABit - 0x02--The local address capability bit,
x which should be set if the prefix is actually an IPv6
x interface address of the advertising router.
x ospfV3PrefixOptionNUBit - 0x01--The no unicast bit, which should be
x set if the prefix should be excluded from IPv6 unicast
x calculations.
-router_abr
Set router to be an area boundary router (ABR). Correspond to E
(external) bit in router LSA.
-router_asbr
Set router to be an AS boundary router (ASBR). Correspond to B
(border) bit in router LSA.
-router_virtual_link_endpt
Set router to be an endpoint of an active virtual link. Correspond
to V (virtual link endpoint) bit in router LSA.
x -router_wildcard
x Indicates that the router is a wild-card multicast receiver and will
x receive multicast datagrams regardless of destination.
-router_link_mode
This option specifies the mode for configuring router links in a router
LSA.Note that the modify and delete mode do not work. Valid options are:
create
modify
delete
-router_link_id
Identifies the object that this router link connects to, depending on
the router_link_type option. Valid choices are:
ptop - The neighboring router s router ID.
transit - The IP address of the Designated Router.
stub - The IP network/subnet number.
virtual - The neighboring router s router ID.
-router_link_data
The meaning of this option depends on the router_link_type option.
Valid choices are:
ptop - The interface s MIB-II.
transit - The router interface s IP address.
stub - The network s IP address mask.
virtual - The router interface s IP address.
-router_link_type
The type of the router link. Valid choices are:
ptop - A point-to-point connection to another router.
transit - (default) A connection to a transit network.
stub - A connection a stub network.
virtual - A virtual link.
-router_link_metric
The cost of using the router link, applied to all TOS values.
-session_type
-summary_number_of_prefix
The number of Summary IP LSAs to generate.
-summary_prefix_start
This option is valid for OSPFv3 summary_pool route type. The prefix
address to be advertised in the LSA. Although only prefixLength
bits of the IPv6 address are meaningful, a full IPv6 address should
be specified.
-summary_prefix_length
The number of high-order bits of prefixAddress that are significant.
-summary_prefix_step
If summary_number_of_prefix is greater than 1, this is the value that
will be added to the most significant summary_prefix_length bits of
summary_prefix_start between generated LSAs.This is also the value
to increment the link_state_id, if link_state_id_step is not present.
This parameter can be provided as an IPv4/IPv6 address, depending on
the prefix type, but the corresponding number of the IP address
provided should not be greater than 4,294,967,295.
-summary_prefix_metric
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_lsa_config.py_part3
|
x -opaque_link_other_subtlvs
x Allows the user to create custom Sub-TLVs - for Traffic Engineering.
x To be provided with a list of parameters in the following format:
x <type>:<length>:<value>, where type is from 0 to 65535, length is a
x value from 0 to 65535 and value is a hex number preceeded by 0x with
x the length specified by <length> parameter.
x When both -opaque_link_subtlvs and -opaque_link_other_subtlvs are
x provided then -opaque_link_subtlvs has a greater priority.
x This option is valid only when type is opaque and opaque_tlv_type is link.
x This option is valid only for IxTclNetwork API.
-opaque_link_unresv_bw_priority
Unreserved Bandwidth in bytes per second per priority level.
This option is valid only when type is opaque and opaque_tlv_type is link.
This option is valid only for IxTclNetwork API.
-opaque_router_addr
TLVs are Type/Length/Value field combinations that make up part of the
LSA payload and enable OSPF Traffic Engineering (OSPF-TE).
If opaque_tlv_type is router, the field is for the four-octet IP
address of the advertising router.
This option is valid only when type is opaque and opaque_tlv_type is router.
This option is valid only for IxTclNetwork API.
-opaque_tlv_type
TLVs are Type/Length/Value field combinations that make up part of the
LSA payload and enable OSPF Traffic Engineering (OSPF-TE).
If opaque_tlv_type is router, the field is for the four-octet IP
address of the advertising router.
Otherwise, if opaque_tlv_type is link, all the other TLVs from 1-9 can
be enabled and used.
This option is valid only when type is opaque.
This option is valid only for IxTclNetwork API.
-options
The optional capabilities supported by the OSPFv2 router. For OSPFv3,
use OSPFv3 specific options.
Multiple options may becombined using a logical "or".
Valid choices are:
ospfOptionBitTypeOfService - 0x01
ospfOptionBitExternalRouting - 0x02
ospfOptionBitMulticast - 0x04
ospfOptionBitNSSACapability - 0x08
ospfOptionBitExternalAttributes - 0x10
ospfOptionBitDemandCircuit - 0x20
ospfOptionBitLSANoForward - 0x40
ospfOptionBitUnused - 0x80
x -prefix_options
x An 8-bit quantity with options related to the prefixAddress. Multiple
x bits may becombined using a logical or. If both options and prefix_options
x are provided, the options value takes priority.
x Valid choices are:
x ospfV3PrefixOptionPBit - 0x08--The propagate bit, which is set on
x NSSA area prefixes that should be re-advertised at
x the NSSA area border.
x ospfV3PrefixOptionMCBit - 0x04--The multicast capability bit, which
x should be set if the prefix should be included in IPv6
x multicast routing calculations.
x ospfV3PrefixOptionLABit - 0x02--The local address capability bit,
x which should be set if the prefix is actually an IPv6
x interface address of the advertising router.
x ospfV3PrefixOptionNUBit - 0x01--The no unicast bit, which should be
x set if the prefix should be excluded from IPv6 unicast
x calculations.
-router_abr
Set router to be an area boundary router (ABR). Correspond to E
(external) bit in router LSA.
-router_asbr
Set router to be an AS boundary router (ASBR). Correspond to B
(border) bit in router LSA.
-router_virtual_link_endpt
Set router to be an endpoint of an active virtual link. Correspond
to V (virtual link endpoint) bit in router LSA.
x -router_wildcard
x Indicates that the router is a wild-card multicast receiver and will
x receive multicast datagrams regardless of destination.
-router_link_mode
This option specifies the mode for configuring router links in a router
LSA.Note that the modify and delete mode do not work. Valid options are:
create
modify
delete
-router_link_id
Identifies the object that this router link connects to, depending on
the router_link_type option. Valid choices are:
ptop - The neighboring router s router ID.
transit - The IP address of the Designated Router.
stub - The IP network/subnet number.
virtual - The neighboring router s router ID.
-router_link_data
The meaning of this option depends on the router_link_type option.
Valid choices are:
ptop - The interface s MIB-II.
transit - The router interface s IP address.
stub - The network s IP address mask.
virtual - The router interface s IP address.
-router_link_type
The type of the router link. Valid choices are:
ptop - A point-to-point connection to another router.
transit - (default) A connection to a transit network.
stub - A connection a stub network.
virtual - A virtual link.
-router_link_metric
The cost of using the router link, applied to all TOS values.
-session_type
-summary_number_of_prefix
The number of Summary IP LSAs to generate.
-summary_prefix_start
This option is valid for OSPFv3 summary_pool route type. The prefix
address to be advertised in the LSA. Although only prefixLength
bits of the IPv6 address are meaningful, a full IPv6 address should
be specified.
-summary_prefix_length
The number of high-order bits of prefixAddress that are significant.
-summary_prefix_step
If summary_number_of_prefix is greater than 1, this is the value that
will be added to the most significant summary_prefix_length bits of
summary_prefix_start between generated LSAs.This is also the value
to increment the link_state_id, if link_state_id_step is not present.
This parameter can be provided as an IPv4/IPv6 address, depending on
the prefix type, but the corresponding number of the IP address
provided should not be greater than 4,294,967,295.
-summary_prefix_metric
The cost of the route for all TOS levels.
-type
This option specified the type of the LSA. The user *must* pass this option when creating a LSA. The choices are:
router- ospfv2, ospfv3
network- ospfv2, ospfv3
summary_pool- ospfv2, ospfv3
asbr_summary- ospfv2, ospfv3
ext_pool- ospfv2, ospfv3
opaque_type_9- ospfv2
opaque_type_10- ospfv2
opaque_type_11- ospfv2
n -auto_ls_age
n This argument defined by Cisco is not supported for NGPF implementation.
n -auto_ls_checksum
n This argument defined by Cisco is not supported for NGPF implementation.
n -auto_ls_seq
n This argument defined by Cisco is not supported for NGPF implementation.
n -auto_update
n This argument defined by Cisco is not supported for NGPF implementation.
n -ls_age
n This argument defined by Cisco is not supported for NGPF implementation.
n -ls_checksum
n This argument defined by Cisco is not supported for NGPF implementation.
n -ls_seq
n This argument defined by Cisco is not supported for NGPF implementation.
n -ls_type_s_bits
n This argument defined by Cisco is not supported for NGPF implementation.
n -ls_type_u_bit
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_number_of_prefix
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_forward_addr
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_length
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_metric
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_start
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_type
n This argument defined by Cisco is not supported for NGPF implementation.
n -router_link_idx
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_tlv_type
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_instance_id
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_router_address
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_link_id
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_link_type
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_metric
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_local_ip
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_remote_ip
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_admin_group
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_bw
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_bw
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority0
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority1
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority2
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority3
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority4
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority5
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority6
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority7
n This argument defined by Cisco is not supported for NGPF implementation.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
On status of failure, gives detailed information.
key:log value:On status of failure, gives detailed information.
key:lsa_handle value:
key:adv_router_id value:
key:For Router LSA value:
key:router.links.<idx = 0>.id value:
key:router.links.<idx = 0>.data value:
key:router.links.<idx = 0>.type value:
key:router.links.<idx = n>.id value:
key:router.links.<idx = n>.data value:
key:router.links.<idx = n>.type value:
key:For Network LSA value:
key:network.attached_router_ids value:
key:For Summary_Pool and ASBR_Summary LSA value:
key:summary.num_prefix value:
key:summary.prefix_start value:
key:summary.prefix_length value:
key:summary.prefix_step value:
key:For Ext_Pool LSA value:
key:external.num_prefix value:
key:external.prefix_start value:
key:external.prefix_length value:
key:external.prefix_step value:
Examples:
See files starting with OSPFv2 and OSPFv3 in the Samples subdirectory. Also see some of the L2VPN, L3VPN, MPLS, and MVPN sample files for further examples of the OSPF usage.
See the OSPF example in Appendix A, "Example APIs," for one specific example usage.
Sample Input:
.
Sample Output:
.
Notes:
1) Coded versus functional specification v5-3-6.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_lsa_config.py_part4
|
-summary_prefix_metric
The cost of the route for all TOS levels.
-type
This option specified the type of the LSA. The user *must* pass this option when creating a LSA. The choices are:
router- ospfv2, ospfv3
network- ospfv2, ospfv3
summary_pool- ospfv2, ospfv3
asbr_summary- ospfv2, ospfv3
ext_pool- ospfv2, ospfv3
opaque_type_9- ospfv2
opaque_type_10- ospfv2
opaque_type_11- ospfv2
n -auto_ls_age
n This argument defined by Cisco is not supported for NGPF implementation.
n -auto_ls_checksum
n This argument defined by Cisco is not supported for NGPF implementation.
n -auto_ls_seq
n This argument defined by Cisco is not supported for NGPF implementation.
n -auto_update
n This argument defined by Cisco is not supported for NGPF implementation.
n -ls_age
n This argument defined by Cisco is not supported for NGPF implementation.
n -ls_checksum
n This argument defined by Cisco is not supported for NGPF implementation.
n -ls_seq
n This argument defined by Cisco is not supported for NGPF implementation.
n -ls_type_s_bits
n This argument defined by Cisco is not supported for NGPF implementation.
n -ls_type_u_bit
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_number_of_prefix
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_forward_addr
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_length
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_metric
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_start
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -nssa_prefix_type
n This argument defined by Cisco is not supported for NGPF implementation.
n -router_link_idx
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_tlv_type
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_instance_id
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_router_address
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_link_id
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_link_type
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_metric
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_local_ip
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_remote_ip
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_admin_group
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_bw
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_bw
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority0
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority1
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority2
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority3
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority4
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority5
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority6
n This argument defined by Cisco is not supported for NGPF implementation.
n -te_max_resv_priority7
n This argument defined by Cisco is not supported for NGPF implementation.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
On status of failure, gives detailed information.
key:log value:On status of failure, gives detailed information.
key:lsa_handle value:
key:adv_router_id value:
key:For Router LSA value:
key:router.links.<idx = 0>.id value:
key:router.links.<idx = 0>.data value:
key:router.links.<idx = 0>.type value:
key:router.links.<idx = n>.id value:
key:router.links.<idx = n>.data value:
key:router.links.<idx = n>.type value:
key:For Network LSA value:
key:network.attached_router_ids value:
key:For Summary_Pool and ASBR_Summary LSA value:
key:summary.num_prefix value:
key:summary.prefix_start value:
key:summary.prefix_length value:
key:summary.prefix_step value:
key:For Ext_Pool LSA value:
key:external.num_prefix value:
key:external.prefix_start value:
key:external.prefix_length value:
key:external.prefix_step value:
Examples:
See files starting with OSPFv2 and OSPFv3 in the Samples subdirectory. Also see some of the L2VPN, L3VPN, MPLS, and MVPN sample files for further examples of the OSPF usage.
See the OSPF example in Appendix A, "Example APIs," for one specific example usage.
Sample Input:
.
Sample Output:
.
Notes:
1) Coded versus functional specification v5-3-6.
2) In OSPFv3, asbr_summary type and the summary_prefix_length field do not
apply and are not returned in returnList.
Caveats: Due to the problem with getting item with local lable ID, there
are the following limitations:
- handle (ospf_session_handle) must be gotten within the same wish
shell.
- router_link_mode of modify and delete is not supported.
- net_attached_router of delete and reset is not supported.
- For OSPFv3, only one lsa can be created per router handle.
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_ospf_lsa_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_lsa_config.py_part5
|
2) In OSPFv3, asbr_summary type and the summary_prefix_length field do not
apply and are not returned in returnList.
Caveats: Due to the problem with getting item with local lable ID, there
are the following limitations:
- handle (ospf_session_handle) must be gotten within the same wish
shell.
- router_link_mode of modify and delete is not supported.
- net_attached_router of delete and reset is not supported.
- For OSPFv3, only one lsa can be created per router handle.
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_ospf_lsa_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_lsa_config.py_part6
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_dhcp_control(self, **kwargs):
r'''
#Procedure Header
Name:
emulation_dhcp_control
Description:
This procedure starts, stops, and restarts the DHCP emulation client on the specified port.
Synopsis:
emulation_dhcp_control
[-port_handle ANY]
[-handle ANY]
n [-no_write ANY]
n [-request_rate ANY]
x [-ping_destination IP]
[-action CHOICES bind
CHOICES release
CHOICES renew
CHOICES inform
CHOICES abort
CHOICES abort_async
CHOICES restart_down
CHOICES rebind
CHOICES send_ping
CHOICES start_relay_agent
CHOICES stop_relay_agent
CHOICES send_arp
DEFAULT bind]
Arguments:
-port_handle
Specifies the port handle upon which emulation is configured.
Emulation must have been previously enabled on the specified port
via a call to emulation_dhcp_group_config proc.
-handle
Allows the user to optionally select the groups to which the
specified action is to be applied.
If this parameter is not specified, then the specified action is
applied to all groups configured on the port specified by
the -port_handle command. The handle is obtained from the keyed list returned
in the call to emulation_dhcp_group_config proc.
The port handle parameter must have been initialized and dhcp group
emulation must have been configured prior to calling this function.
n -no_write
n This argument defined by Cisco is not supported for NGPF implementation.
n -request_rate
n This argument defined by Cisco is not supported for NGPF implementation.
x -ping_destination
x Specifies the ip destination for ping.
-action
Action to take on the specified handle.
The parameters specified in the emulation_dhcp_group_config proc
are used to control the bind/renew/release rates.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
When status is failure, contains more information
key:log value:When status is failure, contains more information
0 if the ping request failed on any of the interfaces. Available only with action -send_ping and -ping_destination is specified.
key:<handle>.ping_success value:0 if the ping request failed on any of the interfaces. Available only with action -send_ping and -ping_destination is specified.
Detailed status of the ping request on the specified dhcp client handle. Available only with action -send_ping and -ping_destination is specified.
key:<handle>.ping_details value:Detailed status of the ping request on the specified dhcp client handle. Available only with action -send_ping and -ping_destination is specified.
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_dhcp_control',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_dhcp_control.py_part1
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def ptp_over_ip_stats(self, mode, **kwargs):
r'''
#Procedure Header
Name:
ptp_over_ip_stats
Description:
Retrieve statistics plane on an endpoint created
by a ::ixiangpf::ptp_over_ip_config command
Synopsis:
ptp_over_ip_stats
[-handle ANY]
[-port_handle ANY]
x -mode CHOICES aggregate session
Arguments:
-handle
The PTP handle for which the PTP statistics are to be retrieved. Valid for -mode session.
-port_handle
The port handle for which the ptp_over_ip stats need to
be retrieved
x -mode
x Specifies statistics retrieval mode as either aggregate for all
x configured sessions or on a per session basis.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
When status is failure, contains more information
key:log value:When status is failure, contains more information
Port Name
key:[<port_handle.>].gen.port_name value:Port Name
Sessions Up
key:[<port_handle.>].gen.sessions_up value:Sessions Up
Sessions Down
key:[<port_handle.>].gen.sessions_down value:Sessions Down
Sessions Not Started
key:[<port_handle.>].gen.sessions_not_started value:Sessions Not Started
Sessions Total
key:[<port_handle.>].gen.sessions_total value:Sessions Total
Sessions Active
key:[<port_handle.>].gen.sessions_active value:Sessions Active
Announce Messages Sent
key:[<port_handle.>].gen.announce_messages_sent value:Announce Messages Sent
Announce Messages Received
key:[<port_handle.>].gen.announce_messages_received value:Announce Messages Received
Sync Messages Sent
key:[<port_handle.>].gen.sync_messages_sent value:Sync Messages Sent
Sync Messages Received
key:[<port_handle.>].gen.sync_messages_received value:Sync Messages Received
FollowUp Messages Sent
key:[<port_handle.>].gen.followup_messages_sent value:FollowUp Messages Sent
FollowUp Messages Received
key:[<port_handle.>].gen.followup_messages_received value:FollowUp Messages Received
DelayReq Messages Sent
key:[<port_handle.>].gen.delayreq_messages_sent value:DelayReq Messages Sent
DelayReq Messages Received
key:[<port_handle.>].gen.delayreq_messages_received value:DelayReq Messages Received
DelayResp Messages Sent
key:[<port_handle.>].gen.delayresp_messages_sent value:DelayResp Messages Sent
DelayResp Messages Received
key:[<port_handle.>].gen.delayresp_messages_received value:DelayResp Messages Received
PdelayReq Messages Sent
key:[<port_handle.>].gen.pdelayreq_messages_sent value:PdelayReq Messages Sent
PdelayReq Messages Received
key:[<port_handle.>].gen.pdelayreq_messages_received value:PdelayReq Messages Received
PdelayResp Messages Sent
key:[<port_handle.>].gen.pdelayresp_messages_sent value:PdelayResp Messages Sent
PdelayResp Messages Received
key:[<port_handle.>].gen.pdelayrest_messages_received value:PdelayResp Messages Received
PdelayRespFollowUp Messages Sent
key:[<port_handle.>].gen.pdelayrespfollowup_messages_sent value:PdelayRespFollowUp Messages Sent
PdelayRespFollowUp Messages Received
key:[<port_handle.>].gen.pdelayrespfollowup_messages_received value:PdelayRespFollowUp Messages Received
Signaling Messages Sent
key:[<port_handle.>].gen.signaling_messages_sent value:Signaling Messages Sent
Signaling Messages Received
key:[<port_handle.>].gen.signaling_messages_received value:Signaling Messages Received
Sync Messages Received Rate
key:[<port_handle.>].gen.sync_messages_received_rate value:Sync Messages Received Rate
FollowUp Messages Received Rate
key:[<port_handle.>].gen.followup_messages_received_rate value:FollowUp Messages Received Rate
DelayReq Messages Received Rate
key:[<port_handle.>].gen.delayreq_messages_received_rate value:DelayReq Messages Received Rate
DelayResp Messages Received Rate
key:[<port_handle.>].gen.delayresp_messages_received_rate value:DelayResp Messages Received Rate
PdelayReq Messages Received Rate
key:[<port_handle.>].gen.pdelayreq_messages_received_rate value:PdelayReq Messages Received Rate
PdelayResp Messages Received Rate
key:[<port_handle.>].gen.pdelayresp_messages_received_rate value:PdelayResp Messages Received Rate
PdelayRespFollowUp Messages Received Rate
key:[<port_handle.>].gen.pdelayrespfollowup_messages_received_rate value:PdelayRespFollowUp Messages Received Rate
GPS Unit Present
key:[<port_handle.>].gen.gps_unit_present value:GPS Unit Present
GPS Synchronized
key:[<port_handle.>].gen.gps_synchronized value:GPS Synchronized
Sessions Up
key:[<handle.>].gen.sessions_up value:Sessions Up
Sessions Down
key:[<handle.>].gen.sessions_down value:Sessions Down
Sessions Not Started
key:[<handle.>].gen.sessions_not_started value:Sessions Not Started
Sessions Total
key:[<handle.>].gen.sessions_total value:Sessions Total
Sessions Active
key:[<handle.>].gen.sessions_active value:Sessions Active
Announce Messages Sent
key:[<handle.>].gen.announce_messages_sent value:Announce Messages Sent
Announce Messages Received
key:[<handle.>].gen.announce_messages_received value:Announce Messages Received
Sync Messages Sent
key:[<handle.>].gen.sync_messages_sent value:Sync Messages Sent
Sync Messages Received
key:[<handle.>].gen.sync_messages_received value:Sync Messages Received
FollowUp Messages Sent
key:[<handle.>].gen.followup_messages_sent value:FollowUp Messages Sent
FollowUp Messages Received
key:[<handle.>].gen.followup_messages_received value:FollowUp Messages Received
DelayReq Messages Sent
key:[<handle.>].gen.delayreq_messages_sent value:DelayReq Messages Sent
DelayReq Messages Received
key:[<handle.>].gen.delayreq_messages_received value:DelayReq Messages Received
DelayResp Messages Sent
key:[<handle.>].gen.delayresp_messages_sent value:DelayResp Messages Sent
DelayResp Messages Received
key:[<handle.>].gen.delayresp_messages_received value:DelayResp Messages Received
PdelayReq Messages Sent
key:[<handle.>].gen.pdelayreq_messages_sent value:PdelayReq Messages Sent
PdelayReq Messages Received
key:[<handle.>].gen.pdelayreq_messages_received value:PdelayReq Messages Received
PdelayResp Messages Sent
key:[<handle.>].gen.pdelayresp_messages_sent value:PdelayResp Messages Sent
PdelayResp Messages Received
key:[<handle.>].gen.pdelayrest_messages_received value:PdelayResp Messages Received
PdelayRespFollowUp Messages Sent
key:[<handle.>].gen.pdelayrespfollowup_messages_sent value:PdelayRespFollowUp Messages Sent
PdelayRespFollowUp Messages Received
key:[<handle.>].gen.pdelayrespfollowup_messages_received value:PdelayRespFollowUp Messages Received
Signaling Messages Sent
key:[<handle.>].gen.signaling_messages_sent value:Signaling Messages Sent
Signaling Messages Received
key:[<handle.>].gen.signaling_messages_received value:Signaling Messages Received
Status
key:session.<session ID>.status value:Status
Configured Role
key:session.<session ID>.configured_role value:Configured Role
PTP State
key:session.<session ID>.ptp_state value:PTP State
Offset [ns]
key:session.<session ID>.offset value:Offset [ns]
Max Offset [ns]
key:session.<session ID>.offset_max value:Max Offset [ns]
Min Offset [ns]
key:session.<session ID>.offset_min value:Min Offset [ns]
Avg Offset [ns]
key:session.<session ID>.offset_avg value:Avg Offset [ns]
Path Delay [ns]
key:session.<session ID>.path_delay value:Path Delay [ns]
Max Path Delay [ns]
key:session.<session ID>.path_delay_max value:Max Path Delay [ns]
Min Path Delay [ns]
key:session.<session ID>.path_delay_min value:Min Path Delay [ns]
Avg Path Delay [ns]
key:session.<session ID>.path_delay_avg value:Avg Path Delay [ns]
Time Slope
key:session.<session ID>.time_slope value:Time Slope
Port Identity
key:session.<session ID>.port_identity value:Port Identity
Master Port Identity
key:session.<session ID>.master_port_identity value:Master Port Identity
Grandmaster Port Identity
key:session.<session ID>.grandmaster_port_identity value:Grandmaster Port Identity
Local Clock Class
key:session.<session ID>.port_clock_class value:Local Clock Class
Master Clock Class
key:session.<session ID>.master_clock_class value:Master Clock Class
Local Clock Accuracy
key:session.<session ID>.port_clock_accuracy value:Local Clock Accuracy
Master Clock Accuracy
key:session.<session ID>.master_clock_accuracy value:Master Clock Accuracy
Current UTC Offset
key:session.<session ID>.current_utc_offset value:Current UTC Offset
Steps Removed
key:session.<session ID>.steps_removed value:Steps Removed
Leap59
key:session.<session ID>.leap59 value:Leap59
Leap61
key:session.<session ID>.leap61 value:Leap61
Frequency Traceable
key:session.<session ID>.frequency_traceable value:Frequency Traceable
Time Traceable
key:session.<session ID>.time_traceable value:Time Traceable
CF Sync [ns]
key:session.<session ID>.cf_sync value:CF Sync [ns]
CF Sync Max [ns]
key:session.<session ID>.cf_sync_max value:CF Sync Max [ns]
CF Sync Min [ns]
key:session.<session ID>.cf_sync_min value:CF Sync Min [ns]
CF FollowUp [ns]
key:session.<session ID>.cf_follow_up value:CF FollowUp [ns]
CF FollowUp Max [ns]
key:session.<session ID>.cf_follow_up_max value:CF FollowUp Max [ns]
CF FollowUp Min [ns]
key:session.<session ID>.cf_follow_up_min value:CF FollowUp Min [ns]
CF DelayReq [ns]
key:session.<session ID>.cf_delay_req value:CF DelayReq [ns]
CF DelayReq Max [ns]
key:session.<session ID>.cf_delay_req_max value:CF DelayReq Max [ns]
CF DelayReq Min [ns]
key:session.<session ID>.cf_delay_req_min value:CF DelayReq Min [ns]
CF PdelayReq [ns]
key:session.<session ID>.cf_pdelay_req value:CF PdelayReq [ns]
CF PdelayReq Max [ns]
key:session.<session ID>.cf_pdelay_req_max value:CF PdelayReq Max [ns]
CF PdelayReq Min [ns]
key:session.<session ID>.cf_pdelay_req_min value:CF PdelayReq Min [ns]
CF DelayResp [ns]
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ptp_over_ip_stats.py_part1
|
Sync Messages Sent
key:[<handle.>].gen.sync_messages_sent value:Sync Messages Sent
Sync Messages Received
key:[<handle.>].gen.sync_messages_received value:Sync Messages Received
FollowUp Messages Sent
key:[<handle.>].gen.followup_messages_sent value:FollowUp Messages Sent
FollowUp Messages Received
key:[<handle.>].gen.followup_messages_received value:FollowUp Messages Received
DelayReq Messages Sent
key:[<handle.>].gen.delayreq_messages_sent value:DelayReq Messages Sent
DelayReq Messages Received
key:[<handle.>].gen.delayreq_messages_received value:DelayReq Messages Received
DelayResp Messages Sent
key:[<handle.>].gen.delayresp_messages_sent value:DelayResp Messages Sent
DelayResp Messages Received
key:[<handle.>].gen.delayresp_messages_received value:DelayResp Messages Received
PdelayReq Messages Sent
key:[<handle.>].gen.pdelayreq_messages_sent value:PdelayReq Messages Sent
PdelayReq Messages Received
key:[<handle.>].gen.pdelayreq_messages_received value:PdelayReq Messages Received
PdelayResp Messages Sent
key:[<handle.>].gen.pdelayresp_messages_sent value:PdelayResp Messages Sent
PdelayResp Messages Received
key:[<handle.>].gen.pdelayrest_messages_received value:PdelayResp Messages Received
PdelayRespFollowUp Messages Sent
key:[<handle.>].gen.pdelayrespfollowup_messages_sent value:PdelayRespFollowUp Messages Sent
PdelayRespFollowUp Messages Received
key:[<handle.>].gen.pdelayrespfollowup_messages_received value:PdelayRespFollowUp Messages Received
Signaling Messages Sent
key:[<handle.>].gen.signaling_messages_sent value:Signaling Messages Sent
Signaling Messages Received
key:[<handle.>].gen.signaling_messages_received value:Signaling Messages Received
Status
key:session.<session ID>.status value:Status
Configured Role
key:session.<session ID>.configured_role value:Configured Role
PTP State
key:session.<session ID>.ptp_state value:PTP State
Offset [ns]
key:session.<session ID>.offset value:Offset [ns]
Max Offset [ns]
key:session.<session ID>.offset_max value:Max Offset [ns]
Min Offset [ns]
key:session.<session ID>.offset_min value:Min Offset [ns]
Avg Offset [ns]
key:session.<session ID>.offset_avg value:Avg Offset [ns]
Path Delay [ns]
key:session.<session ID>.path_delay value:Path Delay [ns]
Max Path Delay [ns]
key:session.<session ID>.path_delay_max value:Max Path Delay [ns]
Min Path Delay [ns]
key:session.<session ID>.path_delay_min value:Min Path Delay [ns]
Avg Path Delay [ns]
key:session.<session ID>.path_delay_avg value:Avg Path Delay [ns]
Time Slope
key:session.<session ID>.time_slope value:Time Slope
Port Identity
key:session.<session ID>.port_identity value:Port Identity
Master Port Identity
key:session.<session ID>.master_port_identity value:Master Port Identity
Grandmaster Port Identity
key:session.<session ID>.grandmaster_port_identity value:Grandmaster Port Identity
Local Clock Class
key:session.<session ID>.port_clock_class value:Local Clock Class
Master Clock Class
key:session.<session ID>.master_clock_class value:Master Clock Class
Local Clock Accuracy
key:session.<session ID>.port_clock_accuracy value:Local Clock Accuracy
Master Clock Accuracy
key:session.<session ID>.master_clock_accuracy value:Master Clock Accuracy
Current UTC Offset
key:session.<session ID>.current_utc_offset value:Current UTC Offset
Steps Removed
key:session.<session ID>.steps_removed value:Steps Removed
Leap59
key:session.<session ID>.leap59 value:Leap59
Leap61
key:session.<session ID>.leap61 value:Leap61
Frequency Traceable
key:session.<session ID>.frequency_traceable value:Frequency Traceable
Time Traceable
key:session.<session ID>.time_traceable value:Time Traceable
CF Sync [ns]
key:session.<session ID>.cf_sync value:CF Sync [ns]
CF Sync Max [ns]
key:session.<session ID>.cf_sync_max value:CF Sync Max [ns]
CF Sync Min [ns]
key:session.<session ID>.cf_sync_min value:CF Sync Min [ns]
CF FollowUp [ns]
key:session.<session ID>.cf_follow_up value:CF FollowUp [ns]
CF FollowUp Max [ns]
key:session.<session ID>.cf_follow_up_max value:CF FollowUp Max [ns]
CF FollowUp Min [ns]
key:session.<session ID>.cf_follow_up_min value:CF FollowUp Min [ns]
CF DelayReq [ns]
key:session.<session ID>.cf_delay_req value:CF DelayReq [ns]
CF DelayReq Max [ns]
key:session.<session ID>.cf_delay_req_max value:CF DelayReq Max [ns]
CF DelayReq Min [ns]
key:session.<session ID>.cf_delay_req_min value:CF DelayReq Min [ns]
CF PdelayReq [ns]
key:session.<session ID>.cf_pdelay_req value:CF PdelayReq [ns]
CF PdelayReq Max [ns]
key:session.<session ID>.cf_pdelay_req_max value:CF PdelayReq Max [ns]
CF PdelayReq Min [ns]
key:session.<session ID>.cf_pdelay_req_min value:CF PdelayReq Min [ns]
CF DelayResp [ns]
key:session.<session ID>.cf_delay_resp value:CF DelayResp [ns]
CF DelayResp Max [ns]
key:session.<session ID>.cf_delay_resp_max value:CF DelayResp Max [ns]
CF DelayResp Min [ns]
key:session.<session ID>.cf_delay_resp_min value:CF DelayResp Min [ns]
CF PdelayResp [ns]
key:session.<session ID>.cf_pdelay_resp value:CF PdelayResp [ns]
CF PdelayResp Max [ns]
key:session.<session ID>.cf_pdelay_resp_max value:CF PdelayResp Max [ns]
CF PdelayResp Min [ns]
key:session.<session ID>.cf_pdelay_resp_min value:CF PdelayResp Min [ns]
CF PdelayRespFollowUp [ns]
key:session.<session ID>.cf_pdelay_resp_follow_up value:CF PdelayRespFollowUp [ns]
CF PdelayRespFollowUp Max [ns]
key:session.<session ID>.cf_pdelay_resp_follow_up_max value:CF PdelayRespFollowUp Max [ns]
CF PdelayRespFollowUp Min [ns]
key:session.<session ID>.cf_pdelay_resp_follow_up_min value:CF PdelayRespFollowUp Min [ns]
FM 0 Identity
key:session.<session ID>.fm_identity_0 value:FM 0 Identity
FM 0 Port Number
key:session.<session ID>.fm_portNum_0 value:FM 0 Port Number
FM 1 Identity
key:session.<session ID>.fm_identity_1 value:FM 1 Identity
FM 1 Port Number
key:session.<session ID>.fm_port_num_1 value:FM 1 Port Number
FM 2 Identity
key:session.<session ID>.fm_identity_2 value:FM 2 Identity
FM 2 Port Number
key:session.<session ID>.fm_port_num_2 value:FM 2 Port Number
FM 3 Identity
key:session.<session ID>.fm_identity_3 value:FM 3 Identity
FM 3 Port Number
key:session.<session ID>.fm_port_num_3 value:FM 3 Port Number
FM 4 Identity
key:session.<session ID>.fm_identity_4 value:FM 4 Identity
FM 4 Port Number
key:session.<session ID>.fm_port_num_4 value:FM 4 Port Number
Time t1 [ns]
key:session.<session ID>.time_t1 value:Time t1 [ns]
Time t2 [ns]
key:session.<session ID>.time_t2 value:Time t2 [ns]
Time t3 [ns]
key:session.<session ID>.time_t3 value:Time t3 [ns]
Time t4 [ns]
key:session.<session ID>.time_t4 value:Time t4 [ns]
Time t1 UTC
key:session.<session ID>.t1_utc value:Time t1 UTC
Time t2 UTC
key:session.<session ID>.t2_utc value:Time t2 UTC
Time t3 UTC
key:session.<session ID>.t3_utc value:Time t3 UTC
Time t4 UTC
key:session.<session ID>.t4_utc value:Time t4 UTC
IA Announce [ns]
key:session.<session ID>.ia_announce value:IA Announce [ns]
IA Announce Max [ns]
key:session.<session ID>.ia_announce_max value:IA Announce Max [ns]
IA Announce Min [ns]
key:session.<session ID>.ia_announce_min value:IA Announce Min [ns]
IA Sync [ns]
key:session.<session ID>.ia_sync value:IA Sync [ns]
IA Sync Max [ns]
key:session.<session ID>.ia_sync_max value:IA Sync Max [ns]
IA Sync Min [ns]
key:session.<session ID>.ia_sync_min value:IA Sync Min [ns]
IA FollowUp [ns]
key:session.<session ID>.ia_follow_up value:IA FollowUp [ns]
IA FollowUp Max [ns]
key:session.<session ID>.ia_follow_up_max value:IA FollowUp Max [ns]
IA FollowUp Min [ns]
key:session.<session ID>.ia_follow_up_min value:IA FollowUp Min [ns]
IA DelayReq [ns]
key:session.<session ID>.ia_delay_req value:IA DelayReq [ns]
IA DelayReq Max [ns]
key:session.<session ID>.ia_delay_req_max value:IA DelayReq Max [ns]
IA DelayReq Min [ns]
key:session.<session ID>.ia_delay_req_min value:IA DelayReq Min [ns]
IA DelayResp [ns]
key:session.<session ID>.ia_delay_resp value:IA DelayResp [ns]
IA DelayResp Max [ns]
key:session.<session ID>.ia_delay_resp_max value:IA DelayResp Max [ns]
IA DelayResp Min [ns]
key:session.<session ID>.ia_delay_resp_min value:IA DelayResp Min [ns]
IA PdelayReq [ns]
key:session.<session ID>.ia_pdelay_req value:IA PdelayReq [ns]
IA PdelayReq Max [ns]
key:session.<session ID>.ia_pdelay_req_max value:IA PdelayReq Max [ns]
IA PdelayReq Min [ns]
key:session.<session ID>.ia_pdelay_req_min value:IA PdelayReq Min [ns]
IA PdelayResp [ns]
key:session.<session ID>.ia_pdelay_resp value:IA PdelayResp [ns]
IA PdelayResp Max [ns]
key:session.<session ID>.ia_pdelay_resp_max value:IA PdelayResp Max [ns]
IA PdelayResp Min [ns]
key:session.<session ID>.ia_pdelay_resp_min value:IA PdelayResp Min [ns]
IA PdelayRespFollowUp [ns]
key:session.<session ID>.ia_pdelay_resp_follow_up value:IA PdelayRespFollowUp [ns]
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ptp_over_ip_stats.py_part2
|
key:session.<session ID>.cf_delay_resp value:CF DelayResp [ns]
CF DelayResp Max [ns]
key:session.<session ID>.cf_delay_resp_max value:CF DelayResp Max [ns]
CF DelayResp Min [ns]
key:session.<session ID>.cf_delay_resp_min value:CF DelayResp Min [ns]
CF PdelayResp [ns]
key:session.<session ID>.cf_pdelay_resp value:CF PdelayResp [ns]
CF PdelayResp Max [ns]
key:session.<session ID>.cf_pdelay_resp_max value:CF PdelayResp Max [ns]
CF PdelayResp Min [ns]
key:session.<session ID>.cf_pdelay_resp_min value:CF PdelayResp Min [ns]
CF PdelayRespFollowUp [ns]
key:session.<session ID>.cf_pdelay_resp_follow_up value:CF PdelayRespFollowUp [ns]
CF PdelayRespFollowUp Max [ns]
key:session.<session ID>.cf_pdelay_resp_follow_up_max value:CF PdelayRespFollowUp Max [ns]
CF PdelayRespFollowUp Min [ns]
key:session.<session ID>.cf_pdelay_resp_follow_up_min value:CF PdelayRespFollowUp Min [ns]
FM 0 Identity
key:session.<session ID>.fm_identity_0 value:FM 0 Identity
FM 0 Port Number
key:session.<session ID>.fm_portNum_0 value:FM 0 Port Number
FM 1 Identity
key:session.<session ID>.fm_identity_1 value:FM 1 Identity
FM 1 Port Number
key:session.<session ID>.fm_port_num_1 value:FM 1 Port Number
FM 2 Identity
key:session.<session ID>.fm_identity_2 value:FM 2 Identity
FM 2 Port Number
key:session.<session ID>.fm_port_num_2 value:FM 2 Port Number
FM 3 Identity
key:session.<session ID>.fm_identity_3 value:FM 3 Identity
FM 3 Port Number
key:session.<session ID>.fm_port_num_3 value:FM 3 Port Number
FM 4 Identity
key:session.<session ID>.fm_identity_4 value:FM 4 Identity
FM 4 Port Number
key:session.<session ID>.fm_port_num_4 value:FM 4 Port Number
Time t1 [ns]
key:session.<session ID>.time_t1 value:Time t1 [ns]
Time t2 [ns]
key:session.<session ID>.time_t2 value:Time t2 [ns]
Time t3 [ns]
key:session.<session ID>.time_t3 value:Time t3 [ns]
Time t4 [ns]
key:session.<session ID>.time_t4 value:Time t4 [ns]
Time t1 UTC
key:session.<session ID>.t1_utc value:Time t1 UTC
Time t2 UTC
key:session.<session ID>.t2_utc value:Time t2 UTC
Time t3 UTC
key:session.<session ID>.t3_utc value:Time t3 UTC
Time t4 UTC
key:session.<session ID>.t4_utc value:Time t4 UTC
IA Announce [ns]
key:session.<session ID>.ia_announce value:IA Announce [ns]
IA Announce Max [ns]
key:session.<session ID>.ia_announce_max value:IA Announce Max [ns]
IA Announce Min [ns]
key:session.<session ID>.ia_announce_min value:IA Announce Min [ns]
IA Sync [ns]
key:session.<session ID>.ia_sync value:IA Sync [ns]
IA Sync Max [ns]
key:session.<session ID>.ia_sync_max value:IA Sync Max [ns]
IA Sync Min [ns]
key:session.<session ID>.ia_sync_min value:IA Sync Min [ns]
IA FollowUp [ns]
key:session.<session ID>.ia_follow_up value:IA FollowUp [ns]
IA FollowUp Max [ns]
key:session.<session ID>.ia_follow_up_max value:IA FollowUp Max [ns]
IA FollowUp Min [ns]
key:session.<session ID>.ia_follow_up_min value:IA FollowUp Min [ns]
IA DelayReq [ns]
key:session.<session ID>.ia_delay_req value:IA DelayReq [ns]
IA DelayReq Max [ns]
key:session.<session ID>.ia_delay_req_max value:IA DelayReq Max [ns]
IA DelayReq Min [ns]
key:session.<session ID>.ia_delay_req_min value:IA DelayReq Min [ns]
IA DelayResp [ns]
key:session.<session ID>.ia_delay_resp value:IA DelayResp [ns]
IA DelayResp Max [ns]
key:session.<session ID>.ia_delay_resp_max value:IA DelayResp Max [ns]
IA DelayResp Min [ns]
key:session.<session ID>.ia_delay_resp_min value:IA DelayResp Min [ns]
IA PdelayReq [ns]
key:session.<session ID>.ia_pdelay_req value:IA PdelayReq [ns]
IA PdelayReq Max [ns]
key:session.<session ID>.ia_pdelay_req_max value:IA PdelayReq Max [ns]
IA PdelayReq Min [ns]
key:session.<session ID>.ia_pdelay_req_min value:IA PdelayReq Min [ns]
IA PdelayResp [ns]
key:session.<session ID>.ia_pdelay_resp value:IA PdelayResp [ns]
IA PdelayResp Max [ns]
key:session.<session ID>.ia_pdelay_resp_max value:IA PdelayResp Max [ns]
IA PdelayResp Min [ns]
key:session.<session ID>.ia_pdelay_resp_min value:IA PdelayResp Min [ns]
IA PdelayRespFollowUp [ns]
key:session.<session ID>.ia_pdelay_resp_follow_up value:IA PdelayRespFollowUp [ns]
IA PdelayRespFollowUp Max [ns]
key:session.<session ID>.ia_pdelay_resp_follow_up_max value:IA PdelayRespFollowUp Max [ns]
IA PdelayRespFollowUp Min [ns]
key:session.<session ID>.ia_pdelay_resp_follow_up_min value:IA PdelayRespFollowUp Min [ns]
Announce Messages Sent
key:session.<session ID>.announce_messages_sent value:Announce Messages Sent
Announce Messages Received
key:session.<session ID>.announce_messages_received value:Announce Messages Received
Sync Messages Sent
key:session.<session ID>.sync_messages_sent value:Sync Messages Sent
Sync Messages Received
key:session.<session ID>.sync_messages_received value:Sync Messages Received
FollowUp Messages Sent
key:session.<session ID>.followup_messages_sent value:FollowUp Messages Sent
FollowUp Messages Received
key:session.<session ID>.followup_messages_received value:FollowUp Messages Received
DelayReq Messages Sent
key:session.<session ID>.delayreq_messages_sent value:DelayReq Messages Sent
DelayReq Messages Received
key:session.<session ID>.delayreq_messages_received value:DelayReq Messages Received
DelayResp Messages Sent
key:session.<session ID>.delayresp_messages_sent value:DelayResp Messages Sent
DelayResp Messages Received
key:session.<session ID>.delayresp_messages_received value:DelayResp Messages Received
PdelayReq Messages Sent
key:session.<session ID>.pdelayreq_messages_sent value:PdelayReq Messages Sent
PdelayReq Messages Received
key:session.<session ID>.pdelayreq_messages_received value:PdelayReq Messages Received
PdelayResp Messages Sent
key:session.<session ID>.pdelayresp_messages_sent value:PdelayResp Messages Sent
PdelayResp Messages Received
key:session.<session ID>.pdelayrest_messages_received value:PdelayResp Messages Received
PdelayRespFollowUp Messages Sent
key:session.<session ID>.pdelayrespfollowup_messages_sent value:PdelayRespFollowUp Messages Sent
PdelayRespFollowUp Messages Received
key:session.<session ID>.pdelayrespfollowup_messages_received value:PdelayRespFollowUp Messages Received
Signaling Messages Sent
key:session.<session ID>.signaling_messages_sent value:Signaling Messages Sent
Signaling Messages Received
key:session.<session ID>.signaling_messages_received value:Signaling Messages Received
Sync Messages Received Rate
key:session.<session ID>.sync_messages_received_rate value:Sync Messages Received Rate
FollowUp Messages Received Rate
key:session.<session ID>.followup_messages_received_rate value:FollowUp Messages Received Rate
DelayReq Messages Received Rate
key:session.<session ID>.delayreq_messages_received_rate value:DelayReq Messages Received Rate
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'ptp_over_ip_stats',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ptp_over_ip_stats.py_part3
|
IA PdelayRespFollowUp Max [ns]
key:session.<session ID>.ia_pdelay_resp_follow_up_max value:IA PdelayRespFollowUp Max [ns]
IA PdelayRespFollowUp Min [ns]
key:session.<session ID>.ia_pdelay_resp_follow_up_min value:IA PdelayRespFollowUp Min [ns]
Announce Messages Sent
key:session.<session ID>.announce_messages_sent value:Announce Messages Sent
Announce Messages Received
key:session.<session ID>.announce_messages_received value:Announce Messages Received
Sync Messages Sent
key:session.<session ID>.sync_messages_sent value:Sync Messages Sent
Sync Messages Received
key:session.<session ID>.sync_messages_received value:Sync Messages Received
FollowUp Messages Sent
key:session.<session ID>.followup_messages_sent value:FollowUp Messages Sent
FollowUp Messages Received
key:session.<session ID>.followup_messages_received value:FollowUp Messages Received
DelayReq Messages Sent
key:session.<session ID>.delayreq_messages_sent value:DelayReq Messages Sent
DelayReq Messages Received
key:session.<session ID>.delayreq_messages_received value:DelayReq Messages Received
DelayResp Messages Sent
key:session.<session ID>.delayresp_messages_sent value:DelayResp Messages Sent
DelayResp Messages Received
key:session.<session ID>.delayresp_messages_received value:DelayResp Messages Received
PdelayReq Messages Sent
key:session.<session ID>.pdelayreq_messages_sent value:PdelayReq Messages Sent
PdelayReq Messages Received
key:session.<session ID>.pdelayreq_messages_received value:PdelayReq Messages Received
PdelayResp Messages Sent
key:session.<session ID>.pdelayresp_messages_sent value:PdelayResp Messages Sent
PdelayResp Messages Received
key:session.<session ID>.pdelayrest_messages_received value:PdelayResp Messages Received
PdelayRespFollowUp Messages Sent
key:session.<session ID>.pdelayrespfollowup_messages_sent value:PdelayRespFollowUp Messages Sent
PdelayRespFollowUp Messages Received
key:session.<session ID>.pdelayrespfollowup_messages_received value:PdelayRespFollowUp Messages Received
Signaling Messages Sent
key:session.<session ID>.signaling_messages_sent value:Signaling Messages Sent
Signaling Messages Received
key:session.<session ID>.signaling_messages_received value:Signaling Messages Received
Sync Messages Received Rate
key:session.<session ID>.sync_messages_received_rate value:Sync Messages Received Rate
FollowUp Messages Received Rate
key:session.<session ID>.followup_messages_received_rate value:FollowUp Messages Received Rate
DelayReq Messages Received Rate
key:session.<session ID>.delayreq_messages_received_rate value:DelayReq Messages Received Rate
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'ptp_over_ip_stats',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ptp_over_ip_stats.py_part4
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def pppox_config(self, mode, **kwargs):
r'''
#Procedure Header
Name:
pppox_config
Description:
This procedure configures PPPoA, PPPoEoA, PPPoE sessions for the
specified test port. This command allows the user to configure a specified
number of PPPoX sessions on the test port. Each port can have upto 32000
sessions.
Synopsis:
pppox_config
x [-port_role CHOICES access network]
[-handle ANY]
x [-protocol_name ALPHA]
x [-unlimited_redial_attempts CHOICES 0 1]
x [-enable_mru_negotiation CHOICES 0 1]
x [-desired_mru_rate NUMERIC]
x [-max_payload NUMERIC]
x [-enable_max_payload CHOICES 0 1]
x [-client_ipv6_ncp_configuration CHOICES learned request
x DEFAULT learned]
x [-client_ipv4_ncp_configuration CHOICES learned request
x DEFAULT learned]
x [-server_ipv6_ncp_configuration CHOICES clientmay serveronly
x DEFAULT clientmay]
x [-server_ipv4_ncp_configuration CHOICES clientmay serveronly
x DEFAULT clientmay]
x [-lcp_enable_accm CHOICES 0 1]
x [-lcp_accm ANY]
x [-lcp_enable_pfc CHOICES 0 1]
x [-lcp_enable_acfc CHOICES 0 1]
x [-lcp_enable_fcs_alternatives CHOICES 0 1]
x [-fcs_alt_option CHOICES nullfcs ccitt16fcs ccitt32fcs
x DEFAULT ccitt16fcs]
[-num_sessions RANGE 1-32000]
[-ac_select_mode CHOICES first_responding
CHOICES ac_mac
CHOICES ac_name
DEFAULT first_responding]
[-ac_match_name ALPHA]
[-ac_match_mac ALPHA]
[-auth_req_timeout RANGE 1-65535
DEFAULT 5]
[-config_req_timeout RANGE 1-120
DEFAULT 5]
[-echo_req CHOICES 0 1
DEFAULT 0]
[-echo_rsp CHOICES 0 1
DEFAULT 1]
[-ip_cp CHOICES ipv4_cp ipv6_cp dual_stack
DEFAULT ipv4_cp]
[-ipcp_req_timeout RANGE 1-120
DEFAULT 5]
[-max_auth_req RANGE 1-65535
DEFAULT 10]
[-max_padi_req RANGE 1-65535
DEFAULT 10]
[-max_padr_req RANGE 1-65535
DEFAULT 10]
[-max_terminate_req RANGE 0-65535
DEFAULT 10]
[-padi_req_timeout RANGE 1-65535
DEFAULT 5]
[-padr_req_timeout RANGE 1-65535
DEFAULT 5]
[-password ALPHA]
[-chap_secret ALPHA]
[-username ALPHA]
[-chap_name ALPHA]
x [-calling_num ALPHA]
x [-called_num ALPHA]
x [-last_sent_lcp_req ANY]
x [-last_rx_lcp_req ANY]
x [-proxy_auth_type CHOICES chap pap no_auth ms_chap_v1]
x [-proxy_auth_name ALPHA]
x [-proxy_auth_chal ALPHA]
x [-proxy_auth_id RANGE 0-2147483647
x DEFAULT 0]
x [-proxy_auth_res ALPHA]
[-vlan_id RANGE 0-4095
DEFAULT 1]
[-vlan_id_count RANGE 1-4094
DEFAULT 4094]
[-vlan_id_step RANGE 0-4094
DEFAULT 1]
[-vlan_user_priority RANGE 0-7
DEFAULT 0]
x [-vlan_user_priority_step RANGE 1-7
x DEFAULT 1]
[-vlan_user_priority_outer RANGE 0-7
DEFAULT 0]
-mode CHOICES add remove modify
[-auth_mode CHOICES none pap chap pap_or_chap]
x [-custom_action CHOICES none
x CHOICES abort_after_authentication]
[-echo_req_interval RANGE 1-3600]
[-mac_addr MAC]
[-mac_addr_step MAC
DEFAULT 0000.0000.0001]
[-max_configure_req RANGE 1-255]
[-max_ipcp_req RANGE 1-255]
x [-ac_name ALPHA]
x [-actual_rate_downstream RANGE 1-2147483647]
x [-actual_rate_upstream RANGE 1-2147483647]
x [-agent_circuit_id ALPHA]
x [-agent_remote_id ALPHA]
x [-agent_access_aggregation_circuit_id ALPHA]
x [-data_link CHOICES atm_aal5 ethernet]
x [-enable_domain_group_map CHOICES 0 1]
x [-domain_group_map ALPHA]
x [-enable_client_signal_iwf CHOICES 0 1]
x [-enable_client_signal_loop_char CHOICES 0 1]
x [-enable_client_signal_loop_encap CHOICES 0 1]
x [-enable_client_signal_loop_id CHOICES 0 1]
x [-enable_server_signal_iwf CHOICES 0 1]
x [-enable_server_signal_loop_char CHOICES 0 1]
x [-enable_server_signal_loop_encap CHOICES 0 1]
x [-enable_server_signal_loop_id CHOICES 0 1]
x [-intermediate_agent CHOICES 0 1]
x [-intermediate_agent_encap1 CHOICES na
x CHOICES untagged_eth
x CHOICES single_tagged_eth]
x [-intermediate_agent_encap2 CHOICES na
x CHOICES pppoa_llc
x CHOICES pppoa_null
x CHOICES ipoa_llc
x CHOICES ipoa_null
x CHOICES eth_aal5_llc_fcs
x CHOICES eth_aal5_llc_no_fcs
x CHOICES eth_aal5_null_fcs
x CHOICES eth_aal5_null_no_fcs]
x [-ipv6_global_address_mode CHOICES icmpv6 dhcpv6_pd
x DEFAULT icmpv6]
x [-ipv6_pool_prefix_len NUMERIC]
x [-ipv6_pool_prefix IPV6
x DEFAULT 00 00 00 00 00 00 00 00]
x [-ipv6_pool_addr_prefix_len NUMERIC]
x [-ppp_local_iid IPV6
x DEFAULT 00 00 00 00 00 00 00 00]
x [-lcp_conf_req_mode CHOICES none_or_default local_padt
x DEFAULT none_or_default]
x [-lcp_conf_req_retries RANGE 1-255
x DEFAULT 1]
x [-lcp_conf_req_interval RANGE 0-3600
x DEFAULT 10]
x [-ncp_conf_req_mode CHOICES none_or_default local_padt
x DEFAULT none_or_default]
x [-ncp_conf_req_retries RANGE 1-255
x DEFAULT 1]
x [-ncp_conf_req_interval RANGE 0-3600
x DEFAULT 10]
x [-ncp_enable_ip_comp CHOICES 0 1]
x [-ncp_ip_comp_protocol CHOICES vjcomp iphc rohc
x DEFAULT vjcomp]
x [-vj_max_slot_id RANGE 1-256
x DEFAULT 1]
x [-vj_comp_slot_id RANGE 0-1
x DEFAULT 1]
x [-iphc_tcp_space RANGE 0-255
x DEFAULT 15]
x [-iphc_non_tcp_space RANGE 0-65535
x DEFAULT 15]
x [-iphc_f_max_period RANGE 0-65535
x DEFAULT 256]
x [-iphc_f_max_time RANGE 0-65535
x DEFAULT 5]
x [-rohc_max_cid RANGE 0-16383
x DEFAULT 15]
x [-rohc_mrru RANGE 0-65535
x DEFAULT 0]
x [-comp_max_header RANGE 1-65535
x DEFAULT 168]
x [-comp_sub_options ANY]
x [-ppp_local_ip IPV4
x DEFAULT 2.2.2.2]
x [-ppp_local_ip_step IPV4
x DEFAULT 0.0.0.1]
x [-ppp_local_iid_step NUMERIC]
x [-ppp_peer_iid IPV6
x DEFAULT 00 00 00 00 00 00 00 00]
x [-ppp_peer_iid_step NUMERIC]
x [-ppp_peer_ip IPV4
x DEFAULT 1.1.1.1]
x [-ppp_peer_ip_step IPV4]
x [-redial CHOICES 0 1
x DEFAULT 1]
x [-redial_max RANGE 1-255
x DEFAULT 20]
x [-redial_timeout RANGE 1-65535
x DEFAULT 10]
x [-service_name ALPHA]
x [-service_type CHOICES any name]
x [-send_dns_options CHOICES 0 1]
x [-dns_server_list ANY]
x [-ra_m_flag CHOICES 0 1]
x [-ra_o_flag CHOICES 0 1]
x [-client_dns_options CHOICES request_primary_and_secondary
x CHOICES request_primary_only
x CHOICES accept_addresses_from_server
x CHOICES accept_only_primary_address_from_server
x CHOICES disable_extension
x DEFAULT disable_extension]
x [-client_dns_primary_address IPV4]
x [-client_dns_secondary_address IPV4]
x [-client_netmask_options CHOICES disable_extension
x CHOICES request
x CHOICES request_specific_netmask
x CHOICES accept_netmask_from_server
x DEFAULT disable_extension]
x [-client_netmask IPV4]
x [-client_wins_options CHOICES disable_extension
x CHOICES request_primaryonly_wins
x CHOICES request_primaryandsecondary_wins
x CHOICES accept_addresses_from_server
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part1
|
x [-enable_client_signal_loop_encap CHOICES 0 1]
x [-enable_client_signal_loop_id CHOICES 0 1]
x [-enable_server_signal_iwf CHOICES 0 1]
x [-enable_server_signal_loop_char CHOICES 0 1]
x [-enable_server_signal_loop_encap CHOICES 0 1]
x [-enable_server_signal_loop_id CHOICES 0 1]
x [-intermediate_agent CHOICES 0 1]
x [-intermediate_agent_encap1 CHOICES na
x CHOICES untagged_eth
x CHOICES single_tagged_eth]
x [-intermediate_agent_encap2 CHOICES na
x CHOICES pppoa_llc
x CHOICES pppoa_null
x CHOICES ipoa_llc
x CHOICES ipoa_null
x CHOICES eth_aal5_llc_fcs
x CHOICES eth_aal5_llc_no_fcs
x CHOICES eth_aal5_null_fcs
x CHOICES eth_aal5_null_no_fcs]
x [-ipv6_global_address_mode CHOICES icmpv6 dhcpv6_pd
x DEFAULT icmpv6]
x [-ipv6_pool_prefix_len NUMERIC]
x [-ipv6_pool_prefix IPV6
x DEFAULT 00 00 00 00 00 00 00 00]
x [-ipv6_pool_addr_prefix_len NUMERIC]
x [-ppp_local_iid IPV6
x DEFAULT 00 00 00 00 00 00 00 00]
x [-lcp_conf_req_mode CHOICES none_or_default local_padt
x DEFAULT none_or_default]
x [-lcp_conf_req_retries RANGE 1-255
x DEFAULT 1]
x [-lcp_conf_req_interval RANGE 0-3600
x DEFAULT 10]
x [-ncp_conf_req_mode CHOICES none_or_default local_padt
x DEFAULT none_or_default]
x [-ncp_conf_req_retries RANGE 1-255
x DEFAULT 1]
x [-ncp_conf_req_interval RANGE 0-3600
x DEFAULT 10]
x [-ncp_enable_ip_comp CHOICES 0 1]
x [-ncp_ip_comp_protocol CHOICES vjcomp iphc rohc
x DEFAULT vjcomp]
x [-vj_max_slot_id RANGE 1-256
x DEFAULT 1]
x [-vj_comp_slot_id RANGE 0-1
x DEFAULT 1]
x [-iphc_tcp_space RANGE 0-255
x DEFAULT 15]
x [-iphc_non_tcp_space RANGE 0-65535
x DEFAULT 15]
x [-iphc_f_max_period RANGE 0-65535
x DEFAULT 256]
x [-iphc_f_max_time RANGE 0-65535
x DEFAULT 5]
x [-rohc_max_cid RANGE 0-16383
x DEFAULT 15]
x [-rohc_mrru RANGE 0-65535
x DEFAULT 0]
x [-comp_max_header RANGE 1-65535
x DEFAULT 168]
x [-comp_sub_options ANY]
x [-ppp_local_ip IPV4
x DEFAULT 2.2.2.2]
x [-ppp_local_ip_step IPV4
x DEFAULT 0.0.0.1]
x [-ppp_local_iid_step NUMERIC]
x [-ppp_peer_iid IPV6
x DEFAULT 00 00 00 00 00 00 00 00]
x [-ppp_peer_iid_step NUMERIC]
x [-ppp_peer_ip IPV4
x DEFAULT 1.1.1.1]
x [-ppp_peer_ip_step IPV4]
x [-redial CHOICES 0 1
x DEFAULT 1]
x [-redial_max RANGE 1-255
x DEFAULT 20]
x [-redial_timeout RANGE 1-65535
x DEFAULT 10]
x [-service_name ALPHA]
x [-service_type CHOICES any name]
x [-send_dns_options CHOICES 0 1]
x [-dns_server_list ANY]
x [-ra_m_flag CHOICES 0 1]
x [-ra_o_flag CHOICES 0 1]
x [-client_dns_options CHOICES request_primary_and_secondary
x CHOICES request_primary_only
x CHOICES accept_addresses_from_server
x CHOICES accept_only_primary_address_from_server
x CHOICES disable_extension
x DEFAULT disable_extension]
x [-client_dns_primary_address IPV4]
x [-client_dns_secondary_address IPV4]
x [-client_netmask_options CHOICES disable_extension
x CHOICES request
x CHOICES request_specific_netmask
x CHOICES accept_netmask_from_server
x DEFAULT disable_extension]
x [-client_netmask IPV4]
x [-client_wins_options CHOICES disable_extension
x CHOICES request_primaryonly_wins
x CHOICES request_primaryandsecondary_wins
x CHOICES accept_addresses_from_server
x CHOICES accept_only_primary_address_from_server
x DEFAULT disable_extension]
x [-client_wins_primary_address IPV4]
x [-client_wins_secondary_address IPV4]
x [-server_dns_options CHOICES accept_requested_addresses
x CHOICES accept_only_requested_primary_address
x CHOICES supply_primary_and_secondary
x CHOICES supply_primary_only
x CHOICES disable_extension
x DEFAULT disable_extension]
x [-server_dns_primary_address IPV4]
x [-server_dns_secondary_address IPV4]
x [-server_netmask_options CHOICES disable_extension
x CHOICES request
x CHOICES accept_requested_netmask
x CHOICES supply_netmask
x DEFAULT disable_extension]
x [-server_netmask IPV4]
x [-server_wins_options CHOICES disable_extension
x CHOICES accept_requested_addresses
x CHOICES accept_only_requested_primary_address
x CHOICES supply_primary_and_secondary
x CHOICES supply_primary_only
x DEFAULT disable_extension]
x [-server_wins_primary_address IPV4]
x [-server_wins_secondary_address IPV4]
x [-ra_timeout NUMERIC]
x [-create_interfaces CHOICES 0 1]
[-attempt_rate RANGE 1-10000
DEFAULT 200]
x [-attempt_max_outstanding RANGE 1-999999]
x [-attempt_interval NUMERIC]
x [-attempt_enabled CHOICES 0 1]
x [-attempt_scale_mode CHOICES port device_group
x DEFAULT port]
[-disconnect_rate RANGE 1-10000
DEFAULT 200]
x [-sessionlifetime_scale_mode CHOICES port device_group
x DEFAULT port]
x [-disconnect_max_outstanding RANGE 1-999999]
x [-disconnect_interval NUMERIC]
x [-disconnect_enabled CHOICES 0 1]
x [-disconnect_scale_mode CHOICES port device_group
x DEFAULT port]
x [-enable_session_lifetime CHOICES 0 1]
x [-min_lifetime NUMERIC]
x [-max_lifetime NUMERIC]
x [-enable_session_lifetime_restart CHOICES 0 1]
x [-max_session_lifetime_restarts NUMERIC]
x [-unlimited_session_lifetime_restarts CHOICES 0 1]
x [-accept_any_auth_value CHOICES 0 1]
[-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
[-protocol CHOICES pppoe pppoeoa pppoa
DEFAULT pppoe]
n [-vci ANY]
n [-vci_step ANY]
n [-vci_count ANY]
n [-addr_count_per_vci ANY]
n [-vpi ANY]
n [-vpi_step ANY]
n [-vpi_count ANY]
n [-addr_count_per_vpi ANY]
n [-pvc_incr_mode ANY]
[-encap CHOICES ethernet_ii
CHOICES ethernet_ii_vlan
CHOICES ethernet_ii_qinq
CHOICES vc_mux
CHOICES vc_mux_routed
CHOICES vc_mux_nofcs
CHOICES llcsnap
CHOICES llcsnap_routed
CHOICES llcsnap_nofcs]
x [-address_per_vlan RANGE 1-1000000000
x DEFAULT 1]
x [-address_per_svlan RANGE 1-1000000000
x DEFAULT 1]
[-qinq_incr_mode CHOICES inner outer both
DEFAULT both]
[-vlan_id_outer RANGE 0-4095
DEFAULT 1]
[-vlan_id_outer_count RANGE 1-4094
DEFAULT 4094]
[-vlan_id_outer_step RANGE 0-4094
DEFAULT 1]
n [-vlan_user_priority_count ANY]
[-password_wildcard CHOICES 0 1
DEFAULT 0]
[-username_wildcard CHOICES 0 1
DEFAULT 0]
[-wildcard_pound_start NUMERIC
DEFAULT 0]
[-wildcard_pound_end NUMERIC
DEFAULT 0]
[-wildcard_question_start NUMERIC
DEFAULT 0]
[-wildcard_question_end NUMERIC
DEFAULT 0]
[-ac_select_list ANY]
n [-enable_throttling ANY]
n [-enable_setup_throttling ANY]
n [-enable_multicast ANY]
n [-local_magic ANY]
n [-term_req_timeout ANY]
x [-lcp_max_failure NUMERIC]
x [-lcp_start_delay NUMERIC]
[-max_outstanding RANGE 1-1000
DEFAULT 1000]
x [-dhcpv6_hosts_enable CHOICES 0 1
x DEFAULT 0]
x [-dhcp6_global_echo_ia_info CHOICES 0 1
x DEFAULT 0]
x [-dhcp6_global_max_outstanding_releases RANGE 1-100000
x DEFAULT 500]
x [-dhcp6_global_max_outstanding_requests RANGE 1-100000
x DEFAULT 20]
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part2
|
x CHOICES accept_only_primary_address_from_server
x DEFAULT disable_extension]
x [-client_wins_primary_address IPV4]
x [-client_wins_secondary_address IPV4]
x [-server_dns_options CHOICES accept_requested_addresses
x CHOICES accept_only_requested_primary_address
x CHOICES supply_primary_and_secondary
x CHOICES supply_primary_only
x CHOICES disable_extension
x DEFAULT disable_extension]
x [-server_dns_primary_address IPV4]
x [-server_dns_secondary_address IPV4]
x [-server_netmask_options CHOICES disable_extension
x CHOICES request
x CHOICES accept_requested_netmask
x CHOICES supply_netmask
x DEFAULT disable_extension]
x [-server_netmask IPV4]
x [-server_wins_options CHOICES disable_extension
x CHOICES accept_requested_addresses
x CHOICES accept_only_requested_primary_address
x CHOICES supply_primary_and_secondary
x CHOICES supply_primary_only
x DEFAULT disable_extension]
x [-server_wins_primary_address IPV4]
x [-server_wins_secondary_address IPV4]
x [-ra_timeout NUMERIC]
x [-create_interfaces CHOICES 0 1]
[-attempt_rate RANGE 1-10000
DEFAULT 200]
x [-attempt_max_outstanding RANGE 1-999999]
x [-attempt_interval NUMERIC]
x [-attempt_enabled CHOICES 0 1]
x [-attempt_scale_mode CHOICES port device_group
x DEFAULT port]
[-disconnect_rate RANGE 1-10000
DEFAULT 200]
x [-sessionlifetime_scale_mode CHOICES port device_group
x DEFAULT port]
x [-disconnect_max_outstanding RANGE 1-999999]
x [-disconnect_interval NUMERIC]
x [-disconnect_enabled CHOICES 0 1]
x [-disconnect_scale_mode CHOICES port device_group
x DEFAULT port]
x [-enable_session_lifetime CHOICES 0 1]
x [-min_lifetime NUMERIC]
x [-max_lifetime NUMERIC]
x [-enable_session_lifetime_restart CHOICES 0 1]
x [-max_session_lifetime_restarts NUMERIC]
x [-unlimited_session_lifetime_restarts CHOICES 0 1]
x [-accept_any_auth_value CHOICES 0 1]
[-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
[-protocol CHOICES pppoe pppoeoa pppoa
DEFAULT pppoe]
n [-vci ANY]
n [-vci_step ANY]
n [-vci_count ANY]
n [-addr_count_per_vci ANY]
n [-vpi ANY]
n [-vpi_step ANY]
n [-vpi_count ANY]
n [-addr_count_per_vpi ANY]
n [-pvc_incr_mode ANY]
[-encap CHOICES ethernet_ii
CHOICES ethernet_ii_vlan
CHOICES ethernet_ii_qinq
CHOICES vc_mux
CHOICES vc_mux_routed
CHOICES vc_mux_nofcs
CHOICES llcsnap
CHOICES llcsnap_routed
CHOICES llcsnap_nofcs]
x [-address_per_vlan RANGE 1-1000000000
x DEFAULT 1]
x [-address_per_svlan RANGE 1-1000000000
x DEFAULT 1]
[-qinq_incr_mode CHOICES inner outer both
DEFAULT both]
[-vlan_id_outer RANGE 0-4095
DEFAULT 1]
[-vlan_id_outer_count RANGE 1-4094
DEFAULT 4094]
[-vlan_id_outer_step RANGE 0-4094
DEFAULT 1]
n [-vlan_user_priority_count ANY]
[-password_wildcard CHOICES 0 1
DEFAULT 0]
[-username_wildcard CHOICES 0 1
DEFAULT 0]
[-wildcard_pound_start NUMERIC
DEFAULT 0]
[-wildcard_pound_end NUMERIC
DEFAULT 0]
[-wildcard_question_start NUMERIC
DEFAULT 0]
[-wildcard_question_end NUMERIC
DEFAULT 0]
[-ac_select_list ANY]
n [-enable_throttling ANY]
n [-enable_setup_throttling ANY]
n [-enable_multicast ANY]
n [-local_magic ANY]
n [-term_req_timeout ANY]
x [-lcp_max_failure NUMERIC]
x [-lcp_start_delay NUMERIC]
[-max_outstanding RANGE 1-1000
DEFAULT 1000]
x [-dhcpv6_hosts_enable CHOICES 0 1
x DEFAULT 0]
x [-dhcp6_global_echo_ia_info CHOICES 0 1
x DEFAULT 0]
x [-dhcp6_global_max_outstanding_releases RANGE 1-100000
x DEFAULT 500]
x [-dhcp6_global_max_outstanding_requests RANGE 1-100000
x DEFAULT 20]
x [-dhcp6_global_reb_max_rt RANGE 1-10000
x DEFAULT 500]
x [-dhcp6_global_reb_timeout RANGE 1-100
x DEFAULT 10]
x [-dhcp6_global_rel_max_rc RANGE 1-100
x DEFAULT 5]
x [-dhcp6_global_rel_timeout RANGE 1-100
x DEFAULT 1]
x [-dhcp6_global_ren_max_rt RANGE 1-10000
x DEFAULT 600]
x [-dhcp6_global_ren_timeout RANGE 1-100
x DEFAULT 10]
x [-dhcp6_global_req_max_rc RANGE 1-100
x DEFAULT 10]
x [-dhcp6_global_req_max_rt RANGE 1-10000
x DEFAULT 30]
x [-dhcp6_global_req_timeout RANGE 1-100
x DEFAULT 1]
x [-dhcp6_global_setup_rate_initial RANGE 1-10000
x DEFAULT 10]
n [-dhcp6_global_setup_rate_increment ANY]
n [-dhcp6_global_setup_rate_max ANY]
x [-dhcp6_global_sol_max_rc RANGE 1-100
x DEFAULT 3]
x [-dhcp6_global_sol_max_rt RANGE 1-10000
x DEFAULT 120]
x [-dhcp6_global_sol_timeout RANGE 1-100
x DEFAULT 4]
x [-dhcp6_global_teardown_rate_initial RANGE 1-10000
x DEFAULT 50]
n [-dhcp6_global_teardown_rate_increment ANY]
n [-dhcp6_global_teardown_rate_max ANY]
n [-dhcp6_global_wait_for_completion ANY]
x [-dhcpv6pd_type CHOICES client server
x DEFAULT client]
x [-dhcp6_pd_client_range_duid_enterprise_id RANGE 1-2147483647
x DEFAULT 10]
x [-dhcp6_pd_client_range_duid_type CHOICES duid_en duid_llt duid_ll
x DEFAULT duid_llt]
x [-dhcp6_pd_client_range_duid_vendor_id RANGE 1-2147483647
x DEFAULT 10]
x [-dhcp6_pd_client_range_duid_vendor_id_increment RANGE 1-2147483647
x DEFAULT 1]
x [-dhcp6_pd_client_range_ia_id RANGE 1-2147483647
x DEFAULT 10]
x [-dhcp6_pd_client_range_ia_id_increment RANGE 1-2147483647
x DEFAULT 1]
x [-dhcp6_pd_client_range_ia_t1 RANGE 0-2147483647
x DEFAULT 302400]
x [-dhcp6_pd_client_range_ia_t2 RANGE 0-2147483647
x DEFAULT 483840]
x [-dhcp6_pd_client_range_ia_type CHOICES iapd iana iata iana_iapd
x DEFAULT iapd]
n [-dhcp6_pd_client_range_param_request_list ANY]
x [-dhcp6_pd_client_range_renew_timer RANGE 0-1000000000
x DEFAULT 0]
n [-dhcp6_pd_client_range_use_vendor_class_id ANY]
n [-dhcp6_pd_client_range_vendor_class_id ANY]
x [-dhcp6_pd_server_range_dns_domain_search_list ANY]
x [-dhcp6_pd_server_range_first_dns_server IP]
x [-dhcp6_pd_server_range_second_dns_server IP]
x [-dhcp6_pd_server_range_subnet_prefix NUMERIC]
x [-dhcp6_pd_server_range_start_pool_address IP]
x [-dhcp6_pgdata_max_outstanding_requests RANGE 1-100000
x DEFAULT 20]
x [-dhcp6_pgdata_override_global_setup_rate CHOICES 0 1
x DEFAULT 0]
x [-dhcp6_pgdata_setup_rate_initial RANGE 1-10000
x DEFAULT 10]
n [-dhcp6_pgdata_setup_rate_increment ANY]
n [-dhcp6_pgdata_setup_rate_max ANY]
x [-dhcp6_pgdata_max_outstanding_releases RANGE 1-100000
x DEFAULT 500]
x [-dhcp6_pgdata_override_global_teardown_rate CHOICES 0 1
x DEFAULT 0]
x [-dhcp6_pgdata_teardown_rate_initial RANGE 1-10000
x DEFAULT 50]
n [-dhcp6_pgdata_teardown_rate_increment ANY]
n [-dhcp6_pgdata_teardown_rate_max ANY]
n [-hosts_range_ip_outer_prefix ANY]
n [-hosts_range_ip_prefix_addr ANY]
n [-hosts_range_count ANY]
n [-hosts_range_eui_increment ANY]
n [-hosts_range_first_eui ANY]
n [-hosts_range_ip_prefix ANY]
n [-hosts_range_subnet_count ANY]
n [-lease_time_max ANY]
x [-lease_time RANGE 300-30000000
x DEFAULT 3600]
n [-padi_include_tag ANY]
n [-pado_include_tag ANY]
n [-padr_include_tag ANY]
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part3
|
x [-dhcp6_global_reb_max_rt RANGE 1-10000
x DEFAULT 500]
x [-dhcp6_global_reb_timeout RANGE 1-100
x DEFAULT 10]
x [-dhcp6_global_rel_max_rc RANGE 1-100
x DEFAULT 5]
x [-dhcp6_global_rel_timeout RANGE 1-100
x DEFAULT 1]
x [-dhcp6_global_ren_max_rt RANGE 1-10000
x DEFAULT 600]
x [-dhcp6_global_ren_timeout RANGE 1-100
x DEFAULT 10]
x [-dhcp6_global_req_max_rc RANGE 1-100
x DEFAULT 10]
x [-dhcp6_global_req_max_rt RANGE 1-10000
x DEFAULT 30]
x [-dhcp6_global_req_timeout RANGE 1-100
x DEFAULT 1]
x [-dhcp6_global_setup_rate_initial RANGE 1-10000
x DEFAULT 10]
n [-dhcp6_global_setup_rate_increment ANY]
n [-dhcp6_global_setup_rate_max ANY]
x [-dhcp6_global_sol_max_rc RANGE 1-100
x DEFAULT 3]
x [-dhcp6_global_sol_max_rt RANGE 1-10000
x DEFAULT 120]
x [-dhcp6_global_sol_timeout RANGE 1-100
x DEFAULT 4]
x [-dhcp6_global_teardown_rate_initial RANGE 1-10000
x DEFAULT 50]
n [-dhcp6_global_teardown_rate_increment ANY]
n [-dhcp6_global_teardown_rate_max ANY]
n [-dhcp6_global_wait_for_completion ANY]
x [-dhcpv6pd_type CHOICES client server
x DEFAULT client]
x [-dhcp6_pd_client_range_duid_enterprise_id RANGE 1-2147483647
x DEFAULT 10]
x [-dhcp6_pd_client_range_duid_type CHOICES duid_en duid_llt duid_ll
x DEFAULT duid_llt]
x [-dhcp6_pd_client_range_duid_vendor_id RANGE 1-2147483647
x DEFAULT 10]
x [-dhcp6_pd_client_range_duid_vendor_id_increment RANGE 1-2147483647
x DEFAULT 1]
x [-dhcp6_pd_client_range_ia_id RANGE 1-2147483647
x DEFAULT 10]
x [-dhcp6_pd_client_range_ia_id_increment RANGE 1-2147483647
x DEFAULT 1]
x [-dhcp6_pd_client_range_ia_t1 RANGE 0-2147483647
x DEFAULT 302400]
x [-dhcp6_pd_client_range_ia_t2 RANGE 0-2147483647
x DEFAULT 483840]
x [-dhcp6_pd_client_range_ia_type CHOICES iapd iana iata iana_iapd
x DEFAULT iapd]
n [-dhcp6_pd_client_range_param_request_list ANY]
x [-dhcp6_pd_client_range_renew_timer RANGE 0-1000000000
x DEFAULT 0]
n [-dhcp6_pd_client_range_use_vendor_class_id ANY]
n [-dhcp6_pd_client_range_vendor_class_id ANY]
x [-dhcp6_pd_server_range_dns_domain_search_list ANY]
x [-dhcp6_pd_server_range_first_dns_server IP]
x [-dhcp6_pd_server_range_second_dns_server IP]
x [-dhcp6_pd_server_range_subnet_prefix NUMERIC]
x [-dhcp6_pd_server_range_start_pool_address IP]
x [-dhcp6_pgdata_max_outstanding_requests RANGE 1-100000
x DEFAULT 20]
x [-dhcp6_pgdata_override_global_setup_rate CHOICES 0 1
x DEFAULT 0]
x [-dhcp6_pgdata_setup_rate_initial RANGE 1-10000
x DEFAULT 10]
n [-dhcp6_pgdata_setup_rate_increment ANY]
n [-dhcp6_pgdata_setup_rate_max ANY]
x [-dhcp6_pgdata_max_outstanding_releases RANGE 1-100000
x DEFAULT 500]
x [-dhcp6_pgdata_override_global_teardown_rate CHOICES 0 1
x DEFAULT 0]
x [-dhcp6_pgdata_teardown_rate_initial RANGE 1-10000
x DEFAULT 50]
n [-dhcp6_pgdata_teardown_rate_increment ANY]
n [-dhcp6_pgdata_teardown_rate_max ANY]
n [-hosts_range_ip_outer_prefix ANY]
n [-hosts_range_ip_prefix_addr ANY]
n [-hosts_range_count ANY]
n [-hosts_range_eui_increment ANY]
n [-hosts_range_first_eui ANY]
n [-hosts_range_ip_prefix ANY]
n [-hosts_range_subnet_count ANY]
n [-lease_time_max ANY]
x [-lease_time RANGE 300-30000000
x DEFAULT 3600]
n [-padi_include_tag ANY]
n [-pado_include_tag ANY]
n [-padr_include_tag ANY]
n [-pads_include_tag ANY]
n [-re_connect_on_link_up ANY]
n [-group_ip_count ANY]
n [-group_ip_step ANY]
n [-start_group_ip ANY]
n [-igmp_version ANY]
n [-is_last_subport ANY]
n [-join_leaves_per_second ANY]
n [-l4_src_port ANY]
n [-l4_dst_port ANY]
n [-l4_flow_number ANY]
n [-l4_flow_type ANY]
n [-l4_flow_variant ANY]
n [-mc_enable_general_query ANY]
n [-mc_enable_group_specific_query ANY]
n [-mc_enable_immediate_response ANY]
n [-mc_enable_packing ANY]
n [-mc_enable_router_alert ANY]
n [-mc_enable_suppress_reports ANY]
n [-mc_enable_unsolicited ANY]
n [-mc_group_id ANY]
n [-mc_report_frequency ANY]
n [-ppp_local_mode ANY]
n [-ppp_peer_mode ANY]
n [-enable_delete_config ANY]
n [-flap_repeat_count ANY]
n [-flap_rate ANY]
n [-switch_duration ANY]
n [-watch_duration ANY]
n [-hold_time ANY]
n [-cool_off_time ANY]
n [-dut_assigned_src_addr ANY]
n [-include_id ANY]
n [-sessions_per_vc ANY]
x [-enable_host_uniq ANY]
x [-rx_connect_speed ANY]
x [-tx_connect_speed ANY]
x [-connect_speed_update_enable ANY]
x [-host_uniq_length ANY]
x [-host_uniq ANY]
x [-multiplier NUMERIC]
x [-dsl_type_tlv CHOICES none
x CHOICES adsl_1
x CHOICES adsl_2
x CHOICES adsl_2_p
x CHOICES vdsl_1
x CHOICES vdsl_2
x CHOICES sdsl
x CHOICES g_fast
x CHOICES svvdsl
x CHOICES sdsl_bonded
x CHOICES vdsl_bonded
x CHOICES g_fast_bonded
x CHOICES svvdsl_bonded
x CHOICES other
x CHOICES userdefined]
x [-user_defined_dsl_type_tlv RANGE 0-4294967295
x DEFAULT 50]
x [-enable_server_signal_dsl_type_tlv CHOICES 0 1]
x [-pon_type_tlv CHOICES none
x CHOICES gpon
x CHOICES xg_pon_1
x CHOICES twdm_pon
x CHOICES xgs_pon
x CHOICES wdm_pon
x CHOICES other
x CHOICES userdefined]
x [-user_defined_pon_type_tlv RANGE 0-4294967295
x DEFAULT 50]
x [-enable_server_signal_pon_type_tlv CHOICES 0 1]
x [-enable_mrru_negotiation CHOICES 0 1]
x [-multilink_mrru_size RANGE 576-9000
x DEFAULT 1492]
x [-mlppp_endpointdiscriminator_option CHOICES 0 1]
x [-endpoint_discriminator_class CHOICES class_null
x CHOICES class_ip_address
x CHOICES class_mac_address]
x [-internet_protocol_address IPV4]
x [-mac_address MAC]
Arguments:
x -port_role
x The role of the port in the test: access or network.
-handle
PPPoX handle of a configuration to be modified or removed.
Dependencies: only available when IxNetwork is used for the PPPoX configuration.
When -handle is provided with the /globals value the arguments that configure global protocol
setting accept both multivalue handles and simple values.
When -handle is provided with a a protocol stack handle or a protocol session handle, the arguments
that configure global settings will only accept simple values. In this situation, these arguments will
configure only the settings of the parent device group or the ports associated with the parent topology.
x -protocol_name
x -unlimited_redial_attempts
x If checked, PPPoE unlimited redial attempts is enabled
x -enable_mru_negotiation
x Enable MRU Negotiation
x -desired_mru_rate
x Max Transmit Unit for PPP
x -max_payload
x Max Payload. Valid only when enable_max_payload is enabled.
x -enable_max_payload
x Enables PPP Max Payload tag
x -client_ipv6_ncp_configuration
x Valid only when ip_cp is ipv6_cp or dual_stack
x -client_ipv4_ncp_configuration
x Valid only when ip_cp is ipv4_cp or dual_stack
x -server_ipv6_ncp_configuration
x Valid only when ip_cp is ipv6_cp or dual_stack
x -server_ipv4_ncp_configuration
x Valid only when ip_cp is ipv4_cp or dual_stack
x -lcp_enable_accm
x Enable Async-Control-Character-Map
x -lcp_accm
x Async-Control-Character-Map. Valid only when lcp_enable_accm is enabled.
x -lcp_enable_pfc
x Enable Protocol Field Compression (Option 7)
x -lcp_enable_acfc
x Enable Address and Control Field Compression (Option 8)
x -lcp_enable_fcs_alternatives
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part4
|
n [-padr_include_tag ANY]
n [-pads_include_tag ANY]
n [-re_connect_on_link_up ANY]
n [-group_ip_count ANY]
n [-group_ip_step ANY]
n [-start_group_ip ANY]
n [-igmp_version ANY]
n [-is_last_subport ANY]
n [-join_leaves_per_second ANY]
n [-l4_src_port ANY]
n [-l4_dst_port ANY]
n [-l4_flow_number ANY]
n [-l4_flow_type ANY]
n [-l4_flow_variant ANY]
n [-mc_enable_general_query ANY]
n [-mc_enable_group_specific_query ANY]
n [-mc_enable_immediate_response ANY]
n [-mc_enable_packing ANY]
n [-mc_enable_router_alert ANY]
n [-mc_enable_suppress_reports ANY]
n [-mc_enable_unsolicited ANY]
n [-mc_group_id ANY]
n [-mc_report_frequency ANY]
n [-ppp_local_mode ANY]
n [-ppp_peer_mode ANY]
n [-enable_delete_config ANY]
n [-flap_repeat_count ANY]
n [-flap_rate ANY]
n [-switch_duration ANY]
n [-watch_duration ANY]
n [-hold_time ANY]
n [-cool_off_time ANY]
n [-dut_assigned_src_addr ANY]
n [-include_id ANY]
n [-sessions_per_vc ANY]
x [-enable_host_uniq ANY]
x [-rx_connect_speed ANY]
x [-tx_connect_speed ANY]
x [-connect_speed_update_enable ANY]
x [-host_uniq_length ANY]
x [-host_uniq ANY]
x [-multiplier NUMERIC]
x [-dsl_type_tlv CHOICES none
x CHOICES adsl_1
x CHOICES adsl_2
x CHOICES adsl_2_p
x CHOICES vdsl_1
x CHOICES vdsl_2
x CHOICES sdsl
x CHOICES g_fast
x CHOICES svvdsl
x CHOICES sdsl_bonded
x CHOICES vdsl_bonded
x CHOICES g_fast_bonded
x CHOICES svvdsl_bonded
x CHOICES other
x CHOICES userdefined]
x [-user_defined_dsl_type_tlv RANGE 0-4294967295
x DEFAULT 50]
x [-enable_server_signal_dsl_type_tlv CHOICES 0 1]
x [-pon_type_tlv CHOICES none
x CHOICES gpon
x CHOICES xg_pon_1
x CHOICES twdm_pon
x CHOICES xgs_pon
x CHOICES wdm_pon
x CHOICES other
x CHOICES userdefined]
x [-user_defined_pon_type_tlv RANGE 0-4294967295
x DEFAULT 50]
x [-enable_server_signal_pon_type_tlv CHOICES 0 1]
x [-enable_mrru_negotiation CHOICES 0 1]
x [-multilink_mrru_size RANGE 576-9000
x DEFAULT 1492]
x [-mlppp_endpointdiscriminator_option CHOICES 0 1]
x [-endpoint_discriminator_class CHOICES class_null
x CHOICES class_ip_address
x CHOICES class_mac_address]
x [-internet_protocol_address IPV4]
x [-mac_address MAC]
Arguments:
x -port_role
x The role of the port in the test: access or network.
-handle
PPPoX handle of a configuration to be modified or removed.
Dependencies: only available when IxNetwork is used for the PPPoX configuration.
When -handle is provided with the /globals value the arguments that configure global protocol
setting accept both multivalue handles and simple values.
When -handle is provided with a a protocol stack handle or a protocol session handle, the arguments
that configure global settings will only accept simple values. In this situation, these arguments will
configure only the settings of the parent device group or the ports associated with the parent topology.
x -protocol_name
x -unlimited_redial_attempts
x If checked, PPPoE unlimited redial attempts is enabled
x -enable_mru_negotiation
x Enable MRU Negotiation
x -desired_mru_rate
x Max Transmit Unit for PPP
x -max_payload
x Max Payload. Valid only when enable_max_payload is enabled.
x -enable_max_payload
x Enables PPP Max Payload tag
x -client_ipv6_ncp_configuration
x Valid only when ip_cp is ipv6_cp or dual_stack
x -client_ipv4_ncp_configuration
x Valid only when ip_cp is ipv4_cp or dual_stack
x -server_ipv6_ncp_configuration
x Valid only when ip_cp is ipv6_cp or dual_stack
x -server_ipv4_ncp_configuration
x Valid only when ip_cp is ipv4_cp or dual_stack
x -lcp_enable_accm
x Enable Async-Control-Character-Map
x -lcp_accm
x Async-Control-Character-Map. Valid only when lcp_enable_accm is enabled.
x -lcp_enable_pfc
x Enable Protocol Field Compression (Option 7)
x -lcp_enable_acfc
x Enable Address and Control Field Compression (Option 8)
x -lcp_enable_fcs_alternatives
x Enable FCS Alternatives (Option 9)
x -fcs_alt_option
-num_sessions
The number of PPP sessions to configure.
For PPP servers this will configure the number of sessions supprted by each server.
For PPP clients this will configure the number of client sessions that are available.
-ac_select_mode
There are various ways AC can be selected based on the PADO
received from AC.
-ac_match_name
-ac_match_mac
-auth_req_timeout
Specifies the timeout value in seconds for acknowledgement of an
authentication Request.
-config_req_timeout
Specifies the timeout value in seconds for acknowledgement of a
Configure Request or Terminate Request.
-echo_req
When set to 1, enables Echo Requests, when set to 0, disables Echo
Requests.
-echo_rsp
This can be used to do negative testing. Dependencies: -mode add (when IxNetwork is used for the PPPoX configuration). Valid choices are:
0 - Disable sending of the echo Responses.
1 - (DEFAULT) Enable Echo Replies.
-ip_cp
-ipcp_req_timeout
Specifies the timeout value in seconds for acknowledgement of an
IPCP configure request.
-max_auth_req
Specifies the maximum number of Authentication Requests that can be
sent without getting an authentication response from the DUT.
-max_padi_req
Specifies the maximum number of PADI Requests that can be sent
without getting a PADO from the DUT.
-max_padr_req
Specifies the maximum number of PADR Requests that can be sent
without getting a PADS from the DUT.
-max_terminate_req
Specifies the maximum number of Terminate Requests that can be sent
without acknowledgement.
-padi_req_timeout
Specifies the timeout value in seconds for acknowledgement of a
PADI Request.
-padr_req_timeout
Specifies the timeout value in seconds for acknowledgement of a
PADR Request.
-password
Password, PAP and CHAP only.
-chap_secret
Secret when CHAP Authentication is being used
-username
Username, PAP and CHAP only.
-chap_name
User name when CHAP Authentication is being used
x -calling_num
x Configures Calling Number AVP to be sent in ICRQ packet(L2TP)
x -called_num
x Configures Called Number AVP to be sent in ICRQ packet(L2TP)
x -last_sent_lcp_req
x Configures Last Sent LCP CONFREQ AVP to be sent in ICCN packet(L2TP)
x -last_rx_lcp_req
x Configures Last Received LCP CONFREQ AVP to be sent in ICCN packet(L2TP)
x -proxy_auth_type
x Proxy Authentication Type AVP.
x -proxy_auth_name
x Configures Proxy Authentication Name AVP to be sent in ICCN packet(L2TP)
x -proxy_auth_chal
x Configures Proxy Authentication Challenge AVP to be sent in ICCN packet(L2TP)
x -proxy_auth_id
x Configures Proxy Authentication ID AVP to be sent in ICCN packet(L2TP)
x -proxy_auth_res
x Configures Proxy Authentication Response AVP to be sent in ICCN packet(L2TP)
-vlan_id
Starting VLAN ID, applies to PPPoE w/VLAN only.
-vlan_id_count
Number of VLAN IDs, applies to PPPoE w/VLAN only.
-vlan_id_step
Step value applied to VLAN ID, PPPoEoE w/VLAN only.
-vlan_user_priority
VLAN user priority, PPPoEoE w/VLAN only.
x -vlan_user_priority_step
-vlan_user_priority_outer
Outer VLAN user priority, PPPoEoE w/VLAN only.
-mode
Dependencies: only available when IxNetwork is used for the PPPoX configuration.
-auth_mode
Authentication mode.
x -custom_action
x Custom behavior or action modes.
-echo_req_interval
Specifies the time interval in seconds for sending LCP echo
requests. Valid only if -echo_req is set to 1.
When using IxNetwork this parameter can take values from the 1-3600
range.
-mac_addr
<aa.bb.cc.dd.ee.ff>
-mac_addr_step
<aa.bb.cc.dd.ee.ff>
Dependencies: -mode add or modify (when IxNetwork is used for the PPPoX configuration).
-max_configure_req
Specifies the maximum number of LCP Configure Requests that can be sent
without acknowledgement.
When using IxNetwork this parameter can take values from the 1-255
range.
-max_ipcp_req
Specifies the maximum number of IPCP configure requests that can be
sent without getting an ack from the DUT.
When using IxNetwork this parameter can take values from the 1-255
range.
x -ac_name
x When the port is used as a server, this is the name sent in the
x PADO message.
x -actual_rate_downstream
x This parameter configures Access Loop Characteristics. For details
x refer to -enable_server_signal_loop_char.
x The actual downstream data rate (sub-option 0x81), in kbps.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1
x -actual_rate_upstream
x This parameter configures Access Loop Characteristics. For details
x refer to -enable_server_signal_loop_char.
x The actual upstream data rate (sub-option 0x82), in kbps
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1
x -agent_circuit_id
x When intermediate_agent is true, the program inserts an Agent
x Circuit ID and an Agent Remote ID into PPPoE tags for each PPPoE
x session. These IDs serve to distinguish the CPE premises from
x each other. This field has a maximum length of 32 characters.The
x agent_circuit_id field is defined in strings of the form:
x %<start-width>:<count>:<repeat count>i.
x -agent_remote_id
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part5
|
x Enable FCS Alternatives (Option 9)
x -fcs_alt_option
-num_sessions
The number of PPP sessions to configure.
For PPP servers this will configure the number of sessions supprted by each server.
For PPP clients this will configure the number of client sessions that are available.
-ac_select_mode
There are various ways AC can be selected based on the PADO
received from AC.
-ac_match_name
-ac_match_mac
-auth_req_timeout
Specifies the timeout value in seconds for acknowledgement of an
authentication Request.
-config_req_timeout
Specifies the timeout value in seconds for acknowledgement of a
Configure Request or Terminate Request.
-echo_req
When set to 1, enables Echo Requests, when set to 0, disables Echo
Requests.
-echo_rsp
This can be used to do negative testing. Dependencies: -mode add (when IxNetwork is used for the PPPoX configuration). Valid choices are:
0 - Disable sending of the echo Responses.
1 - (DEFAULT) Enable Echo Replies.
-ip_cp
-ipcp_req_timeout
Specifies the timeout value in seconds for acknowledgement of an
IPCP configure request.
-max_auth_req
Specifies the maximum number of Authentication Requests that can be
sent without getting an authentication response from the DUT.
-max_padi_req
Specifies the maximum number of PADI Requests that can be sent
without getting a PADO from the DUT.
-max_padr_req
Specifies the maximum number of PADR Requests that can be sent
without getting a PADS from the DUT.
-max_terminate_req
Specifies the maximum number of Terminate Requests that can be sent
without acknowledgement.
-padi_req_timeout
Specifies the timeout value in seconds for acknowledgement of a
PADI Request.
-padr_req_timeout
Specifies the timeout value in seconds for acknowledgement of a
PADR Request.
-password
Password, PAP and CHAP only.
-chap_secret
Secret when CHAP Authentication is being used
-username
Username, PAP and CHAP only.
-chap_name
User name when CHAP Authentication is being used
x -calling_num
x Configures Calling Number AVP to be sent in ICRQ packet(L2TP)
x -called_num
x Configures Called Number AVP to be sent in ICRQ packet(L2TP)
x -last_sent_lcp_req
x Configures Last Sent LCP CONFREQ AVP to be sent in ICCN packet(L2TP)
x -last_rx_lcp_req
x Configures Last Received LCP CONFREQ AVP to be sent in ICCN packet(L2TP)
x -proxy_auth_type
x Proxy Authentication Type AVP.
x -proxy_auth_name
x Configures Proxy Authentication Name AVP to be sent in ICCN packet(L2TP)
x -proxy_auth_chal
x Configures Proxy Authentication Challenge AVP to be sent in ICCN packet(L2TP)
x -proxy_auth_id
x Configures Proxy Authentication ID AVP to be sent in ICCN packet(L2TP)
x -proxy_auth_res
x Configures Proxy Authentication Response AVP to be sent in ICCN packet(L2TP)
-vlan_id
Starting VLAN ID, applies to PPPoE w/VLAN only.
-vlan_id_count
Number of VLAN IDs, applies to PPPoE w/VLAN only.
-vlan_id_step
Step value applied to VLAN ID, PPPoEoE w/VLAN only.
-vlan_user_priority
VLAN user priority, PPPoEoE w/VLAN only.
x -vlan_user_priority_step
-vlan_user_priority_outer
Outer VLAN user priority, PPPoEoE w/VLAN only.
-mode
Dependencies: only available when IxNetwork is used for the PPPoX configuration.
-auth_mode
Authentication mode.
x -custom_action
x Custom behavior or action modes.
-echo_req_interval
Specifies the time interval in seconds for sending LCP echo
requests. Valid only if -echo_req is set to 1.
When using IxNetwork this parameter can take values from the 1-3600
range.
-mac_addr
<aa.bb.cc.dd.ee.ff>
-mac_addr_step
<aa.bb.cc.dd.ee.ff>
Dependencies: -mode add or modify (when IxNetwork is used for the PPPoX configuration).
-max_configure_req
Specifies the maximum number of LCP Configure Requests that can be sent
without acknowledgement.
When using IxNetwork this parameter can take values from the 1-255
range.
-max_ipcp_req
Specifies the maximum number of IPCP configure requests that can be
sent without getting an ack from the DUT.
When using IxNetwork this parameter can take values from the 1-255
range.
x -ac_name
x When the port is used as a server, this is the name sent in the
x PADO message.
x -actual_rate_downstream
x This parameter configures Access Loop Characteristics. For details
x refer to -enable_server_signal_loop_char.
x The actual downstream data rate (sub-option 0x81), in kbps.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1
x -actual_rate_upstream
x This parameter configures Access Loop Characteristics. For details
x refer to -enable_server_signal_loop_char.
x The actual upstream data rate (sub-option 0x82), in kbps
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1
x -agent_circuit_id
x When intermediate_agent is true, the program inserts an Agent
x Circuit ID and an Agent Remote ID into PPPoE tags for each PPPoE
x session. These IDs serve to distinguish the CPE premises from
x each other. This field has a maximum length of 32 characters.The
x agent_circuit_id field is defined in strings of the form:
x %<start-width>:<count>:<repeat count>i.
x -agent_remote_id
x When intermediate_agent is true, the program inserts an Agent
x Circuit ID and an Agent Remote ID into PPPoE tags for each PPPoE
x session. These IDs serve to distinguish the CPE premises from
x each other. This field has a maximum length of 32 characters. The
x agentRemoteId field is defined in strings of the form:
x %<start-width>:<count>:<repeat count>i.
x -agent_access_aggregation_circuit_id
x When intermediate_agent is true, the program inserts an Agent
x Circuit ID and an Agent Remote ID and an Agent Access Aggregation Circuit ID into PPPoE tags for each PPPoE
x session. These IDs serve to distinguish the CPE premises from
x each other. This field has a maximum length of 32 characters.The
x agent_circuit_id field is defined in strings of the form:
x %<start-width>:<count>:<repeat count>i.
x -data_link
x This parameter configures Signaling the Access Loop Encapsulation
x (sub-option 0x90), for details refer to -enable_server_signal_loop_encap.
x The PPPoE intermediate agent on the Access Node inserts the 0x90
x sub-option to signal to the BNG the data-link protocol on the Access Loop.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1
x -enable_domain_group_map
x This parameter configures the Interworking function (IWF). For details
x refer to -enable_server_signal_iwf.
x When enabled, the Access Node provides protocol translation between the
x ATM layer on the user side and the Ethernet layer on the network side.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role access
x -domain_group_map
x List of domain group to LNS IP mapping.
x Each domain group can have thousands of domains.
x With the help of domain group it is very easy to map thousands of
x domains to one or more LNS IP addresses. Each domain group is defined
x as: { { domain_name } {lnsIP1 lnsIP2} }.
x Where domain_name is defined as:
x {name wc wc_start wc_end <wc_repeat >}
x name <string> : name to be used for the domain(s).
x wc {1|0} : enables wildcard substitution in the name field.
x wc_start <0-65535> : starting value for wildcard symbol for the name
x (%) substitution
x wc_end <0-65535> : ending value for wildcard symbol for the name
x (%) substitution
x lnsIP <a.b.c.d> : LNS IP address list to be used for this domain.
x Example: You want to set up 20 domains,
x out of which cisco1.com to cisco10.com going to 192.1.1.1 & 192.1.1.2
x and cisco11.com to cisco20.com going to 192.1.2.1. Also assume number
x of sessions per tunnel is 5. Your domain group list will look like:
x { { {cisco%.com 1 1 10} {192.1.1.1 192.1.1.2} }
x { {cisco%.com 1 11 20} {192.1.2.1} } }
x Tunnel Allocation will look like this:
x Sessions 1-5, tunnel1 dst 192.1.1.1;
x Sessions 5-10, tunnel2 dst 192.1.1.2;
x Sessions 11-15, tunnel3 dst 192.1.2.1;
x Sessions 16-20, tunnel4 dst 192.1.2.1.
x -enable_client_signal_iwf
x This parameter configures the Interworking function (IWF). For details
x refer to -enable_server_signal_iwf.
x When enabled, the Access Node provides protocol translation between the
x ATM layer on the user side and the Ethernet layer on the network side.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role access
x -enable_client_signal_loop_char
x This parameter configures Access Loop Characteristics. For details
x refer to -enable_server_signal_loop_char.
x When this parameter is enabled, the discovery packets will include
x the 0x81 and 0x82 sub-options.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role access
x -enable_client_signal_loop_encap
x This parameter configures Signaling the Access Loop Encapsulation
x (sub-option 0x90), for details refer to -enable_server_signal_loop_encap
x When this parameter is enabled, the discovery packets will include the
x 0x90 sub-option.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role access
x -enable_client_signal_loop_id
x When this parameter is 1, the discovery packets will include
x the -agent_circuit_id and -agent_remote_id options.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role access
x -enable_server_signal_iwf
x This parameter configures the Interworking function (IWF) - When ATM
x is supported on the DSL line (the U interface), the Access Node must
x provide protocol translation between the ATM layer on the user side and
x the Ethernet layer on the network side.
x When enabled, the Access Node provides protocol translation between
x the ATM layer on the user side and the Ethernet layer on the network side.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role network
x -enable_server_signal_loop_char
x This parameter configures Access Loop Characteristics - the Access Node
x reports the access loop sync rate and interleave delay to the
x Broadband Network Gateway (BNG). This allows the BNG to enable
x policy decisions and advanced QoS enforcement, while potentially
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part6
|
x -agent_remote_id
x When intermediate_agent is true, the program inserts an Agent
x Circuit ID and an Agent Remote ID into PPPoE tags for each PPPoE
x session. These IDs serve to distinguish the CPE premises from
x each other. This field has a maximum length of 32 characters. The
x agentRemoteId field is defined in strings of the form:
x %<start-width>:<count>:<repeat count>i.
x -agent_access_aggregation_circuit_id
x When intermediate_agent is true, the program inserts an Agent
x Circuit ID and an Agent Remote ID and an Agent Access Aggregation Circuit ID into PPPoE tags for each PPPoE
x session. These IDs serve to distinguish the CPE premises from
x each other. This field has a maximum length of 32 characters.The
x agent_circuit_id field is defined in strings of the form:
x %<start-width>:<count>:<repeat count>i.
x -data_link
x This parameter configures Signaling the Access Loop Encapsulation
x (sub-option 0x90), for details refer to -enable_server_signal_loop_encap.
x The PPPoE intermediate agent on the Access Node inserts the 0x90
x sub-option to signal to the BNG the data-link protocol on the Access Loop.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1
x -enable_domain_group_map
x This parameter configures the Interworking function (IWF). For details
x refer to -enable_server_signal_iwf.
x When enabled, the Access Node provides protocol translation between the
x ATM layer on the user side and the Ethernet layer on the network side.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role access
x -domain_group_map
x List of domain group to LNS IP mapping.
x Each domain group can have thousands of domains.
x With the help of domain group it is very easy to map thousands of
x domains to one or more LNS IP addresses. Each domain group is defined
x as: { { domain_name } {lnsIP1 lnsIP2} }.
x Where domain_name is defined as:
x {name wc wc_start wc_end <wc_repeat >}
x name <string> : name to be used for the domain(s).
x wc {1|0} : enables wildcard substitution in the name field.
x wc_start <0-65535> : starting value for wildcard symbol for the name
x (%) substitution
x wc_end <0-65535> : ending value for wildcard symbol for the name
x (%) substitution
x lnsIP <a.b.c.d> : LNS IP address list to be used for this domain.
x Example: You want to set up 20 domains,
x out of which cisco1.com to cisco10.com going to 192.1.1.1 & 192.1.1.2
x and cisco11.com to cisco20.com going to 192.1.2.1. Also assume number
x of sessions per tunnel is 5. Your domain group list will look like:
x { { {cisco%.com 1 1 10} {192.1.1.1 192.1.1.2} }
x { {cisco%.com 1 11 20} {192.1.2.1} } }
x Tunnel Allocation will look like this:
x Sessions 1-5, tunnel1 dst 192.1.1.1;
x Sessions 5-10, tunnel2 dst 192.1.1.2;
x Sessions 11-15, tunnel3 dst 192.1.2.1;
x Sessions 16-20, tunnel4 dst 192.1.2.1.
x -enable_client_signal_iwf
x This parameter configures the Interworking function (IWF). For details
x refer to -enable_server_signal_iwf.
x When enabled, the Access Node provides protocol translation between the
x ATM layer on the user side and the Ethernet layer on the network side.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role access
x -enable_client_signal_loop_char
x This parameter configures Access Loop Characteristics. For details
x refer to -enable_server_signal_loop_char.
x When this parameter is enabled, the discovery packets will include
x the 0x81 and 0x82 sub-options.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role access
x -enable_client_signal_loop_encap
x This parameter configures Signaling the Access Loop Encapsulation
x (sub-option 0x90), for details refer to -enable_server_signal_loop_encap
x When this parameter is enabled, the discovery packets will include the
x 0x90 sub-option.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role access
x -enable_client_signal_loop_id
x When this parameter is 1, the discovery packets will include
x the -agent_circuit_id and -agent_remote_id options.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role access
x -enable_server_signal_iwf
x This parameter configures the Interworking function (IWF) - When ATM
x is supported on the DSL line (the U interface), the Access Node must
x provide protocol translation between the ATM layer on the user side and
x the Ethernet layer on the network side.
x When enabled, the Access Node provides protocol translation between
x the ATM layer on the user side and the Ethernet layer on the network side.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role network
x -enable_server_signal_loop_char
x This parameter configures Access Loop Characteristics - the Access Node
x reports the access loop sync rate and interleave delay to the
x Broadband Network Gateway (BNG). This allows the BNG to enable
x policy decisions and advanced QoS enforcement, while potentially
x taking full advantage of the data rate of a given access loop.
x When this parameter is enabled, the discovery packets will include
x the 0x81 and 0x82 sub-options.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role network
x -enable_server_signal_loop_encap
x This parameter configures Signaling the Access Loop Encapsulation
x (sub-option 0x90): for access loop encapsulation the PPPoE intermediate
x agent inserts information in the PPPoE packets to signal to the BNG the
x data-link protocol and the encapsulation overhead on the Access Loop.
x For signaling of interworked sessions the Access Node must signal the
x BNG that a given PPPoE session is going to carry interworked PPPoA traffic.
x When this parameter is enabled, the discovery packets will include the
x 0x90 sub-option.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role network
x -enable_server_signal_loop_id
x When this parameter is 1, the discovery packets will include
x the -agent_circuit_id and -agent_remote_id options.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role network
x -intermediate_agent
x Enables the Intermediate Agent feature. This feature allows for
x the testing of DSLAM/BRAS devices that translate from PPPoA
x traffic to PPPoE traffic. When this option is true, the program
x inserts agent_circuit_id and agent_remote_id values into PPPoE
x tags for each PPPoE session.
x -intermediate_agent_encap1
x This parameter configures Signaling the Access Loop Encapsulation
x (sub-option 0x90), for details refer to -enable_server_signal_loop_encap.
x The PPPoE intermediate agent on the Access Node inserts the 0x90
x sub-option to signal to the BNG the encapsulation overhead on the
x Access Loop.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1
x -intermediate_agent_encap2
x This parameter configures Signaling the Access Loop Encapsulation
x (sub-option 0x90), for details refer to -enable_server_signal_loop_encap.
x The PPPoE intermediate agent on the Access Node inserts the 0x90
x sub-option to signal to the BNG the encapsulation overhead on the
x Access Loop.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1
x -ipv6_global_address_mode
x Select the protocol used to set IPv6 global interfaces on PPP interfaces.
x This configuration applies at port level.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role is
x 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -ipv6_pool_prefix_len
x Pool prefix length. The difference between the address and pool prefix
x lengths determine the size of the IPv6 IP pool
x -ipv6_pool_prefix
x Pool prefix length. The difference between the address and pool prefix
x lengths determine the size of the IPv6 IP pool
x -ipv6_pool_addr_prefix_len
x The IPv6 address prefix length.
x -ppp_local_iid
x The local base IPv6 interface ID.
x -lcp_conf_req_mode
x -lcp_conf_req_retries
x Number of config-request retries with same local options in response to config-reject after which
x the connection will close.
x -lcp_conf_req_interval
x Time interval between config-reject received and config-request with same local options sent in response, in seconds.
x -ncp_conf_req_mode
x -ncp_conf_req_retries
x Number of config-request retries with same local options in response to config-nak after which
x the connection will close.
x -ncp_conf_req_interval
x Time interval between config-nak received and config-request with same local options sent in response, in seconds.
x -ncp_enable_ip_comp
x Enable IP Compression Protocol.
x -ncp_ip_comp_protocol
x -vj_max_slot_id
x This field indicates the maximum slot identifier.
x -vj_comp_slot_id
x This field indicates whether the slot identifier field may be compressed.
x 0The slot identifier must not be compressed.
x 1The slot identifer may be compressed.
x -iphc_tcp_space
x The TCP_SPACE field is two octets and indicates the maximum value
x of a context identifier in the space of context identifiers
x allocated for TCP.
x -iphc_non_tcp_space
x The NON_TCP_SPACE field is two octets and indicates the maximum
x value of a context identifier in the space of context identifiers
x allocated for non-TCP.
x -iphc_f_max_period
x Maximum interval between full headers.
x -iphc_f_max_time
x Maximum time interval between full headers.
x -rohc_max_cid
x The MAX_CID field is two octets and indicates the maximum value of
x a context identifier.
x -rohc_mrru
x The MRRU field is two octets and indicates the maximum
x reconstructed reception unit for Robust Header Compression.
x -comp_max_header
x The largest header size in octets that may be compressed.
x -comp_sub_options
x This field contain suboptions data in hex format.
x -ppp_local_ip
x The first address assigned on the local PPP node.
x -ppp_local_ip_step
x The value by which ppp_local_ip is incremented for each session.
x -ppp_local_iid_step
x Server IPv6CP interface identifier increment, used in conjuction with the base identifier
x -ppp_peer_iid
x The peer base IPv6 interface ID.
x -ppp_peer_iid_step
x Client IPv6CP interface identifier increment, used in conjuction with the base identifier
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part7
|
x taking full advantage of the data rate of a given access loop.
x When this parameter is enabled, the discovery packets will include
x the 0x81 and 0x82 sub-options.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role network
x -enable_server_signal_loop_encap
x This parameter configures Signaling the Access Loop Encapsulation
x (sub-option 0x90): for access loop encapsulation the PPPoE intermediate
x agent inserts information in the PPPoE packets to signal to the BNG the
x data-link protocol and the encapsulation overhead on the Access Loop.
x For signaling of interworked sessions the Access Node must signal the
x BNG that a given PPPoE session is going to carry interworked PPPoA traffic.
x When this parameter is enabled, the discovery packets will include the
x 0x90 sub-option.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role network
x -enable_server_signal_loop_id
x When this parameter is 1, the discovery packets will include
x the -agent_circuit_id and -agent_remote_id options.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1; -port_role network
x -intermediate_agent
x Enables the Intermediate Agent feature. This feature allows for
x the testing of DSLAM/BRAS devices that translate from PPPoA
x traffic to PPPoE traffic. When this option is true, the program
x inserts agent_circuit_id and agent_remote_id values into PPPoE
x tags for each PPPoE session.
x -intermediate_agent_encap1
x This parameter configures Signaling the Access Loop Encapsulation
x (sub-option 0x90), for details refer to -enable_server_signal_loop_encap.
x The PPPoE intermediate agent on the Access Node inserts the 0x90
x sub-option to signal to the BNG the encapsulation overhead on the
x Access Loop.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1
x -intermediate_agent_encap2
x This parameter configures Signaling the Access Loop Encapsulation
x (sub-option 0x90), for details refer to -enable_server_signal_loop_encap.
x The PPPoE intermediate agent on the Access Node inserts the 0x90
x sub-option to signal to the BNG the encapsulation overhead on the
x Access Loop.
x Available only when IxNetwork is used for PPPoX configurations.
x Dependencies: -intermediate_agent 1
x -ipv6_global_address_mode
x Select the protocol used to set IPv6 global interfaces on PPP interfaces.
x This configuration applies at port level.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role is
x 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -ipv6_pool_prefix_len
x Pool prefix length. The difference between the address and pool prefix
x lengths determine the size of the IPv6 IP pool
x -ipv6_pool_prefix
x Pool prefix length. The difference between the address and pool prefix
x lengths determine the size of the IPv6 IP pool
x -ipv6_pool_addr_prefix_len
x The IPv6 address prefix length.
x -ppp_local_iid
x The local base IPv6 interface ID.
x -lcp_conf_req_mode
x -lcp_conf_req_retries
x Number of config-request retries with same local options in response to config-reject after which
x the connection will close.
x -lcp_conf_req_interval
x Time interval between config-reject received and config-request with same local options sent in response, in seconds.
x -ncp_conf_req_mode
x -ncp_conf_req_retries
x Number of config-request retries with same local options in response to config-nak after which
x the connection will close.
x -ncp_conf_req_interval
x Time interval between config-nak received and config-request with same local options sent in response, in seconds.
x -ncp_enable_ip_comp
x Enable IP Compression Protocol.
x -ncp_ip_comp_protocol
x -vj_max_slot_id
x This field indicates the maximum slot identifier.
x -vj_comp_slot_id
x This field indicates whether the slot identifier field may be compressed.
x 0The slot identifier must not be compressed.
x 1The slot identifer may be compressed.
x -iphc_tcp_space
x The TCP_SPACE field is two octets and indicates the maximum value
x of a context identifier in the space of context identifiers
x allocated for TCP.
x -iphc_non_tcp_space
x The NON_TCP_SPACE field is two octets and indicates the maximum
x value of a context identifier in the space of context identifiers
x allocated for non-TCP.
x -iphc_f_max_period
x Maximum interval between full headers.
x -iphc_f_max_time
x Maximum time interval between full headers.
x -rohc_max_cid
x The MAX_CID field is two octets and indicates the maximum value of
x a context identifier.
x -rohc_mrru
x The MRRU field is two octets and indicates the maximum
x reconstructed reception unit for Robust Header Compression.
x -comp_max_header
x The largest header size in octets that may be compressed.
x -comp_sub_options
x This field contain suboptions data in hex format.
x -ppp_local_ip
x The first address assigned on the local PPP node.
x -ppp_local_ip_step
x The value by which ppp_local_ip is incremented for each session.
x -ppp_local_iid_step
x Server IPv6CP interface identifier increment, used in conjuction with the base identifier
x -ppp_peer_iid
x The peer base IPv6 interface ID.
x -ppp_peer_iid_step
x Client IPv6CP interface identifier increment, used in conjuction with the base identifier
x -ppp_peer_ip
x The first address assigned on the peer PPP node.
x -ppp_peer_ip_step
x The value by which ppp_peer_ip is incremented for each session.
x -redial
x If true, enables access ports to redial at the PPPoE level.
x -redial_max
x The maximum number of redial attempts.
x When using IxNetwork this parameter can take values from the 1-255
x range.
x -redial_timeout
x The time to wait before restarting a session if the call was
x dropped, expressed in seconds.
x When using IxNetwork this parameter can take values from the 1-65535
x range.
x -service_name
x This string is used for matching of the PADO messages for the
x client. For server ports, this string is also sent by the server
x as the server name in the PADO message. Any string up to 32
x characters in length may be used.The string may contain text
x characters, plus a specification of the form:
x %[<start-width>:<modulo>:<repeat>]i
x -service_type
x The type of Access Concentrator matching that is desired.
x -send_dns_options
x Enable RDNSS routing advertisments
x -dns_server_list
x DNS server list separacted by semicolon. Enabled just for IPv6 and send_dns_options.
x -ra_m_flag
x If enabled, "Managed address configuration" flag will be set in Router Advertisement.
x -ra_o_flag
x If enabled, "Other configuration" flag will be set in Router Advertisement.
x -client_dns_options
x -client_dns_primary_address
x -client_dns_secondary_address
x -client_netmask_options
x -client_netmask
x Valid only when client_netmask_options is request_specific_netmask
x -client_wins_options
x -client_wins_primary_address
x Valid only when client_wins_options is request_primaryonly_wins or accept_only_primary_address_from_server
x -client_wins_secondary_address
x Valid only when client_wins_options is request_primaryonly_wins
x -server_dns_options
x -server_dns_primary_address
x -server_dns_secondary_address
x -server_netmask_options
x -server_netmask
x Valid only when server_netmask_options is supply_netmask
x -server_wins_options
x -server_wins_primary_address
x Valid when server_wins_options is supply_primary_and_secondary or supply_primary_only.
x -server_wins_secondary_address
x Valid when server_wins_options is supply_primary_and_secondary.
x -ra_timeout
x Time to wait (in seconds) for Router Advertisment before NCP up. Valid only for port_role access.
x -create_interfaces
x Enable echo request/reply. This command applies only for PPPv4 clients. Valid only for port_role access.
-attempt_rate
Specifies the rate in attempts/second at which attempts are made to
bring up sessions.
When using IxNetwork this parameter can take values from the 1-1000 range.
x -attempt_max_outstanding
x The number of triggered instances of an action that is still awaiting a response or completion
x -attempt_interval
x Time interval used to calculate the rate for triggering an action(rate = count/interval)
x -attempt_enabled
x -attempt_scale_mode
x Indicates whether the control is specified per port or per device group.
x This setting is global for all the pppoxclient protocols configured in the ixncfg
x and can be configured just when handle is /globals (when the user wants to configure just the global settings)
-disconnect_rate
Specifies the rate in disconnects/s at which sessions are
disconnected. This parameter can take values from the 1-1000 range.
x -sessionlifetime_scale_mode
x Indicates whether the control is specified per port or per device group.
x This setting is global for all the pppoxclient protocols configured in the ixncfg
x and can be configured just when handle is /globals (when the user wants to configure just the global settings)
x -disconnect_max_outstanding
x The number of triggered instances of an action that is still awaiting a response or completion
x -disconnect_interval
x Time interval used to calculate the rate for triggering an action(rate = count/interval)
x -disconnect_enabled
x -disconnect_scale_mode
x Indicates whether the control is specified per port or per device group.
x This setting is global for all the pppoxclient protocols configured in the ixncfg
x and can be configured just when handle is /globals (when the user wants to configure just the global settings)
x -enable_session_lifetime
x Enable session lifetime
x -min_lifetime
x Minimum session lifetime (in seconds)
x -max_lifetime
x Maximum session lifetime (in seconds)
x -enable_session_lifetime_restart
x Enable automatic session restart after stop at lifetime expiry
x -max_session_lifetime_restarts
x Maximum number of times each session is automatically restarted
x -unlimited_session_lifetime_restarts
x Allow each session to always be automatically restarted
x -accept_any_auth_value
x Configures a PAP/CHAP authenticator to accept all offered usernames, passwords, and base domain names
-port_handle
The port on which the PPPoX sessions is to be created.
Dependencies: -mode add (when IxNetwork is used for the
PPPoX configuration).
-protocol
Type of sessions to be configured.Valid options are:
pppoa
pppoeoa
pppoe
Only the pppoe options is supported.
n -vci
n This argument defined by Cisco is not supported for NGPF implementation.
n -vci_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -vci_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -addr_count_per_vci
n This argument defined by Cisco is not supported for NGPF implementation.
n -vpi
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part8
|
x Client IPv6CP interface identifier increment, used in conjuction with the base identifier
x -ppp_peer_ip
x The first address assigned on the peer PPP node.
x -ppp_peer_ip_step
x The value by which ppp_peer_ip is incremented for each session.
x -redial
x If true, enables access ports to redial at the PPPoE level.
x -redial_max
x The maximum number of redial attempts.
x When using IxNetwork this parameter can take values from the 1-255
x range.
x -redial_timeout
x The time to wait before restarting a session if the call was
x dropped, expressed in seconds.
x When using IxNetwork this parameter can take values from the 1-65535
x range.
x -service_name
x This string is used for matching of the PADO messages for the
x client. For server ports, this string is also sent by the server
x as the server name in the PADO message. Any string up to 32
x characters in length may be used.The string may contain text
x characters, plus a specification of the form:
x %[<start-width>:<modulo>:<repeat>]i
x -service_type
x The type of Access Concentrator matching that is desired.
x -send_dns_options
x Enable RDNSS routing advertisments
x -dns_server_list
x DNS server list separacted by semicolon. Enabled just for IPv6 and send_dns_options.
x -ra_m_flag
x If enabled, "Managed address configuration" flag will be set in Router Advertisement.
x -ra_o_flag
x If enabled, "Other configuration" flag will be set in Router Advertisement.
x -client_dns_options
x -client_dns_primary_address
x -client_dns_secondary_address
x -client_netmask_options
x -client_netmask
x Valid only when client_netmask_options is request_specific_netmask
x -client_wins_options
x -client_wins_primary_address
x Valid only when client_wins_options is request_primaryonly_wins or accept_only_primary_address_from_server
x -client_wins_secondary_address
x Valid only when client_wins_options is request_primaryonly_wins
x -server_dns_options
x -server_dns_primary_address
x -server_dns_secondary_address
x -server_netmask_options
x -server_netmask
x Valid only when server_netmask_options is supply_netmask
x -server_wins_options
x -server_wins_primary_address
x Valid when server_wins_options is supply_primary_and_secondary or supply_primary_only.
x -server_wins_secondary_address
x Valid when server_wins_options is supply_primary_and_secondary.
x -ra_timeout
x Time to wait (in seconds) for Router Advertisment before NCP up. Valid only for port_role access.
x -create_interfaces
x Enable echo request/reply. This command applies only for PPPv4 clients. Valid only for port_role access.
-attempt_rate
Specifies the rate in attempts/second at which attempts are made to
bring up sessions.
When using IxNetwork this parameter can take values from the 1-1000 range.
x -attempt_max_outstanding
x The number of triggered instances of an action that is still awaiting a response or completion
x -attempt_interval
x Time interval used to calculate the rate for triggering an action(rate = count/interval)
x -attempt_enabled
x -attempt_scale_mode
x Indicates whether the control is specified per port or per device group.
x This setting is global for all the pppoxclient protocols configured in the ixncfg
x and can be configured just when handle is /globals (when the user wants to configure just the global settings)
-disconnect_rate
Specifies the rate in disconnects/s at which sessions are
disconnected. This parameter can take values from the 1-1000 range.
x -sessionlifetime_scale_mode
x Indicates whether the control is specified per port or per device group.
x This setting is global for all the pppoxclient protocols configured in the ixncfg
x and can be configured just when handle is /globals (when the user wants to configure just the global settings)
x -disconnect_max_outstanding
x The number of triggered instances of an action that is still awaiting a response or completion
x -disconnect_interval
x Time interval used to calculate the rate for triggering an action(rate = count/interval)
x -disconnect_enabled
x -disconnect_scale_mode
x Indicates whether the control is specified per port or per device group.
x This setting is global for all the pppoxclient protocols configured in the ixncfg
x and can be configured just when handle is /globals (when the user wants to configure just the global settings)
x -enable_session_lifetime
x Enable session lifetime
x -min_lifetime
x Minimum session lifetime (in seconds)
x -max_lifetime
x Maximum session lifetime (in seconds)
x -enable_session_lifetime_restart
x Enable automatic session restart after stop at lifetime expiry
x -max_session_lifetime_restarts
x Maximum number of times each session is automatically restarted
x -unlimited_session_lifetime_restarts
x Allow each session to always be automatically restarted
x -accept_any_auth_value
x Configures a PAP/CHAP authenticator to accept all offered usernames, passwords, and base domain names
-port_handle
The port on which the PPPoX sessions is to be created.
Dependencies: -mode add (when IxNetwork is used for the
PPPoX configuration).
-protocol
Type of sessions to be configured.Valid options are:
pppoa
pppoeoa
pppoe
Only the pppoe options is supported.
n -vci
n This argument defined by Cisco is not supported for NGPF implementation.
n -vci_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -vci_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -addr_count_per_vci
n This argument defined by Cisco is not supported for NGPF implementation.
n -vpi
n This argument defined by Cisco is not supported for NGPF implementation.
n -vpi_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -vpi_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -addr_count_per_vpi
n This argument defined by Cisco is not supported for NGPF implementation.
n -pvc_incr_mode
n This argument defined by Cisco is not supported for NGPF implementation.
-encap
Encapsulation type for session.
Dependencies: -mode add (when IxNetwork is used for the
PPPoX configuration) and -protocol.
x -address_per_vlan
x How often a new outer VLAN ID is generated. For example, a value of 10
x will cause a new VLAN ID to be used in blocks of 10 IP addresses.
x -address_per_svlan
x How often a new inner VLAN ID is generated. For example, a value of 10
x will cause a new VLAN ID to be used in blocks of 10 IP addresses.
-qinq_incr_mode
-vlan_id_outer
Starting outer VLAN ID, applies to PPPoE w/Stacked VLAN only.
-vlan_id_outer_count
Number of outer VLAN IDs, applies to PPPoE w/Stacked VLAN only.
-vlan_id_outer_step
Step value applied to outer VLAN ID, PPPoEoE w/Stacked VLAN only.
n -vlan_user_priority_count
n This argument defined by Cisco is not supported for NGPF implementation.
-password_wildcard
Enables wildcard substituation in the password field.
Notes: If mode is modify, all the wildcard parameters (password
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
-username_wildcard
Enables wildcard substitution in the username field.
Notes: If mode is modify, all the wildcard parameters (username
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
-wildcard_pound_start
Starting value for wildcard symbol 1 (\) substitution. It is also
valid to useas the substitution symbol.
Enables wildcard substitution in the username field.
Notes: If mode is modify, all the wildcard parameters (username
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
This parameter can be provided in various formats. For example, the
number 2 can be provided as follows: 2, 02, 002, 0002, 00002.
-wildcard_pound_end
Ending value for wildcard symbol 1 (\) substitution. It is also valid
to useas the substitution symbol.
Enables wildcard substitution in the username field.
Notes: If mode is modify, all the wildcard parameters (username
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
This parameter can be provided in various formats. For example, the
number 2 can be provided as follows: 2, 02, 002, 0002, 00002.
It must be the same format as for wildcard_pound_start.
-wildcard_question_start
Starting value for wildcard symbol 2 (?) substitution.
Enables wildcard substitution in the username field.
Notes: If mode is modify, all the wildcard parameters (username
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
This parameter can be provided in various formats. For example, the
number 2 can be provided as follows: 2, 02, 002, 0002, 00002.
-wildcard_question_end
Ending value for wildcard symbol 2 (?) substitution.
Enables wildcard substitution in the username field.
Notes: If mode is modify, all the wildcard parameters (username
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
This parameter can be provided in various formats. For example, the
number 2 can be provided as follows: 2, 02, 002, 0002, 00002.
It must be the same format as for wildcard_question_start.
-ac_select_list
This option is used in case ac_select_mode is chosen as ac_mac or.
ac_name. It specifies the AC MAC address and percentage pair as list:
{00:11:00:00:00:11|50 00:11:00:00:00:12|50} or
[list 00:11:00:00:00:11|50 00:11:00:00:00:12|50]
or it specifies the ac name and percentage pair as list:
{ciscoAC1|60 ciscoAC2|40} or [list ciscoAC1|60 ciscoAC2|40]
n -enable_throttling
n This argument defined by Cisco is not supported for NGPF implementation.
n -enable_setup_throttling
n This argument defined by Cisco is not supported for NGPF implementation.
n -enable_multicast
n This argument defined by Cisco is not supported for NGPF implementation.
n -local_magic
n This argument defined by Cisco is not supported for NGPF implementation.
n -term_req_timeout
n This argument defined by Cisco is not supported for NGPF implementation.
x -lcp_max_failure
x Number of Configure-Nak packets received before abandon link setup
x -lcp_start_delay
x Delay time in milliseconds to wait before sending LCP Config packet
-max_outstanding
Specifies the maximum number of sessions in progress, which
includes the sessions in the process of either coming up or
disconnecting, at one time.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part9
|
n This argument defined by Cisco is not supported for NGPF implementation.
n -vpi
n This argument defined by Cisco is not supported for NGPF implementation.
n -vpi_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -vpi_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -addr_count_per_vpi
n This argument defined by Cisco is not supported for NGPF implementation.
n -pvc_incr_mode
n This argument defined by Cisco is not supported for NGPF implementation.
-encap
Encapsulation type for session.
Dependencies: -mode add (when IxNetwork is used for the
PPPoX configuration) and -protocol.
x -address_per_vlan
x How often a new outer VLAN ID is generated. For example, a value of 10
x will cause a new VLAN ID to be used in blocks of 10 IP addresses.
x -address_per_svlan
x How often a new inner VLAN ID is generated. For example, a value of 10
x will cause a new VLAN ID to be used in blocks of 10 IP addresses.
-qinq_incr_mode
-vlan_id_outer
Starting outer VLAN ID, applies to PPPoE w/Stacked VLAN only.
-vlan_id_outer_count
Number of outer VLAN IDs, applies to PPPoE w/Stacked VLAN only.
-vlan_id_outer_step
Step value applied to outer VLAN ID, PPPoEoE w/Stacked VLAN only.
n -vlan_user_priority_count
n This argument defined by Cisco is not supported for NGPF implementation.
-password_wildcard
Enables wildcard substituation in the password field.
Notes: If mode is modify, all the wildcard parameters (password
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
-username_wildcard
Enables wildcard substitution in the username field.
Notes: If mode is modify, all the wildcard parameters (username
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
-wildcard_pound_start
Starting value for wildcard symbol 1 (\) substitution. It is also
valid to useas the substitution symbol.
Enables wildcard substitution in the username field.
Notes: If mode is modify, all the wildcard parameters (username
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
This parameter can be provided in various formats. For example, the
number 2 can be provided as follows: 2, 02, 002, 0002, 00002.
-wildcard_pound_end
Ending value for wildcard symbol 1 (\) substitution. It is also valid
to useas the substitution symbol.
Enables wildcard substitution in the username field.
Notes: If mode is modify, all the wildcard parameters (username
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
This parameter can be provided in various formats. For example, the
number 2 can be provided as follows: 2, 02, 002, 0002, 00002.
It must be the same format as for wildcard_pound_start.
-wildcard_question_start
Starting value for wildcard symbol 2 (?) substitution.
Enables wildcard substitution in the username field.
Notes: If mode is modify, all the wildcard parameters (username
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
This parameter can be provided in various formats. For example, the
number 2 can be provided as follows: 2, 02, 002, 0002, 00002.
-wildcard_question_end
Ending value for wildcard symbol 2 (?) substitution.
Enables wildcard substitution in the username field.
Notes: If mode is modify, all the wildcard parameters (username
username_wildcard password_wildcard wildcard_pound_start
wildcard_pound_end wildcard_question_start wildcard_question_end)
must be reconfigured. Otherwise invalid configurations may result.
This parameter can be provided in various formats. For example, the
number 2 can be provided as follows: 2, 02, 002, 0002, 00002.
It must be the same format as for wildcard_question_start.
-ac_select_list
This option is used in case ac_select_mode is chosen as ac_mac or.
ac_name. It specifies the AC MAC address and percentage pair as list:
{00:11:00:00:00:11|50 00:11:00:00:00:12|50} or
[list 00:11:00:00:00:11|50 00:11:00:00:00:12|50]
or it specifies the ac name and percentage pair as list:
{ciscoAC1|60 ciscoAC2|40} or [list ciscoAC1|60 ciscoAC2|40]
n -enable_throttling
n This argument defined by Cisco is not supported for NGPF implementation.
n -enable_setup_throttling
n This argument defined by Cisco is not supported for NGPF implementation.
n -enable_multicast
n This argument defined by Cisco is not supported for NGPF implementation.
n -local_magic
n This argument defined by Cisco is not supported for NGPF implementation.
n -term_req_timeout
n This argument defined by Cisco is not supported for NGPF implementation.
x -lcp_max_failure
x Number of Configure-Nak packets received before abandon link setup
x -lcp_start_delay
x Delay time in milliseconds to wait before sending LCP Config packet
-max_outstanding
Specifies the maximum number of sessions in progress, which
includes the sessions in the process of either coming up or
disconnecting, at one time.
When using IxNetwork this parameter can take values from the 1-1000
range.
x -dhcpv6_hosts_enable
x Valid choices are:
x 0 ' Configure standard PPPoE
x 1 ' Enable using DHCPv6 hosts behind PPP CPE feature.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access' and 'mode is 'create'. Configurations created with 'dhcpv6_hosts_enable '0'
x cannot coexist on the same port with ranges created with 'dhcpv6_hosts_enable 1.
x -dhcp6_global_echo_ia_info
x If 1 the DHCPv6 client will request the exact address as advertised by the server.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x Valid choices are:
x 0 - (DEFAULT) Disabled
x 1 - Enabled
x -dhcp6_global_max_outstanding_releases
x The maximum number of requests to be sent by all DHCP clients during session
x teardown.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_max_outstanding_requests
x The maximum number of requests to be sent by all DHCP clients during session
x startup.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_reb_max_rt
x RFC 3315 max rebind timeout value in seconds.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_reb_timeout
x RFC 3315 initial rebind timeout value in seconds.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_rel_max_rc
x RFC 3315 release attempts.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_rel_timeout
x RFC 3315 initial release timeout in seconds.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_ren_max_rt
x RFC 3315 max renew timeout in secons.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_ren_timeout
x RFC 3315 initial renew timeout in secons.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_req_max_rc
x RFC 3315 max request retry attempts.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_req_max_rt
x RFC 3315 max request timeout value in secons.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_req_timeout
x RFC 3315 initial request timeout value in secons.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_setup_rate_initial
x Setup rate is the number of clients to start in each second. This value
x represents the initial value for setup rate.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
n -dhcp6_global_setup_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part10
|
When using IxNetwork this parameter can take values from the 1-1000
range.
x -dhcpv6_hosts_enable
x Valid choices are:
x 0 ' Configure standard PPPoE
x 1 ' Enable using DHCPv6 hosts behind PPP CPE feature.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access' and 'mode is 'create'. Configurations created with 'dhcpv6_hosts_enable '0'
x cannot coexist on the same port with ranges created with 'dhcpv6_hosts_enable 1.
x -dhcp6_global_echo_ia_info
x If 1 the DHCPv6 client will request the exact address as advertised by the server.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x Valid choices are:
x 0 - (DEFAULT) Disabled
x 1 - Enabled
x -dhcp6_global_max_outstanding_releases
x The maximum number of requests to be sent by all DHCP clients during session
x teardown.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_max_outstanding_requests
x The maximum number of requests to be sent by all DHCP clients during session
x startup.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_reb_max_rt
x RFC 3315 max rebind timeout value in seconds.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_reb_timeout
x RFC 3315 initial rebind timeout value in seconds.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_rel_max_rc
x RFC 3315 release attempts.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_rel_timeout
x RFC 3315 initial release timeout in seconds.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_ren_max_rt
x RFC 3315 max renew timeout in secons.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_ren_timeout
x RFC 3315 initial renew timeout in secons.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_req_max_rc
x RFC 3315 max request retry attempts.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_req_max_rt
x RFC 3315 max request timeout value in secons.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_req_timeout
x RFC 3315 initial request timeout value in secons.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_setup_rate_initial
x Setup rate is the number of clients to start in each second. This value
x represents the initial value for setup rate.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
n -dhcp6_global_setup_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
n -dhcp6_global_setup_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
x -dhcp6_global_sol_max_rc
x RFC 3315 max solicit retry attempts.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_sol_max_rt
x RFC 3315 max solicit timeout value in seconds.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_sol_timeout
x RFC 3315 initial solicit timeout value in seconds.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_teardown_rate_initial
x Setup rate is the number of clients to stop in each second. This value
x represents the initial value for teardown rate.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
n -dhcp6_global_teardown_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
n -dhcp6_global_teardown_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
n -dhcp6_global_wait_for_completion
n This argument defined by Cisco is not supported for NGPF implementation.
x -dhcpv6pd_type
x -dhcp6_pd_client_range_duid_enterprise_id
x Define the vendor's registered Private Enterprise Number as maintained by IANA.
x Available starting with HLT API 3.90. Valid when port_role is 'access';
x dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack';
x dhcp6_pd_client_range_duid_type is 'duid_en'.
x -dhcp6_pd_client_range_duid_type
x Define the DHCP unique identifier type.
x Available starting with HLT API 3.90. Valid when port_role is 'access';
x dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pd_client_range_duid_vendor_id
x Define the vendor-assigned unique ID for this range. This ID is incremented
x automatically for each DHCP client.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or
x 'dual_stack'; dhcp6_pd_client_range_duid_type is 'duid_en'.
x -dhcp6_pd_client_range_duid_vendor_id_increment
x Define the step to increment the vendor ID for each DHCP client.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack';
x dhcp6_pd_client_range_duid_type is 'duid_en'.
x -dhcp6_pd_client_range_ia_id
x Define the identity association unique ID for this range. This ID is incremented
x automatically for each DHCP client.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role is '
x access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pd_client_range_ia_id_increment
x Define the step used to increment dhcp6_pd_client_range_ia_id for each
x DHCP client.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pd_client_range_ia_t1
x Define the suggested time at which the client contacts the server from which
x the addresses were obtained to extend the lifetimes of the addresses assigned.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pd_client_range_ia_t2
x Define the suggested time at which the client contacts any available
x server to extend the lifetimes of the addresses assigned.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pd_client_range_ia_type
x Define Identity Association Type.
x Valid choices are:IAPD, IANA, IATA, IANA_IAPD
x Dependencies: Available starting with HLT API 3.90. Valid when port_role is
x 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
n -dhcp6_pd_client_range_param_request_list
n This argument defined by Cisco is not supported for NGPF implementation.
x -dhcp6_pd_client_range_renew_timer
x Define the user-defined lease renewal timer. The value is estimated in seconds
x and will override the lease renewal timer if it is not zero and is smaller than the server-defined value.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part11
|
n -dhcp6_global_setup_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
x -dhcp6_global_sol_max_rc
x RFC 3315 max solicit retry attempts.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_sol_max_rt
x RFC 3315 max solicit timeout value in seconds.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_sol_timeout
x RFC 3315 initial solicit timeout value in seconds.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_global_teardown_rate_initial
x Setup rate is the number of clients to stop in each second. This value
x represents the initial value for teardown rate.
x This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
n -dhcp6_global_teardown_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
n -dhcp6_global_teardown_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
n -dhcp6_global_wait_for_completion
n This argument defined by Cisco is not supported for NGPF implementation.
x -dhcpv6pd_type
x -dhcp6_pd_client_range_duid_enterprise_id
x Define the vendor's registered Private Enterprise Number as maintained by IANA.
x Available starting with HLT API 3.90. Valid when port_role is 'access';
x dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack';
x dhcp6_pd_client_range_duid_type is 'duid_en'.
x -dhcp6_pd_client_range_duid_type
x Define the DHCP unique identifier type.
x Available starting with HLT API 3.90. Valid when port_role is 'access';
x dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pd_client_range_duid_vendor_id
x Define the vendor-assigned unique ID for this range. This ID is incremented
x automatically for each DHCP client.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or
x 'dual_stack'; dhcp6_pd_client_range_duid_type is 'duid_en'.
x -dhcp6_pd_client_range_duid_vendor_id_increment
x Define the step to increment the vendor ID for each DHCP client.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack';
x dhcp6_pd_client_range_duid_type is 'duid_en'.
x -dhcp6_pd_client_range_ia_id
x Define the identity association unique ID for this range. This ID is incremented
x automatically for each DHCP client.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role is '
x access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pd_client_range_ia_id_increment
x Define the step used to increment dhcp6_pd_client_range_ia_id for each
x DHCP client.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pd_client_range_ia_t1
x Define the suggested time at which the client contacts the server from which
x the addresses were obtained to extend the lifetimes of the addresses assigned.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pd_client_range_ia_t2
x Define the suggested time at which the client contacts any available
x server to extend the lifetimes of the addresses assigned.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pd_client_range_ia_type
x Define Identity Association Type.
x Valid choices are:IAPD, IANA, IATA, IANA_IAPD
x Dependencies: Available starting with HLT API 3.90. Valid when port_role is
x 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
n -dhcp6_pd_client_range_param_request_list
n This argument defined by Cisco is not supported for NGPF implementation.
x -dhcp6_pd_client_range_renew_timer
x Define the user-defined lease renewal timer. The value is estimated in seconds
x and will override the lease renewal timer if it is not zero and is smaller than the server-defined value.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role is
x 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
n -dhcp6_pd_client_range_use_vendor_class_id
n This argument defined by Cisco is not supported for NGPF implementation.
n -dhcp6_pd_client_range_vendor_class_id
n This argument defined by Cisco is not supported for NGPF implementation.
x -dhcp6_pd_server_range_dns_domain_search_list
x Specifies the domain that the client will use when resolving host names with DNS.
x -dhcp6_pd_server_range_first_dns_server
x The first DNS server associated with this address pool. This is the first DNS
x address that will be assigned to any client that is allocated an IP address from this
x pool.
x -dhcp6_pd_server_range_second_dns_server
x The second DNS server associated with this address pool. This is the second (of
x two) DNS addresses that will be assigned to any client that is allocated an IP
x address from this pool.
x -dhcp6_pd_server_range_subnet_prefix
x The prefix value used to subnet the addresses specified in the address pool. This
x is the subnet prefix length advertised in DHCPv6PD Offer and Reply messages.
x -dhcp6_pd_server_range_start_pool_address
x The starting IPv6 address for this DHCPv6 address pool.
x -dhcp6_pgdata_max_outstanding_requests
x The maximum number of requests to be sent by all DHCP clients during session
x startup. This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or
x 'dual_stack'.
x Parameter dhcp6_pgdata_override_global_setup_rate is '1'
x -dhcp6_pgdata_override_global_setup_rate
x This parameter refers to the DHCPv6 Client Port Group Data. This parameter
x applies at the port level.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role is
x 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pgdata_setup_rate_initial
x This parameter refers to the DHCPv6 Client Port Group Data. This parameter
x applies at the port level.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x Parameter dhcp6_pgdata_override_global_setup_rate is '1'
n -dhcp6_pgdata_setup_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
n -dhcp6_pgdata_setup_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
x -dhcp6_pgdata_max_outstanding_releases
x The maximum number of requests to be sent by all DHCP clients during session
x teardown. This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or
x 'dual_stack'.
x Parameter dhcp6_pgdata_override_global_teardown_rate is '1'
x -dhcp6_pgdata_override_global_teardown_rate
x This parameter refers to the DHCPv6 Client Port Group Data. This parameter
x applies at the port level.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'
x -dhcp6_pgdata_teardown_rate_initial
x Description This parameter refers to the DHCPv6 Client Port Group Data.
x This parameter applies at the port level.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x Parameter dhcp6_pgdata_override_global_teardown_rate is '1'
n -dhcp6_pgdata_teardown_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
n -dhcp6_pgdata_teardown_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_ip_outer_prefix
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_ip_prefix_addr
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_eui_increment
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_first_eui
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_ip_prefix
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_subnet_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -lease_time_max
n This argument defined by Cisco is not supported for NGPF implementation.
x -lease_time
x The duration of an address lease, in seconds, if the client requesting the lease
x does not ask for a specific expiration time. The default value is 3600; the
x minimum is 300; and the maximum is 30,000,000.
n -padi_include_tag
n This argument defined by Cisco is not supported for NGPF implementation.
n -pado_include_tag
n This argument defined by Cisco is not supported for NGPF implementation.
n -padr_include_tag
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part12
|
x and will override the lease renewal timer if it is not zero and is smaller than the server-defined value.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role is
x 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
n -dhcp6_pd_client_range_use_vendor_class_id
n This argument defined by Cisco is not supported for NGPF implementation.
n -dhcp6_pd_client_range_vendor_class_id
n This argument defined by Cisco is not supported for NGPF implementation.
x -dhcp6_pd_server_range_dns_domain_search_list
x Specifies the domain that the client will use when resolving host names with DNS.
x -dhcp6_pd_server_range_first_dns_server
x The first DNS server associated with this address pool. This is the first DNS
x address that will be assigned to any client that is allocated an IP address from this
x pool.
x -dhcp6_pd_server_range_second_dns_server
x The second DNS server associated with this address pool. This is the second (of
x two) DNS addresses that will be assigned to any client that is allocated an IP
x address from this pool.
x -dhcp6_pd_server_range_subnet_prefix
x The prefix value used to subnet the addresses specified in the address pool. This
x is the subnet prefix length advertised in DHCPv6PD Offer and Reply messages.
x -dhcp6_pd_server_range_start_pool_address
x The starting IPv6 address for this DHCPv6 address pool.
x -dhcp6_pgdata_max_outstanding_requests
x The maximum number of requests to be sent by all DHCP clients during session
x startup. This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or
x 'dual_stack'.
x Parameter dhcp6_pgdata_override_global_setup_rate is '1'
x -dhcp6_pgdata_override_global_setup_rate
x This parameter refers to the DHCPv6 Client Port Group Data. This parameter
x applies at the port level.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role is
x 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x -dhcp6_pgdata_setup_rate_initial
x This parameter refers to the DHCPv6 Client Port Group Data. This parameter
x applies at the port level.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x Parameter dhcp6_pgdata_override_global_setup_rate is '1'
n -dhcp6_pgdata_setup_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
n -dhcp6_pgdata_setup_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
x -dhcp6_pgdata_max_outstanding_releases
x The maximum number of requests to be sent by all DHCP clients during session
x teardown. This parameter applies globally for all the ports in the configuration.
x Available starting with HLT API 3.90 IxNetwork is used for PPPoX configurations.
x Valid when port_role is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or
x 'dual_stack'.
x Parameter dhcp6_pgdata_override_global_teardown_rate is '1'
x -dhcp6_pgdata_override_global_teardown_rate
x This parameter refers to the DHCPv6 Client Port Group Data. This parameter
x applies at the port level.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'
x -dhcp6_pgdata_teardown_rate_initial
x Description This parameter refers to the DHCPv6 Client Port Group Data.
x This parameter applies at the port level.
x Dependencies: Available starting with HLT API 3.90. Valid when port_role
x is 'access'; dhcpv6_hosts_enable is 1; ip_cp is 'ipv6_cp' or 'dual_stack'.
x Parameter dhcp6_pgdata_override_global_teardown_rate is '1'
n -dhcp6_pgdata_teardown_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
n -dhcp6_pgdata_teardown_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_ip_outer_prefix
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_ip_prefix_addr
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_eui_increment
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_first_eui
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_ip_prefix
n This argument defined by Cisco is not supported for NGPF implementation.
n -hosts_range_subnet_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -lease_time_max
n This argument defined by Cisco is not supported for NGPF implementation.
x -lease_time
x The duration of an address lease, in seconds, if the client requesting the lease
x does not ask for a specific expiration time. The default value is 3600; the
x minimum is 300; and the maximum is 30,000,000.
n -padi_include_tag
n This argument defined by Cisco is not supported for NGPF implementation.
n -pado_include_tag
n This argument defined by Cisco is not supported for NGPF implementation.
n -padr_include_tag
n This argument defined by Cisco is not supported for NGPF implementation.
n -pads_include_tag
n This argument defined by Cisco is not supported for NGPF implementation.
n -re_connect_on_link_up
n This argument defined by Cisco is not supported for NGPF implementation.
n -group_ip_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -group_ip_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -start_group_ip
n This argument defined by Cisco is not supported for NGPF implementation.
n -igmp_version
n This argument defined by Cisco is not supported for NGPF implementation.
n -is_last_subport
n This argument defined by Cisco is not supported for NGPF implementation.
n -join_leaves_per_second
n This argument defined by Cisco is not supported for NGPF implementation.
n -l4_src_port
n This argument defined by Cisco is not supported for NGPF implementation.
n -l4_dst_port
n This argument defined by Cisco is not supported for NGPF implementation.
n -l4_flow_number
n This argument defined by Cisco is not supported for NGPF implementation.
n -l4_flow_type
n This argument defined by Cisco is not supported for NGPF implementation.
n -l4_flow_variant
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_general_query
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_group_specific_query
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_immediate_response
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_packing
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_router_alert
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_suppress_reports
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_unsolicited
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_group_id
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_report_frequency
n This argument defined by Cisco is not supported for NGPF implementation.
n -ppp_local_mode
n This argument defined by Cisco is not supported for NGPF implementation.
n -ppp_peer_mode
n This argument defined by Cisco is not supported for NGPF implementation.
n -enable_delete_config
n This argument defined by Cisco is not supported for NGPF implementation.
n -flap_repeat_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -flap_rate
n This argument defined by Cisco is not supported for NGPF implementation.
n -switch_duration
n This argument defined by Cisco is not supported for NGPF implementation.
n -watch_duration
n This argument defined by Cisco is not supported for NGPF implementation.
n -hold_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -cool_off_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -dut_assigned_src_addr
n This argument defined by Cisco is not supported for NGPF implementation.
n -include_id
n This argument defined by Cisco is not supported for NGPF implementation.
n -sessions_per_vc
n This argument defined by Cisco is not supported for NGPF implementation.
x -enable_host_uniq
x Enables PPPoE Host-Uniq tag
x -rx_connect_speed
x Rx Connect Speed for the client
x -tx_connect_speed
x Tx Connect Speed for the client
x -connect_speed_update_enable
x If checked, LAC will send Connect Speed Update Enable AVP in ICRQ control message
x -host_uniq_length
x Host-Uniq
x -host_uniq
x Host-Uniq
x -multiplier
x number of layer instances per parent instance (multiplier)
x -dsl_type_tlv
x DSL Type to be advertised in PPPoE VSA Tag. For undefined DSL type user has to select "User-defined DSL Type".
x -user_defined_dsl_type_tlv
x User Defined DSL-Type Value.
x -enable_server_signal_dsl_type_tlv
x DSL-Type TLV to be inserted in PPPoE VSA Tag.
x -pon_type_tlv
x PON Type to be advertised in PPPoE VSA Tag. For undefined PON type user has to select "User-defined PON Type".
x -user_defined_pon_type_tlv
x User Defined PON-Type Value.
x -enable_server_signal_pon_type_tlv
x PON-Type TLV to be inserted in PPPoE VSA Tag.
x -enable_mrru_negotiation
x The presence of the LCP MRRU option indicates that the PPP multilink protocol is implemented by the system sending it.
x -multilink_mrru_size
x The maximum number of octets in the information fields of reassembled packets of the MRRU.
x Select to configure the MRRU size used in negotiation of the multilink protocol MRRU option in the LCP stage. Valid values are: 576 to 9000.
x Default value is 1492.
x -mlppp_endpointdiscriminator_option
x Select to define the ML-PPP endpoint discriminator options in the LCP-Configure request.
x -endpoint_discriminator_class
x -internet_protocol_address
x The IP address used in the ML-PPP endpoint discriminator option of the LCP configure request sent by PPP clients.
x -mac_address
x The MAC addresses are automatically derived from the local MAC address. An address in this class contains an IEEE 802.1 MAC address is canonical (802.3) format.
Return Values:
A list containing the pppox client protocol stack handles that were added by the command (if any).
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part13
|
n This argument defined by Cisco is not supported for NGPF implementation.
n -padr_include_tag
n This argument defined by Cisco is not supported for NGPF implementation.
n -pads_include_tag
n This argument defined by Cisco is not supported for NGPF implementation.
n -re_connect_on_link_up
n This argument defined by Cisco is not supported for NGPF implementation.
n -group_ip_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -group_ip_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -start_group_ip
n This argument defined by Cisco is not supported for NGPF implementation.
n -igmp_version
n This argument defined by Cisco is not supported for NGPF implementation.
n -is_last_subport
n This argument defined by Cisco is not supported for NGPF implementation.
n -join_leaves_per_second
n This argument defined by Cisco is not supported for NGPF implementation.
n -l4_src_port
n This argument defined by Cisco is not supported for NGPF implementation.
n -l4_dst_port
n This argument defined by Cisco is not supported for NGPF implementation.
n -l4_flow_number
n This argument defined by Cisco is not supported for NGPF implementation.
n -l4_flow_type
n This argument defined by Cisco is not supported for NGPF implementation.
n -l4_flow_variant
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_general_query
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_group_specific_query
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_immediate_response
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_packing
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_router_alert
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_suppress_reports
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_enable_unsolicited
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_group_id
n This argument defined by Cisco is not supported for NGPF implementation.
n -mc_report_frequency
n This argument defined by Cisco is not supported for NGPF implementation.
n -ppp_local_mode
n This argument defined by Cisco is not supported for NGPF implementation.
n -ppp_peer_mode
n This argument defined by Cisco is not supported for NGPF implementation.
n -enable_delete_config
n This argument defined by Cisco is not supported for NGPF implementation.
n -flap_repeat_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -flap_rate
n This argument defined by Cisco is not supported for NGPF implementation.
n -switch_duration
n This argument defined by Cisco is not supported for NGPF implementation.
n -watch_duration
n This argument defined by Cisco is not supported for NGPF implementation.
n -hold_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -cool_off_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -dut_assigned_src_addr
n This argument defined by Cisco is not supported for NGPF implementation.
n -include_id
n This argument defined by Cisco is not supported for NGPF implementation.
n -sessions_per_vc
n This argument defined by Cisco is not supported for NGPF implementation.
x -enable_host_uniq
x Enables PPPoE Host-Uniq tag
x -rx_connect_speed
x Rx Connect Speed for the client
x -tx_connect_speed
x Tx Connect Speed for the client
x -connect_speed_update_enable
x If checked, LAC will send Connect Speed Update Enable AVP in ICRQ control message
x -host_uniq_length
x Host-Uniq
x -host_uniq
x Host-Uniq
x -multiplier
x number of layer instances per parent instance (multiplier)
x -dsl_type_tlv
x DSL Type to be advertised in PPPoE VSA Tag. For undefined DSL type user has to select "User-defined DSL Type".
x -user_defined_dsl_type_tlv
x User Defined DSL-Type Value.
x -enable_server_signal_dsl_type_tlv
x DSL-Type TLV to be inserted in PPPoE VSA Tag.
x -pon_type_tlv
x PON Type to be advertised in PPPoE VSA Tag. For undefined PON type user has to select "User-defined PON Type".
x -user_defined_pon_type_tlv
x User Defined PON-Type Value.
x -enable_server_signal_pon_type_tlv
x PON-Type TLV to be inserted in PPPoE VSA Tag.
x -enable_mrru_negotiation
x The presence of the LCP MRRU option indicates that the PPP multilink protocol is implemented by the system sending it.
x -multilink_mrru_size
x The maximum number of octets in the information fields of reassembled packets of the MRRU.
x Select to configure the MRRU size used in negotiation of the multilink protocol MRRU option in the LCP stage. Valid values are: 576 to 9000.
x Default value is 1492.
x -mlppp_endpointdiscriminator_option
x Select to define the ML-PPP endpoint discriminator options in the LCP-Configure request.
x -endpoint_discriminator_class
x -internet_protocol_address
x The IP address used in the ML-PPP endpoint discriminator option of the LCP configure request sent by PPP clients.
x -mac_address
x The MAC addresses are automatically derived from the local MAC address. An address in this class contains an IEEE 802.1 MAC address is canonical (802.3) format.
Return Values:
A list containing the pppox client protocol stack handles that were added by the command (if any).
x key:pppox_client_handle value:A list containing the pppox client protocol stack handles that were added by the command (if any).
A list containing the pppox server protocol stack handles that were added by the command (if any).
x key:pppox_server_handle value:A list containing the pppox server protocol stack handles that were added by the command (if any).
A list containing the pppox server sessions protocol stack handles that were added by the command (if any).
x key:pppox_server_sessions_handle value:A list containing the pppox server sessions protocol stack handles that were added by the command (if any).
A list containing the dhcpv6 client protocol stack handles that were added by the command (if any).
x key:dhcpv6_client_handle value:A list containing the dhcpv6 client protocol stack handles that were added by the command (if any).
A list containing the dhcpv6 server protocol stack handles that were added by the command (if any).
x key:dhcpv6_server_handle value:A list containing the dhcpv6 server protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:handle value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
ppp handles
key:handles value:ppp handles
When status is failure, contains more information
key:log value:When status is failure, contains more information
Examples:
Sample Input:
Sample Output:
Notes:
1) Coded versus functional specification.
2) When -handle is provided with the /globals value the arguments that configure global protocol
setting accept both multivalue handles and simple values.
When -handle is provided with a a protocol stack handle or a protocol session handle, the arguments
that configure global settings will only accept simple values. In this situation, these arguments will
configure only the settings of the parent device group or the ports associated with the parent topology.
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: handle
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'pppox_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part14
|
x key:pppox_client_handle value:A list containing the pppox client protocol stack handles that were added by the command (if any).
A list containing the pppox server protocol stack handles that were added by the command (if any).
x key:pppox_server_handle value:A list containing the pppox server protocol stack handles that were added by the command (if any).
A list containing the pppox server sessions protocol stack handles that were added by the command (if any).
x key:pppox_server_sessions_handle value:A list containing the pppox server sessions protocol stack handles that were added by the command (if any).
A list containing the dhcpv6 client protocol stack handles that were added by the command (if any).
x key:dhcpv6_client_handle value:A list containing the dhcpv6 client protocol stack handles that were added by the command (if any).
A list containing the dhcpv6 server protocol stack handles that were added by the command (if any).
x key:dhcpv6_server_handle value:A list containing the dhcpv6 server protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:handle value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
ppp handles
key:handles value:ppp handles
When status is failure, contains more information
key:log value:When status is failure, contains more information
Examples:
Sample Input:
Sample Output:
Notes:
1) Coded versus functional specification.
2) When -handle is provided with the /globals value the arguments that configure global protocol
setting accept both multivalue handles and simple values.
When -handle is provided with a a protocol stack handle or a protocol session handle, the arguments
that configure global settings will only accept simple values. In this situation, these arguments will
configure only the settings of the parent device group or the ports associated with the parent topology.
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: handle
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'pppox_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/pppox_config.py_part15
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_msrp_listener_config(self, mode, **kwargs):
r'''
#Procedure Header
Name:
emulation_msrp_listener_config
Description:
This procedure will configure MSRP Listener
Synopsis:
emulation_msrp_listener_config
-mode CHOICES create
CHOICES delete
CHOICES modify
CHOICES enable
CHOICES disable
[-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
[-handle ANY]
[-mac_address_init MAC]
x [-mac_address_step MAC
x DEFAULT 0000.0000.0001]
x [-vlan CHOICES 0 1]
[-vlan_id RANGE 0-4095]
[-vlan_id_mode CHOICES fixed increment
DEFAULT increment]
[-vlan_id_step RANGE 0-4096
DEFAULT 1]
[-vlan_user_priority RANGE 0-7
DEFAULT 0]
[-count ANY
DEFAULT 1]
x [-reset FLAG]
x [-msrp_Listener_active CHOICES 0 1]
x [-start_vlan_id RANGE 1-4094
x DEFAULT 2]
x [-vlan_count RANGE 1-4094
x DEFAULT 1]
x [-protocol_version HEX]
x [-join_timer RANGE 200-100000000
x DEFAULT 200]
x [-leave_timer RANGE 600-100000000
x DEFAULT 600]
x [-leave_all_timer RANGE 10000-100000000
x DEFAULT 10000]
x [-declare_unsolicited_vlan CHOICES 0 1
x DEFAULT 0]
x [-advertise_as CHOICES joinmt new
x DEFAULT new]
x [-subscribe_all CHOICES 0 1
x DEFAULT 0]
x [-domain_count RANGE 1-2
x DEFAULT 1]
x [-subscribed_stream_count RANGE 1-65535
x DEFAULT 1]
x [-sr_class_id RANGE 0-255
x DEFAULT 6]
x [-sr_class_priority_type RANGE 0-7
x DEFAULT 3]
x [-sr_class_vid RANGE 1-4094
x DEFAULT 2]
x [-domain_active CHOICES 0 1]
x [-subscribed_stream_active CHOICES 0 1]
x [-stream_id HEX]
Arguments:
-mode
-port_handle
-handle
MSRP Listener protocol Handle
-mac_address_init
This option defines the MAC address that will be configured on
the Ixia interface.If is -count > 1, this MAC address will
increment by default by step of 1, or you can specify another step by
using mac_address_step option.
x -mac_address_step
x This option defines the incrementing step for the MAC address that
x will be configured on the Ixia interface. Valid only when
x IxNetwork Tcl API is used.
x -vlan
x Enables vlan on the directly connected ISIS router interface.
x Valid options are: 0 - disable, 1 - enable.
x This option is valid only when -mode is create or -mode is modify
x and -handle is an ISIS router handle.
-vlan_id
If VLAN is enabled on the Ixia interface, this option will configure
the VLAN number.
-vlan_id_mode
If the user configures more than one interface on the Ixia with
VLAN, he can choose to automatically increment the VLAN tag
(increment)or leave it idle for each interface (fixed).
-vlan_id_step
If the -vlan_id_mode is increment, this will be the step value by
which the VLAN tags are incremented.
When vlan_id_step causes the vlan_id value to exceed it's maximum value the
increment will be done modulo <number of possible vlan ids>.
Examples: vlan_id = 4094; vlan_id_step = 2-> new vlan_id value = 0
vlan_id = 4095; vlan_id_step = 11 -> new vlan_id value = 10
-vlan_user_priority
VLAN user priority assigned to emulated router node.
-count
The number of Talkers to configure on the targeted Ixia
interface.The range is 0-1000.
x -reset
x If this option is selected, this will clear any MSRP Talker on
x the targeted interface.
x -msrp_Listener_active
x MSRP Active.
x -start_vlan_id
x 2 byte VLAN ID This field will be editable when Eanble UnSol VLAN membership is enabled. Range is 1 through 4094
x -vlan_count
x 2 bytes field. Default is 1. This field will be editable when Enable UnSol VLAN membership is enabled
x If true then all stream requests will be accepted and ready message will be sent.In this case withdraw/advertisement will be done from learned info trigger. If false then stream request will be accepted based on the srp stream IDs configured.
x -protocol_version
x Administrator Group
x -join_timer
x The Join Period Timer controls the interval, in milliseconds, between transmit opportunities that are applied to the Applicant state machine. Minimum is 200 ms and Maximum is 100000000 ms
x -leave_timer
x The leave timer controls the period of time, in milliseconds, that the Registrar state machine will wait in the LV state before transiting to the MT state. Default is 600 ms. Min is 600 ms and Max is 100000000 ms. The leave time should be at least twice the join time to allow re-registration after a leave or leave-all message, even if a message is lost.
x -leave_all_timer
x Controls the frequency, in milliseconds, with which the LeaveAll state machine generates Leave All PDUs. Default is 10000 ms. Minimum value is 10000 ms and Maximum value is 100000000 ms. To minimize the volume of re-joining traffic generated following a leaveall message, the leaveall time should be larger than the leave time.
x -declare_unsolicited_vlan
x This is used to advertise vlan membership prior to advertising listener advertisement. Required vlans information will be obtained from Start VLAN ID and VLAN Count fields.
x -advertise_as
x Advertise As
x -subscribe_all
x subscribe All
x -domain_count
x Number of domains to be configured under a listener. Min value is 1 and max value is 2. Default value is 1.
x -subscribed_stream_count
x subscribed Stream Count
x -sr_class_id
x One byte field. It will be drop down list of {Class A(6), Class B(5)}. Default is Class A(6). Note: User will not see number. User will see only Class A/B.. RANGE 0-255
x -sr_class_priority_type
x one byte field. It will be drop down list of {Class A(3), Class B(2)}. Default is Class A(3). Note: User will not see number. User will see only Class A/B.. RANGE 0-7
x -sr_class_vid
x 2 bytes field. Value will be in the range {1, 4094}. Default is 2
x -domain_active
x Domain Active.
x -subscribed_stream_active
x MSRP Subscribed Streams Active.
x -stream_id
x MSRP Stream ID
Return Values:
A list containing the ethernet protocol stack handles that were added by the command (if any).
x key:ethernet_handle value:A list containing the ethernet protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:msrp_listener_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:msrp_listener_domain_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:msrp_listener_subscribed_stream_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
When status is $::FAILURE, contains more information
key:log value:When status is $::FAILURE, contains more information
Handle of MSRP Listener configured
key:msrp_listener_handle value:Handle of MSRP Listener configured
Handle of MSRP Listener domain configured
key:msrp_listener_domain_handle value:Handle of MSRP Listener domain configured
Handle of MSRP Listener streams configured
key:msrp_listener_subscribed_stream_handle value:Handle of MSRP Listener streams configured
Examples:
Sample Input:
Sample Output:
Notes:
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: msrp_listener_handles, msrp_listener_domain_handles, msrp_listener_subscribed_stream_handles
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_msrp_listener_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_msrp_listener_config.py_part1
|
x The leave timer controls the period of time, in milliseconds, that the Registrar state machine will wait in the LV state before transiting to the MT state. Default is 600 ms. Min is 600 ms and Max is 100000000 ms. The leave time should be at least twice the join time to allow re-registration after a leave or leave-all message, even if a message is lost.
x -leave_all_timer
x Controls the frequency, in milliseconds, with which the LeaveAll state machine generates Leave All PDUs. Default is 10000 ms. Minimum value is 10000 ms and Maximum value is 100000000 ms. To minimize the volume of re-joining traffic generated following a leaveall message, the leaveall time should be larger than the leave time.
x -declare_unsolicited_vlan
x This is used to advertise vlan membership prior to advertising listener advertisement. Required vlans information will be obtained from Start VLAN ID and VLAN Count fields.
x -advertise_as
x Advertise As
x -subscribe_all
x subscribe All
x -domain_count
x Number of domains to be configured under a listener. Min value is 1 and max value is 2. Default value is 1.
x -subscribed_stream_count
x subscribed Stream Count
x -sr_class_id
x One byte field. It will be drop down list of {Class A(6), Class B(5)}. Default is Class A(6). Note: User will not see number. User will see only Class A/B.. RANGE 0-255
x -sr_class_priority_type
x one byte field. It will be drop down list of {Class A(3), Class B(2)}. Default is Class A(3). Note: User will not see number. User will see only Class A/B.. RANGE 0-7
x -sr_class_vid
x 2 bytes field. Value will be in the range {1, 4094}. Default is 2
x -domain_active
x Domain Active.
x -subscribed_stream_active
x MSRP Subscribed Streams Active.
x -stream_id
x MSRP Stream ID
Return Values:
A list containing the ethernet protocol stack handles that were added by the command (if any).
x key:ethernet_handle value:A list containing the ethernet protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:msrp_listener_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:msrp_listener_domain_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:msrp_listener_subscribed_stream_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
When status is $::FAILURE, contains more information
key:log value:When status is $::FAILURE, contains more information
Handle of MSRP Listener configured
key:msrp_listener_handle value:Handle of MSRP Listener configured
Handle of MSRP Listener domain configured
key:msrp_listener_domain_handle value:Handle of MSRP Listener domain configured
Handle of MSRP Listener streams configured
key:msrp_listener_subscribed_stream_handle value:Handle of MSRP Listener streams configured
Examples:
Sample Input:
Sample Output:
Notes:
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: msrp_listener_handles, msrp_listener_domain_handles, msrp_listener_subscribed_stream_handles
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_msrp_listener_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_msrp_listener_config.py_part2
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
from __future__ import absolute_import, print_function, division
__version__ = '1.0'
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/__init__.py_part1
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_ldp_route_config(self, mode, handle, **kwargs):
r'''
#Procedure Header
Name:
emulation_ldp_route_config
Description:
This procedure creates/modifies/deletes LSP (FEC) pools or FEC ranges on simulated LDP router Interface.
Synopsis:
emulation_ldp_route_config
-mode CHOICES create modify delete
-handle ANY
x [-return_detailed_handles CHOICES 0 1
x DEFAULT 0]
[-egress_label_mode CHOICES nextlabel fixed
DEFAULT nextlabel]
[-fec_ip_prefix_start IPV4
DEFAULT 0.0.0.0]
x [-fec_ip_prefix_step IPV4
x DEFAULT 0.0.0.1]
x [-fec_ip_prefix_length RANGE 1-32
x DEFAULT 24]
n [-fec_host_addr ANY]
n [-fec_host_prefix_length ANY]
[-fec_type CHOICES ipv4_prefix
CHOICES host_addr
CHOICES vc
CHOICES network_topology
DEFAULT ipv4_prefix]
x [-network_topology_type CHOICES grid
x CHOICES mesh
x CHOICES custom
x CHOICES ring
x CHOICES hub-and-spoke
x CHOICES tree
x CHOICES ipv4-prefix
x CHOICES fat-tree
x CHOICES linear]
x [-fec_vc_atm_enable CHOICES 0 1
x DEFAULT 1]
x [-fec_vc_atm_max_cells RANGE 1-65535
x DEFAULT 1]
[-fec_vc_cbit CHOICES 0 1
DEFAULT 1]
n [-fec_vc_ce_ip_addr ANY]
n [-fec_vc_ce_ip_addr_inner_step ANY]
n [-fec_vc_ce_ip_addr_outer_step ANY]
x [-fec_vc_cem_option RANGE 0-65535
x DEFAULT 0]
x [-fec_vc_cem_option_enable CHOICES 0 1
x DEFAULT 0]
x [-fec_vc_cem_payload RANGE 48-1023
x DEFAULT 48]
x [-fec_vc_cem_payload_enable CHOICES 0 1
x DEFAULT 1]
x [-fec_vc_count NUMERIC
x DEFAULT 1]
x [-fec_vc_fec_type CHOICES generalized_id_fec_vpls
x CHOICES pw_id_fec
x DEFAULT generalized_id_fec_vpls]
[-fec_vc_group_id NUMERIC]
n [-fec_vc_group_count ANY]
[-fec_vc_id_start RANGE 0-2147483647
DEFAULT 1]
[-fec_vc_id_step RANGE 0-2147483647
DEFAULT 1]
n [-fec_vc_id_count ANY]
n [-fec_vc_intf_mtu_enable ANY]
[-fec_vc_intf_mtu RANGE 0-65535
REGEXP ^[0-9]+$
DEFAULT 0]
[-fec_vc_intf_desc ANY]
x [-fec_vc_intf_desc_enable CHOICES 0 1]
x [-fec_vc_name ALPHA]
x [-fec_vc_active CHOICES 0 1]
n [-fec_vc_ip_range_addr_count ANY]
n [-fec_vc_ip_range_addr_start ANY]
n [-fec_vc_ip_range_addr_inner_step ANY]
n [-fec_vc_ip_range_addr_outer_step ANY]
n [-fec_vc_ip_range_enable ANY]
n [-fec_vc_ip_range_prefix_len ANY]
n [-fec_vc_label_mode ANY]
x [-fec_vc_label_value_start RANGE 0-1046400
x DEFAULT 16]
x [-fec_vc_label_value_step RANGE 0-1046400
x DEFAULT 0]
x [-fec_vc_mac_range_count NUMERIC
x DEFAULT 1]
x [-fec_vc_mac_range_enable CHOICES 0 1
x DEFAULT 0]
x [-fec_vc_mac_range_first_vlan_id RANGE 0-4095
x DEFAULT 100]
n [-fec_vc_mac_range_repeat_mac ANY]
n [-fec_vc_mac_range_same_vlan ANY]
x [-fec_vc_mac_range_start MAC
x DEFAULT 0000.0000.0000]
n [-fec_vc_mac_range_vlan_enable ANY]
x [-fec_vc_peer_address IP
x DEFAULT 0.0.0.0]
[-fec_vc_type CHOICES atm_aal5_vcc
CHOICES atm_cell
CHOICES atm_vcc_1_1
CHOICES atm_vcc_n_1
CHOICES atm_vpc_1_1
CHOICES atm_vpc_n_1
CHOICES cem
CHOICES eth
CHOICES eth_vlan
CHOICES eth_vpls
CHOICES fr_dlci
CHOICES hdlc
CHOICES ppp
CHOICES satop_e1
CHOICES satop_e3
CHOICES satop_t1
CHOICES satop_t3
CHOICES cesopsn_basic
CHOICES cesopsn_cas
CHOICES fr_dlci_rfc4619
DEFAULT eth_vlan]
n [-hop_count_tlv_enable ANY]
n [-hop_count_value ANY]
n [-label_msg_type ANY]
x [-label_value_start RANGE 0-1048575
x DEFAULT 16]
x [-label_value_start_step RANGE 0-1048575
x DEFAULT 1]
[-lsp_handle ANY]
n [-next_hop_peer_ip ANY]
[-num_lsps RANGE 1-34048
DEFAULT 1]
n [-num_routes ANY]
x [-packing_enable CHOICES 0 1
x DEFAULT 0]
x [-provisioning_model CHOICES bgp_auto_discovery
x CHOICES manual_configuration]
n [-stale_timer_enable ANY]
n [-stale_request_time ANY]
n [-no_write ANY]
x [-auto_peer_id CHOICES 0 1]
x [-fec_vc_pw_status_enable CHOICES 0 1]
x [-fec_vc_pw_status_code CHOICES clear_fault_code
x CHOICES pw_not_forwarding_code
x CHOICES ac_rx_fault_code
x CHOICES ac_tx_fault_code
x CHOICES pw_rx_fault_code
x CHOICES pw_tx_fault_code]
x [-fec_vc_pw_status_send_notification CHOICES 0 1]
x [-fec_vc_down_start NUMERIC]
x [-fec_vc_down_interval NUMERIC]
x [-fec_vc_up_interval NUMERIC]
x [-fec_vc_repeat_count NUMERIC]
x [-fec_vc_type_vpls_id CHOICES id_as_number id_ip_address]
x [-fec_vc_ip_address_vpls_id ANY]
x [-fec_vc_as_number_vpls_id ANY]
x [-fec_vc_assigned_number_vpls_id ANY]
x [-fec_vc_source_aii_type CHOICES as_ip number]
x [-fec_vc_source_aii_as_ip IPV4]
x [-fec_vc_source_aii_as_number ANY]
x [-fec_vc_target_aii_type CHOICES as_ip number]
x [-fec_vc_target_aii_as_ip IPV4]
x [-fec_vc_target_aii_as_number NUMERIC]
x [-fec_vc_include_tdm_payload ANY]
x [-fec_vc_tdm_data_size NUMERIC]
x [-fec_vc_include_tdm_bitrate ANY]
x [-fec_vc_tdm_bitrate ANY]
x [-fec_vc_include_rtp_header ANY]
x [-fec_vc_include_tdm_option ANY]
x [-fec_vc_timestamp_mode CHOICES absolute differential]
x [-fec_vc_payload_type ANY]
x [-fec_vc_frequency ANY]
x [-fec_vc_include_ssrc ANY]
x [-fec_vc_ssrc ANY]
x [-fec_vc_cas CHOICES e1_trunk
x CHOICES t1_esf_trunk
x CHOICES t1_sf_trunk]
x [-fec_vc_sp CHOICES hexval1
x CHOICES hexval2
x CHOICES hexval3
x CHOICES hexval4]
x [-fec_vc_enable_cccv_negotiation ANY]
x [-fec_vc_pw_ach_cc ANY]
x [-fec_vc_router_alert_cc ANY]
x [-fec_vc_lsp_ping_cv ANY]
x [-fec_vc_bfd_udp_cv ANY]
x [-fec_vc_bfd_pw_cv ANY]
x [-fec_active CHOICES 0 1]
x [-fec_name ALPHA]
x [-topology_config_active CHOICES 0 1]
x [-topology_router_active CHOICES 0 1]
x [-topology_router_label_value ANY]
x [-topology_router_id ANY]
[-grid_col RANGE 2-10000
DEFAULT 2]
[-grid_row RANGE 2-10000
DEFAULT 2]
x [-grid_include_emulated_device CHOICES 0 1]
x [-grid_link_multiplier NUMERIC]
x [-mesh_number_of_nodes NUMERIC]
x [-mesh_include_emulated_device CHOICES 0 1]
x [-mesh_link_multiplier NUMERIC]
x [-ring_number_of_nodes NUMERIC]
x [-ring_include_emulated_device CHOICES 0 1]
x [-ring_link_multiplier NUMERIC]
x [-hub_spoke_include_emulated_device CHOICES 0 1]
x [-hub_spoke_number_of_first_level NUMERIC]
x [-hub_spoke_number_of_second_level NUMERIC]
x [-hub_spoke_enable_level_2 CHOICES 0 1]
x [-hub_spoke_link_multiplier NUMERIC]
x [-tree_number_of_nodes NUMERIC]
x [-tree_include_emulated_device CHOICES 0 1]
x [-tree_use_tree_depth CHOICES 0 1]
x [-tree_depth NUMERIC]
x [-tree_max_children_per_node NUMERIC]
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ldp_route_config.py_part1
|
CHOICES satop_t3
CHOICES cesopsn_basic
CHOICES cesopsn_cas
CHOICES fr_dlci_rfc4619
DEFAULT eth_vlan]
n [-hop_count_tlv_enable ANY]
n [-hop_count_value ANY]
n [-label_msg_type ANY]
x [-label_value_start RANGE 0-1048575
x DEFAULT 16]
x [-label_value_start_step RANGE 0-1048575
x DEFAULT 1]
[-lsp_handle ANY]
n [-next_hop_peer_ip ANY]
[-num_lsps RANGE 1-34048
DEFAULT 1]
n [-num_routes ANY]
x [-packing_enable CHOICES 0 1
x DEFAULT 0]
x [-provisioning_model CHOICES bgp_auto_discovery
x CHOICES manual_configuration]
n [-stale_timer_enable ANY]
n [-stale_request_time ANY]
n [-no_write ANY]
x [-auto_peer_id CHOICES 0 1]
x [-fec_vc_pw_status_enable CHOICES 0 1]
x [-fec_vc_pw_status_code CHOICES clear_fault_code
x CHOICES pw_not_forwarding_code
x CHOICES ac_rx_fault_code
x CHOICES ac_tx_fault_code
x CHOICES pw_rx_fault_code
x CHOICES pw_tx_fault_code]
x [-fec_vc_pw_status_send_notification CHOICES 0 1]
x [-fec_vc_down_start NUMERIC]
x [-fec_vc_down_interval NUMERIC]
x [-fec_vc_up_interval NUMERIC]
x [-fec_vc_repeat_count NUMERIC]
x [-fec_vc_type_vpls_id CHOICES id_as_number id_ip_address]
x [-fec_vc_ip_address_vpls_id ANY]
x [-fec_vc_as_number_vpls_id ANY]
x [-fec_vc_assigned_number_vpls_id ANY]
x [-fec_vc_source_aii_type CHOICES as_ip number]
x [-fec_vc_source_aii_as_ip IPV4]
x [-fec_vc_source_aii_as_number ANY]
x [-fec_vc_target_aii_type CHOICES as_ip number]
x [-fec_vc_target_aii_as_ip IPV4]
x [-fec_vc_target_aii_as_number NUMERIC]
x [-fec_vc_include_tdm_payload ANY]
x [-fec_vc_tdm_data_size NUMERIC]
x [-fec_vc_include_tdm_bitrate ANY]
x [-fec_vc_tdm_bitrate ANY]
x [-fec_vc_include_rtp_header ANY]
x [-fec_vc_include_tdm_option ANY]
x [-fec_vc_timestamp_mode CHOICES absolute differential]
x [-fec_vc_payload_type ANY]
x [-fec_vc_frequency ANY]
x [-fec_vc_include_ssrc ANY]
x [-fec_vc_ssrc ANY]
x [-fec_vc_cas CHOICES e1_trunk
x CHOICES t1_esf_trunk
x CHOICES t1_sf_trunk]
x [-fec_vc_sp CHOICES hexval1
x CHOICES hexval2
x CHOICES hexval3
x CHOICES hexval4]
x [-fec_vc_enable_cccv_negotiation ANY]
x [-fec_vc_pw_ach_cc ANY]
x [-fec_vc_router_alert_cc ANY]
x [-fec_vc_lsp_ping_cv ANY]
x [-fec_vc_bfd_udp_cv ANY]
x [-fec_vc_bfd_pw_cv ANY]
x [-fec_active CHOICES 0 1]
x [-fec_name ALPHA]
x [-topology_config_active CHOICES 0 1]
x [-topology_router_active CHOICES 0 1]
x [-topology_router_label_value ANY]
x [-topology_router_id ANY]
[-grid_col RANGE 2-10000
DEFAULT 2]
[-grid_row RANGE 2-10000
DEFAULT 2]
x [-grid_include_emulated_device CHOICES 0 1]
x [-grid_link_multiplier NUMERIC]
x [-mesh_number_of_nodes NUMERIC]
x [-mesh_include_emulated_device CHOICES 0 1]
x [-mesh_link_multiplier NUMERIC]
x [-ring_number_of_nodes NUMERIC]
x [-ring_include_emulated_device CHOICES 0 1]
x [-ring_link_multiplier NUMERIC]
x [-hub_spoke_include_emulated_device CHOICES 0 1]
x [-hub_spoke_number_of_first_level NUMERIC]
x [-hub_spoke_number_of_second_level NUMERIC]
x [-hub_spoke_enable_level_2 CHOICES 0 1]
x [-hub_spoke_link_multiplier NUMERIC]
x [-tree_number_of_nodes NUMERIC]
x [-tree_include_emulated_device CHOICES 0 1]
x [-tree_use_tree_depth CHOICES 0 1]
x [-tree_depth NUMERIC]
x [-tree_max_children_per_node NUMERIC]
x [-tree_link_multiplier NUMERIC]
x [-custom_link_multiplier NUMERIC]
x [-custom_from_node_index NUMERIC]
x [-custom_to_node_index NUMERIC]
x [-fat_tree_include_emulated_device CHOICES 0 1]
x [-fat_tree_link_multiplier NUMERIC]
x [-fat_tree_level_count NUMERIC]
x [-fat_tree_node_count NUMERIC]
x [-linear_include_emulated_device CHOICES 0 1]
x [-linear_nodes NUMERIC]
x [-linear_link_multiplier NUMERIC]
x [-external_link_router_source NUMERIC]
x [-external_link_router_destination NUMERIC]
x [-external_link_network_group_handle ANY]
x [-connected_to_handle ANY]
n [-fec_host_step ANY]
n [-path_vector_tlv ANY]
n [-path_vector_tlv_lsr ANY]
x [-name ANY]
Arguments:
-mode
Mode that is being performed.All but create require the use of
the -handle option.Valid choices are:
create- Create a new LDP interface
modify- Modify an existing LDP interface
delete- Delete the given LDP interface
-handle
The LDP handle.
x -return_detailed_handles
x This argument determines if individual interface, session or router handles are returned by the current command.
x This applies only to the command on which it is specified.
x Setting this to 0 means that only NGPF-specific protocol stack handles will be returned. This will significantly
x decrease the size of command results and speed up script execution.
x The default is 0, meaning only protocol stack handles will be returned.
-egress_label_mode
This argument can be used to specify whether or not the same label
will be used for all the FECs in the FEC range. It has any meaning
only when the fec_type option is set to host_addr.
-fec_ip_prefix_start
The first network address in the range of advertising FECs, when
fec_type is ipv4_prefix.
x -fec_ip_prefix_step
x Provides step increment for fec_ip_prefix_start for adv Fec Range.
x -fec_ip_prefix_length
x The number of bits in the mask applied to the network address. The
x masked bits in the First Network address form the address prefix.
x Valid when fec_type is ipv4_prefix.
n -fec_host_addr
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_host_prefix_length
n This argument defined by Cisco is not supported for NGPF implementation.
-fec_type
Note: this option cannot be modified with modify mode.
Valid choices are:
ipv4_prefix - configure FECs to be advertised by the
simulated router
host_addr - configure FECs to be requested of upstream peers, to be
used in download on demand advertising mode.
vc - configure parameters for VC range associated with an LDP L2 VPN
interface.
x -network_topology_type
x The type of topology route to create.
x -fec_vc_atm_enable
x If checked, indicates that ATM Transparent Cell Transport mode is
x being used. Multiple ATM cells may be grouped into a single MPLS frame
x for transmission from one ATM port connected to another ATM port.
x Valid only when -mode is create/modify and -fec_vc_type is atm_cell or
x atm_vcc_1_1 or atm_vpc_1_1 or atm_vcc_n_1 or atm_vpc_n_1 and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_atm_max_cells
x The Maximum number of ATM Cells which may be concatenated and sent in
x a single MPLS frame. This parameter is part of the FEC element.
x Valid only when -mode is create/modify and -fec_vc_type is atm_cell or
x atm_vcc_1_1 or atm_vpc_1_1 or atm_vcc_n_1 or atm_vpc_n_1 and fec_type is vc.
x Valid only when using IxTclNetwork.
-fec_vc_cbit
If checked, sets the C-Bit (flag). It is the highest order bit in the
VC Type field. If the bit is set, it indicates the presence of a
control word on this VC.
Valid when fec_type is vc. This parameter is always 1, when fec_vc_type is cem, fr_dlci or fr_dlci_rfc4619.
n -fec_vc_ce_ip_addr
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ce_ip_addr_inner_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ce_ip_addr_outer_step
n This argument defined by Cisco is not supported for NGPF implementation.
x -fec_vc_cem_option
x The value of the CEM option.
x Valid only when -mode is create/modify and -fec_vc_type is cem and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_cem_option_enable
x If checked, indicates that the CEM option is present.
x Valid only when -mode is create or modify and -fec_vc_type is cem and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_cem_payload
x The length of the CEM payload (in bytes).
x Valid only when -mode is create or modify and -fec_vc_type is cem and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_cem_payload_enable
x If checked, indicates that there is a CEM payload.
x Valid only when -mode is create or modify and -fec_vc_type is cem and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_count
x This option can be used to set the number of pseudowires to be
x configured on each LDP VC range.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ldp_route_config.py_part2
|
x [-tree_link_multiplier NUMERIC]
x [-custom_link_multiplier NUMERIC]
x [-custom_from_node_index NUMERIC]
x [-custom_to_node_index NUMERIC]
x [-fat_tree_include_emulated_device CHOICES 0 1]
x [-fat_tree_link_multiplier NUMERIC]
x [-fat_tree_level_count NUMERIC]
x [-fat_tree_node_count NUMERIC]
x [-linear_include_emulated_device CHOICES 0 1]
x [-linear_nodes NUMERIC]
x [-linear_link_multiplier NUMERIC]
x [-external_link_router_source NUMERIC]
x [-external_link_router_destination NUMERIC]
x [-external_link_network_group_handle ANY]
x [-connected_to_handle ANY]
n [-fec_host_step ANY]
n [-path_vector_tlv ANY]
n [-path_vector_tlv_lsr ANY]
x [-name ANY]
Arguments:
-mode
Mode that is being performed.All but create require the use of
the -handle option.Valid choices are:
create- Create a new LDP interface
modify- Modify an existing LDP interface
delete- Delete the given LDP interface
-handle
The LDP handle.
x -return_detailed_handles
x This argument determines if individual interface, session or router handles are returned by the current command.
x This applies only to the command on which it is specified.
x Setting this to 0 means that only NGPF-specific protocol stack handles will be returned. This will significantly
x decrease the size of command results and speed up script execution.
x The default is 0, meaning only protocol stack handles will be returned.
-egress_label_mode
This argument can be used to specify whether or not the same label
will be used for all the FECs in the FEC range. It has any meaning
only when the fec_type option is set to host_addr.
-fec_ip_prefix_start
The first network address in the range of advertising FECs, when
fec_type is ipv4_prefix.
x -fec_ip_prefix_step
x Provides step increment for fec_ip_prefix_start for adv Fec Range.
x -fec_ip_prefix_length
x The number of bits in the mask applied to the network address. The
x masked bits in the First Network address form the address prefix.
x Valid when fec_type is ipv4_prefix.
n -fec_host_addr
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_host_prefix_length
n This argument defined by Cisco is not supported for NGPF implementation.
-fec_type
Note: this option cannot be modified with modify mode.
Valid choices are:
ipv4_prefix - configure FECs to be advertised by the
simulated router
host_addr - configure FECs to be requested of upstream peers, to be
used in download on demand advertising mode.
vc - configure parameters for VC range associated with an LDP L2 VPN
interface.
x -network_topology_type
x The type of topology route to create.
x -fec_vc_atm_enable
x If checked, indicates that ATM Transparent Cell Transport mode is
x being used. Multiple ATM cells may be grouped into a single MPLS frame
x for transmission from one ATM port connected to another ATM port.
x Valid only when -mode is create/modify and -fec_vc_type is atm_cell or
x atm_vcc_1_1 or atm_vpc_1_1 or atm_vcc_n_1 or atm_vpc_n_1 and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_atm_max_cells
x The Maximum number of ATM Cells which may be concatenated and sent in
x a single MPLS frame. This parameter is part of the FEC element.
x Valid only when -mode is create/modify and -fec_vc_type is atm_cell or
x atm_vcc_1_1 or atm_vpc_1_1 or atm_vcc_n_1 or atm_vpc_n_1 and fec_type is vc.
x Valid only when using IxTclNetwork.
-fec_vc_cbit
If checked, sets the C-Bit (flag). It is the highest order bit in the
VC Type field. If the bit is set, it indicates the presence of a
control word on this VC.
Valid when fec_type is vc. This parameter is always 1, when fec_vc_type is cem, fr_dlci or fr_dlci_rfc4619.
n -fec_vc_ce_ip_addr
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ce_ip_addr_inner_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ce_ip_addr_outer_step
n This argument defined by Cisco is not supported for NGPF implementation.
x -fec_vc_cem_option
x The value of the CEM option.
x Valid only when -mode is create/modify and -fec_vc_type is cem and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_cem_option_enable
x If checked, indicates that the CEM option is present.
x Valid only when -mode is create or modify and -fec_vc_type is cem and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_cem_payload
x The length of the CEM payload (in bytes).
x Valid only when -mode is create or modify and -fec_vc_type is cem and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_cem_payload_enable
x If checked, indicates that there is a CEM payload.
x Valid only when -mode is create or modify and -fec_vc_type is cem and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_count
x This option can be used to set the number of pseudowires to be
x configured on each LDP VC range.
x Valid only when using IxTclNetwork API and fec_type is vc.
x -fec_vc_fec_type
x Configure the FEC type Valid only when using IxTclNetwork API and fec_type is vc.
x Valid choices are:
x generalized_id_fec_vpls- Generalized Id FEC 0x81 VPLS
x pw_id_fec- PW Id FEC 0x80
-fec_vc_group_id
A user-defined 32-bit value used to identify a group of VCs.
Valid when fec_type is vc.
n -fec_vc_group_count
n This argument defined by Cisco is not supported for NGPF implementation.
-fec_vc_id_start
The 32-bit VC connection identifier. Used with the VC type to identify
a specific VC.
Valid when fec_type is vc.
-fec_vc_id_step
The increment step to be added to the VCID to create the next VCID in
a group of VCIDs.
Valid when fec_type is vc.
n -fec_vc_id_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_intf_mtu_enable
n This argument defined by Cisco is not supported for NGPF implementation.
-fec_vc_intf_mtu
(in octets) The 2-octet value for the maximum Transmission Unit (MTU).
Valid when fec_type is vc.
-fec_vc_intf_desc
An optional user-defined Interface Description. It may be used with
ALL VC types. Valid length is 0 to 80 octets.
Valid when fec_type is vc.
x -fec_vc_intf_desc_enable
x Enable or Disable "Description Enabled".
x -fec_vc_name
x Name of the LDP L2VPN element.
x -fec_vc_active
x Activates the FEC VC/LSP items.
n -fec_vc_ip_range_addr_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ip_range_addr_start
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ip_range_addr_inner_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ip_range_addr_outer_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ip_range_enable
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ip_range_prefix_len
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_label_mode
n This argument defined by Cisco is not supported for NGPF implementation.
x -fec_vc_label_value_start
x The first label in the range of labels.
x Valid when fec_type is vc.
x -fec_vc_label_value_step
x The incrementing step for the fec_vc_label_value_start.
x Valid when fec_type is vc and fec_vc_count is greater than 1.
x Valid only when using IxTclNetwork.
x -fec_vc_mac_range_count
x If fec_vc_mac_range_vlan_enable is 1, this it the number of MAC
x address/VLAN combinations that will be created. If
x fec_vc_mac_range_vlan_enable is 0, this is the number of MAC addresses
x that will be created.
x Valid only when -mode is create or modify and -fec_vc_type is eth or
x eth_vlan and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_mac_range_enable
x If checked, the MAC range corresponding to the layer2 VC range
x will be enabled.
x Valid only when -mode is create or modify and -fec_vc_type is eth or
x eth_vlan and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_mac_range_first_vlan_id
x The VLAN ID for the first VLAN in the MAC/VLAN range.
x Valid only when -mode is create or modify and -fec_vc_type is eth or
x eth_vlan and fec_type is vc.
x Valid only when using IxTclNetwork.
n -fec_vc_mac_range_repeat_mac
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_mac_range_same_vlan
n This argument defined by Cisco is not supported for NGPF implementation.
x -fec_vc_mac_range_start
x The first MAC address in the MAC range.
x Valid only when -mode is create or modify and -fec_vc_type is eth or
x eth_vlan and fec_type is vc.
x Valid only when using IxTclNetwork.
n -fec_vc_mac_range_vlan_enable
n This argument defined by Cisco is not supported for NGPF implementation.
x -fec_vc_peer_address
x The 32-bit IP address of the LDP Peer.
x Valid only when -mode is create or modify and fec_type is vc.
-fec_vc_type
The 15-bit VC Type used in the VC FEC element. It depends on the Layer
2 protocol used on the interface. Valid when fec_type is vc.
Valid choices are:
atm_aal5_vcc - ATM AAL5 VCC transport (VC Type 0x0002)
atm_cell - ATM Transparent cell transport (VC Type 0x0003)
atm_vcc_1_1 - ATM VCC cell transport (VC Type 0x0009)
atm_vcc_n_1 - ATM VCC cell transport (VC Type 0x0009)
atm_vpc_1_1 - ATM VPC cell transport (VC Type 0x000A)
atm_vpc_n_1 - ATM VPC cell transport (VC Type 0x000A)
cem - Circuit Emulation Service over MPLS (CEM), for encapsulation of TDM signal (VC Type 0x8008)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ldp_route_config.py_part3
|
x configured on each LDP VC range.
x Valid only when using IxTclNetwork API and fec_type is vc.
x -fec_vc_fec_type
x Configure the FEC type Valid only when using IxTclNetwork API and fec_type is vc.
x Valid choices are:
x generalized_id_fec_vpls- Generalized Id FEC 0x81 VPLS
x pw_id_fec- PW Id FEC 0x80
-fec_vc_group_id
A user-defined 32-bit value used to identify a group of VCs.
Valid when fec_type is vc.
n -fec_vc_group_count
n This argument defined by Cisco is not supported for NGPF implementation.
-fec_vc_id_start
The 32-bit VC connection identifier. Used with the VC type to identify
a specific VC.
Valid when fec_type is vc.
-fec_vc_id_step
The increment step to be added to the VCID to create the next VCID in
a group of VCIDs.
Valid when fec_type is vc.
n -fec_vc_id_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_intf_mtu_enable
n This argument defined by Cisco is not supported for NGPF implementation.
-fec_vc_intf_mtu
(in octets) The 2-octet value for the maximum Transmission Unit (MTU).
Valid when fec_type is vc.
-fec_vc_intf_desc
An optional user-defined Interface Description. It may be used with
ALL VC types. Valid length is 0 to 80 octets.
Valid when fec_type is vc.
x -fec_vc_intf_desc_enable
x Enable or Disable "Description Enabled".
x -fec_vc_name
x Name of the LDP L2VPN element.
x -fec_vc_active
x Activates the FEC VC/LSP items.
n -fec_vc_ip_range_addr_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ip_range_addr_start
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ip_range_addr_inner_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ip_range_addr_outer_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ip_range_enable
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_ip_range_prefix_len
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_label_mode
n This argument defined by Cisco is not supported for NGPF implementation.
x -fec_vc_label_value_start
x The first label in the range of labels.
x Valid when fec_type is vc.
x -fec_vc_label_value_step
x The incrementing step for the fec_vc_label_value_start.
x Valid when fec_type is vc and fec_vc_count is greater than 1.
x Valid only when using IxTclNetwork.
x -fec_vc_mac_range_count
x If fec_vc_mac_range_vlan_enable is 1, this it the number of MAC
x address/VLAN combinations that will be created. If
x fec_vc_mac_range_vlan_enable is 0, this is the number of MAC addresses
x that will be created.
x Valid only when -mode is create or modify and -fec_vc_type is eth or
x eth_vlan and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_mac_range_enable
x If checked, the MAC range corresponding to the layer2 VC range
x will be enabled.
x Valid only when -mode is create or modify and -fec_vc_type is eth or
x eth_vlan and fec_type is vc.
x Valid only when using IxTclNetwork.
x -fec_vc_mac_range_first_vlan_id
x The VLAN ID for the first VLAN in the MAC/VLAN range.
x Valid only when -mode is create or modify and -fec_vc_type is eth or
x eth_vlan and fec_type is vc.
x Valid only when using IxTclNetwork.
n -fec_vc_mac_range_repeat_mac
n This argument defined by Cisco is not supported for NGPF implementation.
n -fec_vc_mac_range_same_vlan
n This argument defined by Cisco is not supported for NGPF implementation.
x -fec_vc_mac_range_start
x The first MAC address in the MAC range.
x Valid only when -mode is create or modify and -fec_vc_type is eth or
x eth_vlan and fec_type is vc.
x Valid only when using IxTclNetwork.
n -fec_vc_mac_range_vlan_enable
n This argument defined by Cisco is not supported for NGPF implementation.
x -fec_vc_peer_address
x The 32-bit IP address of the LDP Peer.
x Valid only when -mode is create or modify and fec_type is vc.
-fec_vc_type
The 15-bit VC Type used in the VC FEC element. It depends on the Layer
2 protocol used on the interface. Valid when fec_type is vc.
Valid choices are:
atm_aal5_vcc - ATM AAL5 VCC transport (VC Type 0x0002)
atm_cell - ATM Transparent cell transport (VC Type 0x0003)
atm_vcc_1_1 - ATM VCC cell transport (VC Type 0x0009)
atm_vcc_n_1 - ATM VCC cell transport (VC Type 0x0009)
atm_vpc_1_1 - ATM VPC cell transport (VC Type 0x000A)
atm_vpc_n_1 - ATM VPC cell transport (VC Type 0x000A)
cem - Circuit Emulation Service over MPLS (CEM), for encapsulation of TDM signal (VC Type 0x8008)
eth - untagged Ethernet frames (VC Type 0x0005)
eth_vlan - VLAN-tagged Ethernet frames (VC Type 0x0004)
eth_vpls - Internet Protocol packets (VC Type 0x000B)
fr_dlci - Frame Relay DLCI (VC Type 0x0001)
hdlc - HDLC frames (VC Type 0x0006)
ppp - Point-to-Point Protocol frames (VC Type 0x0007)
satop_e1 - Satop-E1
satop_e3 - Satop-E3
satop_t1 - Satop-T1
satop_t3 - Satop-T3
cesopsn_basic - CESoPSN-Basic
cesopsn_cas - CESoPSN-CAS
fr_dlci_rfc4619 - RFC 4619 Frame Relay DLCI (VC Type 0x0019)
n -hop_count_tlv_enable
n This argument defined by Cisco is not supported for NGPF implementation.
n -hop_count_value
n This argument defined by Cisco is not supported for NGPF implementation.
n -label_msg_type
n This argument defined by Cisco is not supported for NGPF implementation.
x -label_value_start
x The first label in the range of labels.
x Valid when fec_type is ipv4_prefix.
x -label_value_start_step
x Specifies the step increment for Label Value start.
-lsp_handle
This option specifies on which lsp element to configure the
lsp pools/fec range options. The user must pass in this option
if the "type" is modify or delete.lsp_handle is returned by
this procedure when "type" is create.
n -next_hop_peer_ip
n This argument defined by Cisco is not supported for NGPF implementation.
-num_lsps
The number of network addresses to be included in the range. The
maximum number of valid possible addresses depends on the values for
the first network and the network mask.
Valid for fec_type ipv4_prefix.
n -num_routes
n This argument defined by Cisco is not supported for NGPF implementation.
x -packing_enable
x For L2 VC FEC ranges and in Unsolicited Label Distribution Mode ONLY.
x If checked, L2 VC FEC ranges will be aggregated within a single LDP
x PDU to conserve bandwidth and processing.
x -provisioning_model
x This option denotes the Provisioning Model.
x Valid choices are:
x bgp_auto_discovery - bgp Auto Discovery
x manual_configuration - manual configuration
x (DEFAULT=bgp_auto_discovery)
n -stale_timer_enable
n This argument defined by Cisco is not supported for NGPF implementation.
n -stale_request_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -no_write
n This argument defined by Cisco is not supported for NGPF implementation.
x -auto_peer_id
x Enable PW Status
x -fec_vc_pw_status_enable
x Enable or Disable PW Status
x -fec_vc_pw_status_code
x PW Status Code to be sent when to transition to down state if PW Status Send Notification is enabled
x -fec_vc_pw_status_send_notification
x Enable or Disable "PW Status Send Notification". If selected, this enables the use of PW Status TLV in notification messages to notify the PW status
x -fec_vc_down_start
x The duration in time after session becomes up and a notification message being sent to make the session down
x -fec_vc_down_interval
x Time interval for which the PW status will remain down
x -fec_vc_up_interval
x Time Interval for which the PW status will remain in Up state before transitioning again to Down state.
x -fec_vc_repeat_count
x The number of times to repeat the Up/Down status of the PW. '0' means keep toggling the Up/Down state indefinitely.
x -fec_vc_type_vpls_id
x The VPLS Id format
x -fec_vc_ip_address_vpls_id
x VPLS ID IP Address
x -fec_vc_as_number_vpls_id
x VPLS ID AS Number
x -fec_vc_assigned_number_vpls_id
x VPLS ID Assigned Number
x -fec_vc_source_aii_type
x Source AII Type
x -fec_vc_source_aii_as_ip
x Source AII as IP
x -fec_vc_source_aii_as_number
x Source AII as Number
x -fec_vc_target_aii_type
x Target AII Type
x -fec_vc_target_aii_as_ip
x Target AII as IP
x -fec_vc_target_aii_as_number
x Target AII as Number
x -fec_vc_include_tdm_payload
x If selected, indicates that TDM Payload is present
x -fec_vc_tdm_data_size
x The total size of the TDM data
x -fec_vc_include_tdm_bitrate
x If selected, indicates that TDM Bitrate is present
x -fec_vc_tdm_bitrate
x The value of the TDM Bitrate
x -fec_vc_include_rtp_header
x If selected, indicates that RTP Header is present
x -fec_vc_include_tdm_option
x Include TDM Option
x -fec_vc_timestamp_mode
x Timestamp Mode
x -fec_vc_payload_type
x Configures the Pay Load Type
x -fec_vc_frequency
x Configures the frequency of the payload type
x -fec_vc_include_ssrc
x Enable or Disable "Include SSRC"
x -fec_vc_ssrc
x SSRC
x -fec_vc_cas
x TDS Timestamp Mode
x -fec_vc_sp
x SP
x -fec_vc_enable_cccv_negotiation
x Enable or Disable CCCV Negotiation
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ldp_route_config.py_part4
|
cem - Circuit Emulation Service over MPLS (CEM), for encapsulation of TDM signal (VC Type 0x8008)
eth - untagged Ethernet frames (VC Type 0x0005)
eth_vlan - VLAN-tagged Ethernet frames (VC Type 0x0004)
eth_vpls - Internet Protocol packets (VC Type 0x000B)
fr_dlci - Frame Relay DLCI (VC Type 0x0001)
hdlc - HDLC frames (VC Type 0x0006)
ppp - Point-to-Point Protocol frames (VC Type 0x0007)
satop_e1 - Satop-E1
satop_e3 - Satop-E3
satop_t1 - Satop-T1
satop_t3 - Satop-T3
cesopsn_basic - CESoPSN-Basic
cesopsn_cas - CESoPSN-CAS
fr_dlci_rfc4619 - RFC 4619 Frame Relay DLCI (VC Type 0x0019)
n -hop_count_tlv_enable
n This argument defined by Cisco is not supported for NGPF implementation.
n -hop_count_value
n This argument defined by Cisco is not supported for NGPF implementation.
n -label_msg_type
n This argument defined by Cisco is not supported for NGPF implementation.
x -label_value_start
x The first label in the range of labels.
x Valid when fec_type is ipv4_prefix.
x -label_value_start_step
x Specifies the step increment for Label Value start.
-lsp_handle
This option specifies on which lsp element to configure the
lsp pools/fec range options. The user must pass in this option
if the "type" is modify or delete.lsp_handle is returned by
this procedure when "type" is create.
n -next_hop_peer_ip
n This argument defined by Cisco is not supported for NGPF implementation.
-num_lsps
The number of network addresses to be included in the range. The
maximum number of valid possible addresses depends on the values for
the first network and the network mask.
Valid for fec_type ipv4_prefix.
n -num_routes
n This argument defined by Cisco is not supported for NGPF implementation.
x -packing_enable
x For L2 VC FEC ranges and in Unsolicited Label Distribution Mode ONLY.
x If checked, L2 VC FEC ranges will be aggregated within a single LDP
x PDU to conserve bandwidth and processing.
x -provisioning_model
x This option denotes the Provisioning Model.
x Valid choices are:
x bgp_auto_discovery - bgp Auto Discovery
x manual_configuration - manual configuration
x (DEFAULT=bgp_auto_discovery)
n -stale_timer_enable
n This argument defined by Cisco is not supported for NGPF implementation.
n -stale_request_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -no_write
n This argument defined by Cisco is not supported for NGPF implementation.
x -auto_peer_id
x Enable PW Status
x -fec_vc_pw_status_enable
x Enable or Disable PW Status
x -fec_vc_pw_status_code
x PW Status Code to be sent when to transition to down state if PW Status Send Notification is enabled
x -fec_vc_pw_status_send_notification
x Enable or Disable "PW Status Send Notification". If selected, this enables the use of PW Status TLV in notification messages to notify the PW status
x -fec_vc_down_start
x The duration in time after session becomes up and a notification message being sent to make the session down
x -fec_vc_down_interval
x Time interval for which the PW status will remain down
x -fec_vc_up_interval
x Time Interval for which the PW status will remain in Up state before transitioning again to Down state.
x -fec_vc_repeat_count
x The number of times to repeat the Up/Down status of the PW. '0' means keep toggling the Up/Down state indefinitely.
x -fec_vc_type_vpls_id
x The VPLS Id format
x -fec_vc_ip_address_vpls_id
x VPLS ID IP Address
x -fec_vc_as_number_vpls_id
x VPLS ID AS Number
x -fec_vc_assigned_number_vpls_id
x VPLS ID Assigned Number
x -fec_vc_source_aii_type
x Source AII Type
x -fec_vc_source_aii_as_ip
x Source AII as IP
x -fec_vc_source_aii_as_number
x Source AII as Number
x -fec_vc_target_aii_type
x Target AII Type
x -fec_vc_target_aii_as_ip
x Target AII as IP
x -fec_vc_target_aii_as_number
x Target AII as Number
x -fec_vc_include_tdm_payload
x If selected, indicates that TDM Payload is present
x -fec_vc_tdm_data_size
x The total size of the TDM data
x -fec_vc_include_tdm_bitrate
x If selected, indicates that TDM Bitrate is present
x -fec_vc_tdm_bitrate
x The value of the TDM Bitrate
x -fec_vc_include_rtp_header
x If selected, indicates that RTP Header is present
x -fec_vc_include_tdm_option
x Include TDM Option
x -fec_vc_timestamp_mode
x Timestamp Mode
x -fec_vc_payload_type
x Configures the Pay Load Type
x -fec_vc_frequency
x Configures the frequency of the payload type
x -fec_vc_include_ssrc
x Enable or Disable "Include SSRC"
x -fec_vc_ssrc
x SSRC
x -fec_vc_cas
x TDS Timestamp Mode
x -fec_vc_sp
x SP
x -fec_vc_enable_cccv_negotiation
x Enable or Disable CCCV Negotiation
x -fec_vc_pw_ach_cc
x PW-ACH CC
x -fec_vc_router_alert_cc
x Router Alert CC
x -fec_vc_lsp_ping_cv
x LSP Ping CV
x -fec_vc_bfd_udp_cv
x BFD IP/UDP CV
x -fec_vc_bfd_pw_cv
x BFD PW-ACH CV
x -fec_active
x Enable/Activate the FEC Property Range.
x -fec_name
x Valid Name for the FEC Property Range.
x -topology_config_active
x This is to activate the ldp Simulated Topology Config object of the NetworkTopology in Network Group.
x -topology_router_active
x This attribute activates the pseudo Ldp router of network Topology.
x -topology_router_label_value
x This attribute set the Label Value of the LDP Topology Router of Network Toplogy
x -topology_router_id
x The router id of the LDP Topology router of Network topology.4 Byte Router Id in dotted decimal format.
-grid_col
Defines number of columns in a grid.
This option is valid only when -type is grid, otherwise it
is ignored. This option is available with IxTclNetwork and IxTclProtocol API.
(DEFAULT = 2)
-grid_row
Defines number of rows in a grid.
This option is valid only when -type is grid, otherwise it
is ignored.
This option is available with IxTclNetwork and IxTclProtocol API.
(DEFAULT = 2)
x -grid_include_emulated_device
x -grid_link_multiplier
x -mesh_number_of_nodes
x -mesh_include_emulated_device
x -mesh_link_multiplier
x -ring_number_of_nodes
x -ring_include_emulated_device
x -ring_link_multiplier
x -hub_spoke_include_emulated_device
x -hub_spoke_number_of_first_level
x -hub_spoke_number_of_second_level
x -hub_spoke_enable_level_2
x -hub_spoke_link_multiplier
x -tree_number_of_nodes
x -tree_include_emulated_device
x -tree_use_tree_depth
x -tree_depth
x -tree_max_children_per_node
x -tree_link_multiplier
x -custom_link_multiplier
x number of links between two nodes
x -custom_from_node_index
x -custom_to_node_index
x -fat_tree_include_emulated_device
x -fat_tree_link_multiplier
x number of links between two nodes
x -fat_tree_level_count
x Number of Levels
x -fat_tree_node_count
x Number of Nodes Per Level
x -linear_include_emulated_device
x -linear_nodes
x number of nodes
x -linear_link_multiplier
x number of links between two nodes
x -external_link_router_source
x Index of the originating node as defined in fromNetworkTopology
x -external_link_router_destination
x Index of the target node as defined in toNetworkTopology
x -external_link_network_group_handle
x Network Topology this link is pointing to
x -connected_to_handle
x Scenario element this connector is connecting to
n -fec_host_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -path_vector_tlv
n This argument defined by Cisco is not supported for NGPF implementation.
n -path_vector_tlv_lsr
n This argument defined by Cisco is not supported for NGPF implementation.
x -name
x Name of NGPF element, guaranteed to be unique in Scenario
Return Values:
A list containing the network group protocol stack handles that were added by the command (if any).
x key:network_group_handle value:A list containing the network group protocol stack handles that were added by the command (if any).
A list containing the fecproperty protocol stack handles that were added by the command (if any).
x key:fecproperty_handle value:A list containing the fecproperty protocol stack handles that were added by the command (if any).
A list containing the ipv6 fecproperty protocol stack handles that were added by the command (if any).
x key:ipv6_fecproperty_handle value:A list containing the ipv6 fecproperty protocol stack handles that were added by the command (if any).
A list containing the ldppwvpls protocol stack handles that were added by the command (if any).
x key:ldppwvpls_handle value:A list containing the ldppwvpls protocol stack handles that were added by the command (if any).
A list containing the ldpotherpws protocol stack handles that were added by the command (if any).
x key:ldpotherpws_handle value:A list containing the ldpotherpws protocol stack handles that were added by the command (if any).
A list containing the ldpvplsbgpad protocol stack handles that were added by the command (if any).
x key:ldpvplsbgpad_handle value:A list containing the ldpvplsbgpad protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:fecproperty_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:ipv6_fecproperty_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ldp_route_config.py_part5
|
x -fec_vc_enable_cccv_negotiation
x Enable or Disable CCCV Negotiation
x -fec_vc_pw_ach_cc
x PW-ACH CC
x -fec_vc_router_alert_cc
x Router Alert CC
x -fec_vc_lsp_ping_cv
x LSP Ping CV
x -fec_vc_bfd_udp_cv
x BFD IP/UDP CV
x -fec_vc_bfd_pw_cv
x BFD PW-ACH CV
x -fec_active
x Enable/Activate the FEC Property Range.
x -fec_name
x Valid Name for the FEC Property Range.
x -topology_config_active
x This is to activate the ldp Simulated Topology Config object of the NetworkTopology in Network Group.
x -topology_router_active
x This attribute activates the pseudo Ldp router of network Topology.
x -topology_router_label_value
x This attribute set the Label Value of the LDP Topology Router of Network Toplogy
x -topology_router_id
x The router id of the LDP Topology router of Network topology.4 Byte Router Id in dotted decimal format.
-grid_col
Defines number of columns in a grid.
This option is valid only when -type is grid, otherwise it
is ignored. This option is available with IxTclNetwork and IxTclProtocol API.
(DEFAULT = 2)
-grid_row
Defines number of rows in a grid.
This option is valid only when -type is grid, otherwise it
is ignored.
This option is available with IxTclNetwork and IxTclProtocol API.
(DEFAULT = 2)
x -grid_include_emulated_device
x -grid_link_multiplier
x -mesh_number_of_nodes
x -mesh_include_emulated_device
x -mesh_link_multiplier
x -ring_number_of_nodes
x -ring_include_emulated_device
x -ring_link_multiplier
x -hub_spoke_include_emulated_device
x -hub_spoke_number_of_first_level
x -hub_spoke_number_of_second_level
x -hub_spoke_enable_level_2
x -hub_spoke_link_multiplier
x -tree_number_of_nodes
x -tree_include_emulated_device
x -tree_use_tree_depth
x -tree_depth
x -tree_max_children_per_node
x -tree_link_multiplier
x -custom_link_multiplier
x number of links between two nodes
x -custom_from_node_index
x -custom_to_node_index
x -fat_tree_include_emulated_device
x -fat_tree_link_multiplier
x number of links between two nodes
x -fat_tree_level_count
x Number of Levels
x -fat_tree_node_count
x Number of Nodes Per Level
x -linear_include_emulated_device
x -linear_nodes
x number of nodes
x -linear_link_multiplier
x number of links between two nodes
x -external_link_router_source
x Index of the originating node as defined in fromNetworkTopology
x -external_link_router_destination
x Index of the target node as defined in toNetworkTopology
x -external_link_network_group_handle
x Network Topology this link is pointing to
x -connected_to_handle
x Scenario element this connector is connecting to
n -fec_host_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -path_vector_tlv
n This argument defined by Cisco is not supported for NGPF implementation.
n -path_vector_tlv_lsr
n This argument defined by Cisco is not supported for NGPF implementation.
x -name
x Name of NGPF element, guaranteed to be unique in Scenario
Return Values:
A list containing the network group protocol stack handles that were added by the command (if any).
x key:network_group_handle value:A list containing the network group protocol stack handles that were added by the command (if any).
A list containing the fecproperty protocol stack handles that were added by the command (if any).
x key:fecproperty_handle value:A list containing the fecproperty protocol stack handles that were added by the command (if any).
A list containing the ipv6 fecproperty protocol stack handles that were added by the command (if any).
x key:ipv6_fecproperty_handle value:A list containing the ipv6 fecproperty protocol stack handles that were added by the command (if any).
A list containing the ldppwvpls protocol stack handles that were added by the command (if any).
x key:ldppwvpls_handle value:A list containing the ldppwvpls protocol stack handles that were added by the command (if any).
A list containing the ldpotherpws protocol stack handles that were added by the command (if any).
x key:ldpotherpws_handle value:A list containing the ldpotherpws protocol stack handles that were added by the command (if any).
A list containing the ldpvplsbgpad protocol stack handles that were added by the command (if any).
x key:ldpvplsbgpad_handle value:A list containing the ldpvplsbgpad protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:fecproperty_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:ipv6_fecproperty_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:ldppwvpls_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:ldpotherpws_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:ldpvplsbgpad_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Examples:
See files starting with LDP_ in the Samples subdirectory. Also see some of the L2VPN, L3VPN, MPLS, and MVPN sample files for further examples of the LDP usage.
See the LDP example in Appendix A, "Example APIs," for one specific example usage.
Sample Input:
Sample Output:
Notes:
Coded versus functional specification.
If fec_type option is ipv4_prefix, the label_msg_type option must be
mapping; if fec_type option is host_addr, the the label_msg_type option
must be request.
For "modify" mode, the fec_type option and label_msg_type option will not
be updated for the lsp.
When using the new IxTclNetwork API 5.30, the label_msg_type option
is silently ignored. Only the fec_type option is used. If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: fecproperty_handles, ipv6_fecproperty_handles, ldppwvpls_handles, ldpotherpws_handles, ldpvplsbgpad_handles
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_ldp_route_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ldp_route_config.py_part6
|
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:ldppwvpls_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:ldpotherpws_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:ldpvplsbgpad_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Examples:
See files starting with LDP_ in the Samples subdirectory. Also see some of the L2VPN, L3VPN, MPLS, and MVPN sample files for further examples of the LDP usage.
See the LDP example in Appendix A, "Example APIs," for one specific example usage.
Sample Input:
Sample Output:
Notes:
Coded versus functional specification.
If fec_type option is ipv4_prefix, the label_msg_type option must be
mapping; if fec_type option is host_addr, the the label_msg_type option
must be request.
For "modify" mode, the fec_type option and label_msg_type option will not
be updated for the lsp.
When using the new IxTclNetwork API 5.30, the label_msg_type option
is silently ignored. Only the fec_type option is used. If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: fecproperty_handles, ipv6_fecproperty_handles, ldppwvpls_handles, ldpotherpws_handles, ldpvplsbgpad_handles
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_ldp_route_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ldp_route_config.py_part7
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def internal_compress_overlays(self, **kwargs):
r'''
#Procedure Header
Name:
internal_compress_overlays
Description:
Method used to compress the overlays in the config.
Synopsis:
internal_compress_overlays
Arguments:
Return Values:
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'internal_compress_overlays',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/internal_compress_overlays.py_part1
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_evpn_vxlan_wizard(self, **kwargs):
r'''
#Procedure Header
Name:
emulation_evpn_vxlan_wizard
Description:
This procedure configures a Evpn scenario in Ixnetwork.
Synopsis:
emulation_evpn_vxlan_wizard
x [-vtep_side_port RANGE 1-100
x DEFAULT 1]
x [-host_side_port RANGE 0-100
x DEFAULT 1]
x [-enable_spine CHOICES 0 1
x DEFAULT 1]
x [-number_of_spines_per_port RANGE 1-100000
x DEFAULT 1]
x [-spine_interface_address ALPHA]
x [-spine_interface_address_prefix RANGE 8-31
x DEFAULT 24]
x [-vtep_address ALPHA]
x [-vtep_prefix_length RANGE 8-31
x DEFAULT 24]
x [-gateway_address ALPHA]
x [-spine_vlan_enabled CHOICES 0 1
x DEFAULT 0]
x [-spine_vlan_id ALPHA]
x [-spine_underlaying_protocol CHOICES ebgp ibgp ospf isis
x DEFAULT ebgp]
x [-spine_remote_bgp ALPHA]
x [-spine_local_as ALPHA]
x [-ospf_area_id NUMERIC
x DEFAULT 0]
x [-ospf_network_type CHOICES broadcast pointtopoint
x DEFAULT broadcast]
x [-isis_network_type CHOICES broadcast pointpoint
x DEFAULT broadcast]
x [-isis_area_id ALPHA]
x [-isis_level CHOICES level1 level2 l1l2
x DEFAULT level1]
x [-vtep_number_per_spine RANGE 1-100000
x DEFAULT 10]
x [-vtep_number_per_port RANGE 1-100000
x DEFAULT 10]
x [-configure_loopback_ip CHOICES 0 1
x DEFAULT 1]
x [-vtep_loopback_address ALPHA]
x [-vtep_loopback_prefix_length RANGE 8-32
x DEFAULT 32]
x [-vtep_dut_loopback_address ALPHA]
x [-vtep_bgp_peering_type CHOICES ebgp ibgp
x DEFAULT ibgp]
x [-vtep_local_as ALPHA]
x [-vtep_multi_homing CHOICES 0 1
x DEFAULT 0]
x [-ethernet_segment_type CHOICES type0
x CHOICES type1
x CHOICES type2
x CHOICES type3
x CHOICES type4
x CHOICES type5
x CHOICES type6
x DEFAULT type0]
x [-ethernet_segement_id ALPHA]
x [-multi_homing_type CHOICES singleActive allActive
x DEFAULT allActive]
x [-enable_irb CHOICES 0 1
x DEFAULT 0]
x [-irb_model CHOICES symmetric asymmetric
x DEFAULT symmetric]
x [-l3vni_per_vtep RANGE 1-65535
x DEFAULT 1]
x [-service_interface_type CHOICES vlanBasedService
x CHOICES vlanBundleService
x CHOICES vlanAwareBundle
x DEFAULT vlanBasedService]
x [-mac_vrf_per_vtep NUMERIC
x DEFAULT 1]
x [-mac_vrfper_ip_vrf RANGE 1-65535
x DEFAULT 1]
x [-bd_per_mac_vrf RANGE 1-10000
x DEFAULT 1]
x [-ethernet_tag_id_start RANGE 0-4294967295
x DEFAULT 1]
x [-ethernet_tag_id_step RANGE 0-4294967295
x DEFAULT 1]
x [-l2_per_l3vni RANGE 1-65535
x DEFAULT 1]
x [-l2vni_per_vtep RANGE 1-65535
x DEFAULT 1]
x [-l2vni_start RANGE 0-16777215
x DEFAULT 100001]
x [-l2vni_step RANGE 0-16777215
x DEFAULT 1]
x [-repeat_l2vni_vtep CHOICES 0 1
x DEFAULT 1]
x [-repeat_l2vni_ports CHOICES 0 1
x DEFAULT 1]
x [-l3vni_start RANGE 0-16777215
x DEFAULT 200001]
x [-l3vni_ste RANGE 0-16777215
x DEFAULT 1]
x [-repeat_l3vni_vtep CHOICES 0 1
x DEFAULT 1]
x [-repeat_l3vni_ports CHOICES 0 1
x DEFAULT 1]
x [-router_mac_address ALPHA]
x [-mac_vrf_auto CHOICES 0 1
x DEFAULT 0]
x [-macvrf_route_target_type CHOICES as as4 ip
x DEFAULT as]
x [-mac_vrf_as2_byte_start RANGE 0-65535
x DEFAULT 100]
x [-mac_vrf_as2_byte_step RANGE 0-65535
x DEFAULT 0]
x [-mac_vrf_as4_byte_start RANGE 0-4294967295
x DEFAULT 100]
x [-mac_vrf_as4_byte_step RANGE 0-4294967295
x DEFAULT 0]
x [-mac_vrf_ipv4_start IPV4
x DEFAULT 2.2.2.2]
x [-mac_vrf_ipv4_step IPV4
x DEFAULT 0.0.0.0]
x [-mac_vrf_assigned_number_start RANGE 0-4294967295
x DEFAULT 1]
x [-mac_vrf_assigned_number_step RANGE 0-4294967295
x DEFAULT 1]
x [-ip_vrf_auto CHOICES 0 1
x DEFAULT 1]
x [-ipvrf_route_target_type CHOICES as as4 ip
x DEFAULT as]
x [-ip_vrf_as2_byte_start RANGE 0-65535
x DEFAULT 100]
x [-ip_vrf_as2_byte_step RANGE 0-65535
x DEFAULT 0]
x [-ip_vrf_as4_byte_start RANGE 0-4294967295
x DEFAULT 100]
x [-ip_vrf_as4_byte_step RANGE 0-4294967295
x DEFAULT 0]
x [-ip_vrf_ipv4_start IPV4
x DEFAULT 2.2.2.2]
x [-ip_vrf_ipv4_step IPV4
x DEFAULT 0.0.0.0]
x [-ip_vrf_assigned_number_start RANGE 0-4294967295
x DEFAULT 1]
x [-ip_vrf_assigned_number_step RANGE 0-4294967295
x DEFAULT 1]
x [-imet_route CHOICES 0 1
x DEFAULT 0]
x [-multicast_tunnel_type CHOICES tunneltypeingressreplication
x CHOICES pimsm
x CHOICES pimssm
x DEFAULT tunneltypeingressreplication]
x [-same_l2vni_for_multicast CHOICES 0 1
x DEFAULT 1]
x [-multicast_vni_start RANGE 0-16777215
x DEFAULT 300001]
x [-multicast_vni_step RANGE 0-16777215
x DEFAULT 1]
x [-repeat_vniacross_vtep CHOICES 0 1
x DEFAULT 1]
x [-repeat_vniacross_port CHOICES 0 1
x DEFAULT 1]
x [-group_address ALPHA]
x [-rp_address IPV4
x DEFAULT 1.1.1.1]
x [-vm_count_per_bd RANGE 0-100000000
x DEFAULT 1]
x [-vm_host_mac_address_start MAC
x DEFAULT 22:22:00:00:00:01]
x [-enable_vlan CHOICES 0 1
x DEFAULT 0]
x [-vlan_id_start RANGE 0-4095
x DEFAULT 1001]
x [-vlan_id_ste RANGE 0-4095
x DEFAULT 1]
x [-enable_mac_mobility CHOICES 0 1
x DEFAULT 0]
x [-enable_ipv4_address CHOICES 0 1
x DEFAULT 0]
x [-ipv4_address_start IPV4
x DEFAULT 192.168.0.1]
x [-ipv4_subnet_mask RANGE 0-32
x DEFAULT 24]
x [-enable_ipv6_address CHOICES 0 1
x DEFAULT 0]
x [-ipv6_address_start IPV6
x DEFAULT 2000::1]
x [-ipv6_subnet_mask RANGE 0-128
x DEFAULT 64]
x [-number_of_ip_prefix_route RANGE 0-100000000
x DEFAULT 0]
x [-ipv4_prefix_start IPV4
x DEFAULT 192.168.1.0]
x [-ipv4_prefix_length RANGE 0-32
x DEFAULT 24]
x [-number_of_ipv6_prefix_route RANGE 0-100000000
x DEFAULT 0]
x [-ipv6_prefix_start IPV6
x DEFAULT 2222::0]
x [-ipv6_prefix_length RANGE 0-128
x DEFAULT 64]
x [-use_case CHOICES interfaceLess
x CHOICES interfacefullWithCorefacingIRB
x CHOICES interfacefullWithUnnumberedCorefacingIRB
x CHOICES tsipAddressOverlayIndex
x DEFAULT interfaceLess]
x [-vni_for_irb ALPHA]
x [-irb_ip_address ALPHA]
x [-irb_mac ALPHA]
x [-va_ip_address ALPHA]
x [-va_ipv6_address ALPHA]
x [-va_mac ALPHA]
x [-number_of_vm_host RANGE 1-1000
x DEFAULT 1]
x [-host_mac_address ALPHA]
x [-enable_vlan_for_vms CHOICES 0 1
x DEFAULT 0]
x [-vlan_id_for_vms ALPHA]
x [-enable_ipv4_address_for_vms CHOICES 0 1
x DEFAULT 0]
x [-ipv4_address_for_vms ALPHA]
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_evpn_vxlan_wizard.py_part1
|
x [-mac_vrf_as2_byte_step RANGE 0-65535
x DEFAULT 0]
x [-mac_vrf_as4_byte_start RANGE 0-4294967295
x DEFAULT 100]
x [-mac_vrf_as4_byte_step RANGE 0-4294967295
x DEFAULT 0]
x [-mac_vrf_ipv4_start IPV4
x DEFAULT 2.2.2.2]
x [-mac_vrf_ipv4_step IPV4
x DEFAULT 0.0.0.0]
x [-mac_vrf_assigned_number_start RANGE 0-4294967295
x DEFAULT 1]
x [-mac_vrf_assigned_number_step RANGE 0-4294967295
x DEFAULT 1]
x [-ip_vrf_auto CHOICES 0 1
x DEFAULT 1]
x [-ipvrf_route_target_type CHOICES as as4 ip
x DEFAULT as]
x [-ip_vrf_as2_byte_start RANGE 0-65535
x DEFAULT 100]
x [-ip_vrf_as2_byte_step RANGE 0-65535
x DEFAULT 0]
x [-ip_vrf_as4_byte_start RANGE 0-4294967295
x DEFAULT 100]
x [-ip_vrf_as4_byte_step RANGE 0-4294967295
x DEFAULT 0]
x [-ip_vrf_ipv4_start IPV4
x DEFAULT 2.2.2.2]
x [-ip_vrf_ipv4_step IPV4
x DEFAULT 0.0.0.0]
x [-ip_vrf_assigned_number_start RANGE 0-4294967295
x DEFAULT 1]
x [-ip_vrf_assigned_number_step RANGE 0-4294967295
x DEFAULT 1]
x [-imet_route CHOICES 0 1
x DEFAULT 0]
x [-multicast_tunnel_type CHOICES tunneltypeingressreplication
x CHOICES pimsm
x CHOICES pimssm
x DEFAULT tunneltypeingressreplication]
x [-same_l2vni_for_multicast CHOICES 0 1
x DEFAULT 1]
x [-multicast_vni_start RANGE 0-16777215
x DEFAULT 300001]
x [-multicast_vni_step RANGE 0-16777215
x DEFAULT 1]
x [-repeat_vniacross_vtep CHOICES 0 1
x DEFAULT 1]
x [-repeat_vniacross_port CHOICES 0 1
x DEFAULT 1]
x [-group_address ALPHA]
x [-rp_address IPV4
x DEFAULT 1.1.1.1]
x [-vm_count_per_bd RANGE 0-100000000
x DEFAULT 1]
x [-vm_host_mac_address_start MAC
x DEFAULT 22:22:00:00:00:01]
x [-enable_vlan CHOICES 0 1
x DEFAULT 0]
x [-vlan_id_start RANGE 0-4095
x DEFAULT 1001]
x [-vlan_id_ste RANGE 0-4095
x DEFAULT 1]
x [-enable_mac_mobility CHOICES 0 1
x DEFAULT 0]
x [-enable_ipv4_address CHOICES 0 1
x DEFAULT 0]
x [-ipv4_address_start IPV4
x DEFAULT 192.168.0.1]
x [-ipv4_subnet_mask RANGE 0-32
x DEFAULT 24]
x [-enable_ipv6_address CHOICES 0 1
x DEFAULT 0]
x [-ipv6_address_start IPV6
x DEFAULT 2000::1]
x [-ipv6_subnet_mask RANGE 0-128
x DEFAULT 64]
x [-number_of_ip_prefix_route RANGE 0-100000000
x DEFAULT 0]
x [-ipv4_prefix_start IPV4
x DEFAULT 192.168.1.0]
x [-ipv4_prefix_length RANGE 0-32
x DEFAULT 24]
x [-number_of_ipv6_prefix_route RANGE 0-100000000
x DEFAULT 0]
x [-ipv6_prefix_start IPV6
x DEFAULT 2222::0]
x [-ipv6_prefix_length RANGE 0-128
x DEFAULT 64]
x [-use_case CHOICES interfaceLess
x CHOICES interfacefullWithCorefacingIRB
x CHOICES interfacefullWithUnnumberedCorefacingIRB
x CHOICES tsipAddressOverlayIndex
x DEFAULT interfaceLess]
x [-vni_for_irb ALPHA]
x [-irb_ip_address ALPHA]
x [-irb_mac ALPHA]
x [-va_ip_address ALPHA]
x [-va_ipv6_address ALPHA]
x [-va_mac ALPHA]
x [-number_of_vm_host RANGE 1-1000
x DEFAULT 1]
x [-host_mac_address ALPHA]
x [-enable_vlan_for_vms CHOICES 0 1
x DEFAULT 0]
x [-vlan_id_for_vms ALPHA]
x [-enable_ipv4_address_for_vms CHOICES 0 1
x DEFAULT 0]
x [-ipv4_address_for_vms ALPHA]
x [-ipv4_subnet_mask_for_vms RANGE 0-32
x DEFAULT 24]
x [-ipv4_gateway_for_vms ALPHA]
x [-enable_ipv6_address_for_vms CHOICES 0 1
x DEFAULT 0]
x [-ipv6_address_for_vms ALPHA]
x [-ipv6_subnet_mask_for_vms RANGE 0-128
x DEFAULT 64]
x [-ipv6_gateway_for_vms ALPHA]
Arguments:
x -vtep_side_port
x Port count in Spine-Leaf topology.
x -host_side_port
x Port count in VM or Host topology.
x -enable_spine
x Configures Spine in topology.
x -number_of_spines_per_port
x Spine count per port. This parameter is only valid if enable_spine parameter is set to True.
x -spine_interface_address
x Spine Interface IP Address. This interface is connected to DUT. This parameter is only valid if enable_spine parameter is set to True.
x -spine_interface_address_prefix
x Spine Interface Subnet Mask. This interface is connected to DUT. This parameter is only valid if enable_spine parameter is set to True.
x -vtep_address
x VTEP Interface IP Address. This interface is connected to DUT. This parameter is only valid if enable_spine parameter is set to False.
x -vtep_prefix_length
x VTEP Interface Subnet Mask. This interface is connected to DUT. This parameter is only valid if enable_spine parameter is set to False.
x -gateway_address
x Interface Gateway IP Address.
x -spine_vlan_enabled
x Configures VLAN in Interface.
x -spine_vlan_id
x VLAN ID pattern in Interface. This parameter is only valid if spine_vlan_enabled parameter is set to True.
x -spine_underlaying_protocol
x Routing protocol in Spine/VTEP.
x -spine_remote_bgp
x Underlay BGP neighbour pattern. This parameter is only valid if spine_underlaying_protocol parameter is set to ebgp.
x -spine_local_as
x Underlay BGP local AS Number pattern. This parameter is only valid if spine_underlaying_protocol parameter is set to ebgp.
x -ospf_area_id
x Area Id of OSPF. This parameter is only valid if spine_underlaying_protocol parameter is set to ospf.
x -ospf_network_type
x OSPF Network Type. This parameter is only valid if spine_underlaying_protocol parameter is set to ospf.
x -isis_network_type
x IS-IS Network Type. This parameter is only valid if spine_underlaying_protocol parameter is set to isis.
x -isis_area_id
x Area Id of IS-IS. This parameter is only valid if spine_underlaying_protocol parameter is set to isis.
x -isis_level
x Level of IS-IS. This parameter is only valid if spine_underlaying_protocol parameter is set to isis.
x -vtep_number_per_spine
x VTEP count per Spine.
x -vtep_number_per_port
x VTEP count per Port.
x -configure_loopback_ip
x Confiugres EVPN on loopback interface.
x -vtep_loopback_address
x IP address pattern for loopback interface.
x -vtep_loopback_prefix_length
x Prefix length for loopback IP address.
x -vtep_dut_loopback_address
x Loopback address of DUT for BGP peering.
x -vtep_bgp_peering_type
x Overlay BGP peering type.
x -vtep_local_as
x Overlay BGP local AS pattern.
x -vtep_multi_homing
x Configures multi-homing in VTEP.
x -ethernet_segment_type
x Ethernet Segment Type. This parameter is only valid if vtep_multi_homing parameter is set to True.
x -ethernet_segement_id
x Enternet Segment Id. This parameter is only valid if vtep_multi_homing parameter is set to True.
x -multi_homing_type
x Type of Multi-Homing. This parameter is only valid if vtep_multi_homing parameter is set to True.
x -enable_irb
x Enable Integrated Routing andBridging in VTEP.
x -irb_model
x IRB model in VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -l3vni_per_vtep
x L3VNI count per VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -service_interface_type
x Service interface type in VTEP.
x -mac_vrf_per_vtep
x MAC-VRF count per VTEP. This parameter is only valid if service_interface_type parameter is set to vlanAwareBundle.
x -mac_vrfper_ip_vrf
x MAC-VRF count per IP-VRF.
x -bd_per_mac_vrf
x Broadcast domain count per MAC-VRF. This parameter is only valid if service_interface_type parameter is set to vlanAwareBundle.
x -ethernet_tag_id_start
x Ethernet Tag ID in first broadcast domain of a VTEP. This parameter is only valid if service_interface_type parameter is set to vlanAwareBundle.
x -ethernet_tag_id_step
x Ethernet Tag ID step in broadcast domain of a VTEP. This parameter is only valid if service_interface_type parameter is set to vlanAwareBundle.
x -l2_per_l3vni
x L2VNI count per L3VNI. This parameter is only valid if enable_irb parameter is set to True.
x -l2vni_per_vtep
x L2VNI count per VTEP. This parameter is only valid if service_interface_type parameter is set to vlanBasedService.
x -l2vni_start
x L2VNI start value in VTEP.
x -l2vni_step
x L2VNI step value in VTEP.
x -repeat_l2vni_vtep
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_evpn_vxlan_wizard.py_part2
|
x [-ipv4_address_for_vms ALPHA]
x [-ipv4_subnet_mask_for_vms RANGE 0-32
x DEFAULT 24]
x [-ipv4_gateway_for_vms ALPHA]
x [-enable_ipv6_address_for_vms CHOICES 0 1
x DEFAULT 0]
x [-ipv6_address_for_vms ALPHA]
x [-ipv6_subnet_mask_for_vms RANGE 0-128
x DEFAULT 64]
x [-ipv6_gateway_for_vms ALPHA]
Arguments:
x -vtep_side_port
x Port count in Spine-Leaf topology.
x -host_side_port
x Port count in VM or Host topology.
x -enable_spine
x Configures Spine in topology.
x -number_of_spines_per_port
x Spine count per port. This parameter is only valid if enable_spine parameter is set to True.
x -spine_interface_address
x Spine Interface IP Address. This interface is connected to DUT. This parameter is only valid if enable_spine parameter is set to True.
x -spine_interface_address_prefix
x Spine Interface Subnet Mask. This interface is connected to DUT. This parameter is only valid if enable_spine parameter is set to True.
x -vtep_address
x VTEP Interface IP Address. This interface is connected to DUT. This parameter is only valid if enable_spine parameter is set to False.
x -vtep_prefix_length
x VTEP Interface Subnet Mask. This interface is connected to DUT. This parameter is only valid if enable_spine parameter is set to False.
x -gateway_address
x Interface Gateway IP Address.
x -spine_vlan_enabled
x Configures VLAN in Interface.
x -spine_vlan_id
x VLAN ID pattern in Interface. This parameter is only valid if spine_vlan_enabled parameter is set to True.
x -spine_underlaying_protocol
x Routing protocol in Spine/VTEP.
x -spine_remote_bgp
x Underlay BGP neighbour pattern. This parameter is only valid if spine_underlaying_protocol parameter is set to ebgp.
x -spine_local_as
x Underlay BGP local AS Number pattern. This parameter is only valid if spine_underlaying_protocol parameter is set to ebgp.
x -ospf_area_id
x Area Id of OSPF. This parameter is only valid if spine_underlaying_protocol parameter is set to ospf.
x -ospf_network_type
x OSPF Network Type. This parameter is only valid if spine_underlaying_protocol parameter is set to ospf.
x -isis_network_type
x IS-IS Network Type. This parameter is only valid if spine_underlaying_protocol parameter is set to isis.
x -isis_area_id
x Area Id of IS-IS. This parameter is only valid if spine_underlaying_protocol parameter is set to isis.
x -isis_level
x Level of IS-IS. This parameter is only valid if spine_underlaying_protocol parameter is set to isis.
x -vtep_number_per_spine
x VTEP count per Spine.
x -vtep_number_per_port
x VTEP count per Port.
x -configure_loopback_ip
x Confiugres EVPN on loopback interface.
x -vtep_loopback_address
x IP address pattern for loopback interface.
x -vtep_loopback_prefix_length
x Prefix length for loopback IP address.
x -vtep_dut_loopback_address
x Loopback address of DUT for BGP peering.
x -vtep_bgp_peering_type
x Overlay BGP peering type.
x -vtep_local_as
x Overlay BGP local AS pattern.
x -vtep_multi_homing
x Configures multi-homing in VTEP.
x -ethernet_segment_type
x Ethernet Segment Type. This parameter is only valid if vtep_multi_homing parameter is set to True.
x -ethernet_segement_id
x Enternet Segment Id. This parameter is only valid if vtep_multi_homing parameter is set to True.
x -multi_homing_type
x Type of Multi-Homing. This parameter is only valid if vtep_multi_homing parameter is set to True.
x -enable_irb
x Enable Integrated Routing andBridging in VTEP.
x -irb_model
x IRB model in VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -l3vni_per_vtep
x L3VNI count per VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -service_interface_type
x Service interface type in VTEP.
x -mac_vrf_per_vtep
x MAC-VRF count per VTEP. This parameter is only valid if service_interface_type parameter is set to vlanAwareBundle.
x -mac_vrfper_ip_vrf
x MAC-VRF count per IP-VRF.
x -bd_per_mac_vrf
x Broadcast domain count per MAC-VRF. This parameter is only valid if service_interface_type parameter is set to vlanAwareBundle.
x -ethernet_tag_id_start
x Ethernet Tag ID in first broadcast domain of a VTEP. This parameter is only valid if service_interface_type parameter is set to vlanAwareBundle.
x -ethernet_tag_id_step
x Ethernet Tag ID step in broadcast domain of a VTEP. This parameter is only valid if service_interface_type parameter is set to vlanAwareBundle.
x -l2_per_l3vni
x L2VNI count per L3VNI. This parameter is only valid if enable_irb parameter is set to True.
x -l2vni_per_vtep
x L2VNI count per VTEP. This parameter is only valid if service_interface_type parameter is set to vlanBasedService.
x -l2vni_start
x L2VNI start value in VTEP.
x -l2vni_step
x L2VNI step value in VTEP.
x -repeat_l2vni_vtep
x Configures same L2VNI pattern in each VTEP.
x -repeat_l2vni_ports
x Configures same L2VNI pattern inVTEPs across ports. This parameter is only valid if repeat_l2vni_vtep parameter is set to False.
x -l3vni_start
x L3VNI start value in VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -l3vni_ste
x L3VNI step value in VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -repeat_l3vni_vtep
x Configures same L3VNI pattern ineach VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -repeat_l3vni_ports
x Configures same L3VNI pattern inVTEPs across ports. This parameter is only valid if repeat_l3vni_vtep parameter is set to False.
x -router_mac_address
x Router's MAC or IRB MAC in each VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -mac_vrf_auto
x Configures MAC-VRF Route Target as BGP AS:L2VNI.
x -macvrf_route_target_type
x Type of L2 RT used. This parameter is only valid if mac_vrf_auto parameter is set to False.
x -mac_vrf_as2_byte_start
x 2 byte AS Start value. This parameter is only valid if macvrf_route_target_type parameter is set to as.
x -mac_vrf_as2_byte_step
x 2 byte AS Step value. This parameter is only valid if macvrf_route_target_type parameter is set to as.
x -mac_vrf_as4_byte_start
x 4 byte AS Start value. This parameter is only valid if macvrf_route_target_type parameter is set to as4.
x -mac_vrf_as4_byte_step
x 4 byte AS Step value. This parameter is only valid if macvrf_route_target_type parameter is set to as4.
x -mac_vrf_ipv4_start
x IPv4 format AS Start value. This parameter is only valid if macvrf_route_target_type parameter is set to ip.
x -mac_vrf_ipv4_step
x IPv4 format AS Step value. This parameter is only valid if macvrf_route_target_type parameter is set to ip.
x -mac_vrf_assigned_number_start
x Start value of Assigned number. This parameter is only valid if mac_vrf_auto parameter is set to False.
x -mac_vrf_assigned_number_step
x Step value of Assigned number. This parameter is only valid if mac_vrf_auto parameter is set to False.
x -ip_vrf_auto
x Configures IP-VRF Route Target asBGP AS:L3VNI.
x -ipvrf_route_target_type
x Type of L3 RT used.
x -ip_vrf_as2_byte_start
x 2 byte AS Start value.
x -ip_vrf_as2_byte_step
x 2 byte AS Step value.
x -ip_vrf_as4_byte_start
x 4 byte AS Start value.
x -ip_vrf_as4_byte_step
x 4 byte AS Step value.
x -ip_vrf_ipv4_start
x IPv4 format AS Start value.
x -ip_vrf_ipv4_step
x IPv4 format AS Step value.
x -ip_vrf_assigned_number_start
x Start value of Assigned number.
x -ip_vrf_assigned_number_step
x Step value of Assigned number.
x -imet_route
x Configures EVPN type 3 multicast route in VTEP.
x -multicast_tunnel_type
x PMSI tunnel type in type 3 route. This parameter is only valid if imet_route parameter is set to True.
x -same_l2vni_for_multicast
x Configures same L2VNI for unicastand multicast. This parameter is only valid if imet_route parameter is set to True.
x -multicast_vni_start
x Start value of VNI for mulitcast in aVTEP.
x -multicast_vni_step
x Step value of VNI for mulitcast in aVTEP.
x -repeat_vniacross_vtep
x Configures same VNI pattern ineach VTEP.
x -repeat_vniacross_port
x Configures same VNI pattern inVTEPs across ports.
x -group_address
x Multicast group address pattern.
x -rp_address
x RP address of underlay network.
x -vm_count_per_bd
x Simulated VM count per BD in VTEP. This creates EVPN MAC/IP routes.
x -vm_host_mac_address_start
x Start MAC Address pattern of VMs.
x -enable_vlan
x Configures VLAN in simulated VMs.
x -vlan_id_start
x Start value in VLAN ID pattern ofsimulated VTEPs. This parameter is only valid if enable_vlan parameter is set to True.
x -vlan_id_ste
x Step value in VLAN ID pattern ofsimulated VTEPs. This parameter is only valid if enable_vlan parameter is set to True.
x -enable_mac_mobility
x Configures MAC mobility extended community inEVPN MAC/IP route.
x -enable_ipv4_address
x Enables IP advertisement along with MAC inEVPN MAC/IP route.
x -ipv4_address_start
x Start IPv4 Address of VMs. This parameter is only valid if enable_ipv4_address parameter is set to True.
x -ipv4_subnet_mask
x IPv4 Subnet Mask of VMs. This parameter is only valid if enable_ipv4_address parameter is set to True.
x -enable_ipv6_address
x Enables IPv6 advertisement along with MAC inEVPN MAC/IP route.
x -ipv6_address_start
x Start IPv6 Address of VMs. This parameter is only valid if enable_ipv6_address parameter is set to True.
x -ipv6_subnet_mask
x IPv6 Subnet Mask of VMs. This parameter is only valid if enable_ipv6_address parameter is set to True.
x -number_of_ip_prefix_route
x EVPN IPv4 prefix route count perBD in a VTEP.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_evpn_vxlan_wizard.py_part3
|
x Configures same L2VNI pattern in each VTEP.
x -repeat_l2vni_ports
x Configures same L2VNI pattern inVTEPs across ports. This parameter is only valid if repeat_l2vni_vtep parameter is set to False.
x -l3vni_start
x L3VNI start value in VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -l3vni_ste
x L3VNI step value in VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -repeat_l3vni_vtep
x Configures same L3VNI pattern ineach VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -repeat_l3vni_ports
x Configures same L3VNI pattern inVTEPs across ports. This parameter is only valid if repeat_l3vni_vtep parameter is set to False.
x -router_mac_address
x Router's MAC or IRB MAC in each VTEP. This parameter is only valid if enable_irb parameter is set to True.
x -mac_vrf_auto
x Configures MAC-VRF Route Target as BGP AS:L2VNI.
x -macvrf_route_target_type
x Type of L2 RT used. This parameter is only valid if mac_vrf_auto parameter is set to False.
x -mac_vrf_as2_byte_start
x 2 byte AS Start value. This parameter is only valid if macvrf_route_target_type parameter is set to as.
x -mac_vrf_as2_byte_step
x 2 byte AS Step value. This parameter is only valid if macvrf_route_target_type parameter is set to as.
x -mac_vrf_as4_byte_start
x 4 byte AS Start value. This parameter is only valid if macvrf_route_target_type parameter is set to as4.
x -mac_vrf_as4_byte_step
x 4 byte AS Step value. This parameter is only valid if macvrf_route_target_type parameter is set to as4.
x -mac_vrf_ipv4_start
x IPv4 format AS Start value. This parameter is only valid if macvrf_route_target_type parameter is set to ip.
x -mac_vrf_ipv4_step
x IPv4 format AS Step value. This parameter is only valid if macvrf_route_target_type parameter is set to ip.
x -mac_vrf_assigned_number_start
x Start value of Assigned number. This parameter is only valid if mac_vrf_auto parameter is set to False.
x -mac_vrf_assigned_number_step
x Step value of Assigned number. This parameter is only valid if mac_vrf_auto parameter is set to False.
x -ip_vrf_auto
x Configures IP-VRF Route Target asBGP AS:L3VNI.
x -ipvrf_route_target_type
x Type of L3 RT used.
x -ip_vrf_as2_byte_start
x 2 byte AS Start value.
x -ip_vrf_as2_byte_step
x 2 byte AS Step value.
x -ip_vrf_as4_byte_start
x 4 byte AS Start value.
x -ip_vrf_as4_byte_step
x 4 byte AS Step value.
x -ip_vrf_ipv4_start
x IPv4 format AS Start value.
x -ip_vrf_ipv4_step
x IPv4 format AS Step value.
x -ip_vrf_assigned_number_start
x Start value of Assigned number.
x -ip_vrf_assigned_number_step
x Step value of Assigned number.
x -imet_route
x Configures EVPN type 3 multicast route in VTEP.
x -multicast_tunnel_type
x PMSI tunnel type in type 3 route. This parameter is only valid if imet_route parameter is set to True.
x -same_l2vni_for_multicast
x Configures same L2VNI for unicastand multicast. This parameter is only valid if imet_route parameter is set to True.
x -multicast_vni_start
x Start value of VNI for mulitcast in aVTEP.
x -multicast_vni_step
x Step value of VNI for mulitcast in aVTEP.
x -repeat_vniacross_vtep
x Configures same VNI pattern ineach VTEP.
x -repeat_vniacross_port
x Configures same VNI pattern inVTEPs across ports.
x -group_address
x Multicast group address pattern.
x -rp_address
x RP address of underlay network.
x -vm_count_per_bd
x Simulated VM count per BD in VTEP. This creates EVPN MAC/IP routes.
x -vm_host_mac_address_start
x Start MAC Address pattern of VMs.
x -enable_vlan
x Configures VLAN in simulated VMs.
x -vlan_id_start
x Start value in VLAN ID pattern ofsimulated VTEPs. This parameter is only valid if enable_vlan parameter is set to True.
x -vlan_id_ste
x Step value in VLAN ID pattern ofsimulated VTEPs. This parameter is only valid if enable_vlan parameter is set to True.
x -enable_mac_mobility
x Configures MAC mobility extended community inEVPN MAC/IP route.
x -enable_ipv4_address
x Enables IP advertisement along with MAC inEVPN MAC/IP route.
x -ipv4_address_start
x Start IPv4 Address of VMs. This parameter is only valid if enable_ipv4_address parameter is set to True.
x -ipv4_subnet_mask
x IPv4 Subnet Mask of VMs. This parameter is only valid if enable_ipv4_address parameter is set to True.
x -enable_ipv6_address
x Enables IPv6 advertisement along with MAC inEVPN MAC/IP route.
x -ipv6_address_start
x Start IPv6 Address of VMs. This parameter is only valid if enable_ipv6_address parameter is set to True.
x -ipv6_subnet_mask
x IPv6 Subnet Mask of VMs. This parameter is only valid if enable_ipv6_address parameter is set to True.
x -number_of_ip_prefix_route
x EVPN IPv4 prefix route count perBD in a VTEP.
x -ipv4_prefix_start
x Start value of IPv4 prefix pattern.
x -ipv4_prefix_length
x Start value IPv4 prefix length.
x -number_of_ipv6_prefix_route
x EVPN IPv6 prefix route count per BD in a VTEP.
x -ipv6_prefix_start
x Start value of IPv6 prefix pattern.
x -ipv6_prefix_length
x Start value IPv6 prefix length.
x -use_case
x EVPN IP Prefix route Use case.
x -vni_for_irb
x VNI pattern for SBD IRB Interface.
x -irb_ip_address
x IP Address pattern of SBD IRB Interface.
x -irb_mac
x MAC Address pattern of SBD IRB Interface.
x -va_ip_address
x IPv4 Address pattern of Virtual Appliances.
x -va_ipv6_address
x IPv6 Address pattern of Virtual Appliances.
x -va_mac
x MAC Address pattern of Virtual Appliances.
x -number_of_vm_host
x Number of Hosts in VM or Host topology.
x -host_mac_address
x MAC Addresses in VM or Host topology.
x -enable_vlan_for_vms
x Configure VLAN in VM/Hosts.
x -vlan_id_for_vms
x Configure VLAN ID. This parameter is only valid if enable_vlan_for_vms parameter is set to True.
x -enable_ipv4_address_for_vms
x To enable IPv4 Address in VM/Hosts.
x -ipv4_address_for_vms
x IPv4 Addresses for VMs/Hosts. This parameter is only valid if enable_ipv4_address_for_vms parameter is set to True.
x -ipv4_subnet_mask_for_vms
x IPv4 subnet-mask for VMs/Hosts. This parameter is only valid if enable_ipv4_address_for_vms parameter is set to True.
x -ipv4_gateway_for_vms
x Gateway for VM/Hosts. This parameter is only valid if enable_ipv4_address_for_vms parameter is set to True.
x -enable_ipv6_address_for_vms
x To enable IPv6 Address in VM/Hosts.
x -ipv6_address_for_vms
x IPv6 Addresses for VMs/Hosts. This parameter is only valid if enable_ipv6_address_for_vms parameter is set to True.
x -ipv6_subnet_mask_for_vms
x IPv6 subnet-mask for VMs/Hosts. This parameter is only valid if enable_ipv6_address_for_vms parameter is set to True.
x -ipv6_gateway_for_vms
x Gateway for VM/Hosts. This parameter is only valid if enable_ipv6_address_for_vms parameter is set to True.
Return Values:
$::SUCCESS | $::FAILURE
x key:status value:$::SUCCESS | $::FAILURE
On status of failure, gives detailed information.
x key:log value:On status of failure, gives detailed information.
A list of topology handles configured. Can be used with the topology_config Api
x key:topology_handle value:A list of topology handles configured. Can be used with the topology_config Api
A list of devide group handles configured. Can be used with the topology_config Api
x key:device_group_handle value:A list of devide group handles configured. Can be used with the topology_config Api
A list of network group handles configured (if any). Can be used with the network_group_config Api
x key:network_group_handle value:A list of network group handles configured (if any). Can be used with the network_group_config Api
A list of Ipv4 prefix pool handles configured (if any). Can be used with the network_group_config Api
x key:ipv4_prefix_pools_handle value:A list of Ipv4 prefix pool handles configured (if any). Can be used with the network_group_config Api
A list of Mac pool handles configured (if any). Can be used with the network_group_config Api
x key:mac_pools_handle value:A list of Mac pool handles configured (if any). Can be used with the network_group_config Api
A list of Ipv4 protocol stack handles configured. Can be used with the interface_config Api
x key:ipv4_handle value:A list of Ipv4 protocol stack handles configured. Can be used with the interface_config Api
A list of Ipv4 loopback protocol stack handles configured. Can be used with the interface_config Api
x key:ipv4_loopback_handle value:A list of Ipv4 loopback protocol stack handles configured. Can be used with the interface_config Api
Handle of ethernet protocol stacks configured. Can be used with the Api interface_config
x key:ethernet_handle value:Handle of ethernet protocol stacks configured. Can be used with the Api interface_config
A list of BGP protocol stack handles configured (if any). Can be used with the emulation_bgp_config Api
x key:bgp_handle value:A list of BGP protocol stack handles configured (if any). Can be used with the emulation_bgp_config Api
A list of BGP IP route handles configured (if any). Can be used with the emulation_bgp_route_config Api
x key:ip_routes value:A list of BGP IP route handles configured (if any). Can be used with the emulation_bgp_route_config Api
A list of EVPN EVI handles configured (if any). Can be used with the emulation_bgp_route_config Api
x key:evpn_evi value:A list of EVPN EVI handles configured (if any). Can be used with the emulation_bgp_route_config Api
A list of Broadcast Domain handles configured (if any). Can be used with the emulation_bgp_route_config Api
x key:broadcast_domain_handle value:A list of Broadcast Domain handles configured (if any). Can be used with the emulation_bgp_route_config Api
A list of Isis protocol handles configured (if any). Can be used with the emulation_isis_config Api
x key:isis_l3_handle value:A list of Isis protocol handles configured (if any). Can be used with the emulation_isis_config Api
A list of Isis router handles configured (if any). Can be used with the emulation_isis_config Api
x key:isis_l3_router_handle value:A list of Isis router handles configured (if any). Can be used with the emulation_isis_config Api
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_evpn_vxlan_wizard.py_part4
|
x -ipv4_prefix_start
x Start value of IPv4 prefix pattern.
x -ipv4_prefix_length
x Start value IPv4 prefix length.
x -number_of_ipv6_prefix_route
x EVPN IPv6 prefix route count per BD in a VTEP.
x -ipv6_prefix_start
x Start value of IPv6 prefix pattern.
x -ipv6_prefix_length
x Start value IPv6 prefix length.
x -use_case
x EVPN IP Prefix route Use case.
x -vni_for_irb
x VNI pattern for SBD IRB Interface.
x -irb_ip_address
x IP Address pattern of SBD IRB Interface.
x -irb_mac
x MAC Address pattern of SBD IRB Interface.
x -va_ip_address
x IPv4 Address pattern of Virtual Appliances.
x -va_ipv6_address
x IPv6 Address pattern of Virtual Appliances.
x -va_mac
x MAC Address pattern of Virtual Appliances.
x -number_of_vm_host
x Number of Hosts in VM or Host topology.
x -host_mac_address
x MAC Addresses in VM or Host topology.
x -enable_vlan_for_vms
x Configure VLAN in VM/Hosts.
x -vlan_id_for_vms
x Configure VLAN ID. This parameter is only valid if enable_vlan_for_vms parameter is set to True.
x -enable_ipv4_address_for_vms
x To enable IPv4 Address in VM/Hosts.
x -ipv4_address_for_vms
x IPv4 Addresses for VMs/Hosts. This parameter is only valid if enable_ipv4_address_for_vms parameter is set to True.
x -ipv4_subnet_mask_for_vms
x IPv4 subnet-mask for VMs/Hosts. This parameter is only valid if enable_ipv4_address_for_vms parameter is set to True.
x -ipv4_gateway_for_vms
x Gateway for VM/Hosts. This parameter is only valid if enable_ipv4_address_for_vms parameter is set to True.
x -enable_ipv6_address_for_vms
x To enable IPv6 Address in VM/Hosts.
x -ipv6_address_for_vms
x IPv6 Addresses for VMs/Hosts. This parameter is only valid if enable_ipv6_address_for_vms parameter is set to True.
x -ipv6_subnet_mask_for_vms
x IPv6 subnet-mask for VMs/Hosts. This parameter is only valid if enable_ipv6_address_for_vms parameter is set to True.
x -ipv6_gateway_for_vms
x Gateway for VM/Hosts. This parameter is only valid if enable_ipv6_address_for_vms parameter is set to True.
Return Values:
$::SUCCESS | $::FAILURE
x key:status value:$::SUCCESS | $::FAILURE
On status of failure, gives detailed information.
x key:log value:On status of failure, gives detailed information.
A list of topology handles configured. Can be used with the topology_config Api
x key:topology_handle value:A list of topology handles configured. Can be used with the topology_config Api
A list of devide group handles configured. Can be used with the topology_config Api
x key:device_group_handle value:A list of devide group handles configured. Can be used with the topology_config Api
A list of network group handles configured (if any). Can be used with the network_group_config Api
x key:network_group_handle value:A list of network group handles configured (if any). Can be used with the network_group_config Api
A list of Ipv4 prefix pool handles configured (if any). Can be used with the network_group_config Api
x key:ipv4_prefix_pools_handle value:A list of Ipv4 prefix pool handles configured (if any). Can be used with the network_group_config Api
A list of Mac pool handles configured (if any). Can be used with the network_group_config Api
x key:mac_pools_handle value:A list of Mac pool handles configured (if any). Can be used with the network_group_config Api
A list of Ipv4 protocol stack handles configured. Can be used with the interface_config Api
x key:ipv4_handle value:A list of Ipv4 protocol stack handles configured. Can be used with the interface_config Api
A list of Ipv4 loopback protocol stack handles configured. Can be used with the interface_config Api
x key:ipv4_loopback_handle value:A list of Ipv4 loopback protocol stack handles configured. Can be used with the interface_config Api
Handle of ethernet protocol stacks configured. Can be used with the Api interface_config
x key:ethernet_handle value:Handle of ethernet protocol stacks configured. Can be used with the Api interface_config
A list of BGP protocol stack handles configured (if any). Can be used with the emulation_bgp_config Api
x key:bgp_handle value:A list of BGP protocol stack handles configured (if any). Can be used with the emulation_bgp_config Api
A list of BGP IP route handles configured (if any). Can be used with the emulation_bgp_route_config Api
x key:ip_routes value:A list of BGP IP route handles configured (if any). Can be used with the emulation_bgp_route_config Api
A list of EVPN EVI handles configured (if any). Can be used with the emulation_bgp_route_config Api
x key:evpn_evi value:A list of EVPN EVI handles configured (if any). Can be used with the emulation_bgp_route_config Api
A list of Broadcast Domain handles configured (if any). Can be used with the emulation_bgp_route_config Api
x key:broadcast_domain_handle value:A list of Broadcast Domain handles configured (if any). Can be used with the emulation_bgp_route_config Api
A list of Isis protocol handles configured (if any). Can be used with the emulation_isis_config Api
x key:isis_l3_handle value:A list of Isis protocol handles configured (if any). Can be used with the emulation_isis_config Api
A list of Isis router handles configured (if any). Can be used with the emulation_isis_config Api
x key:isis_l3_router_handle value:A list of Isis router handles configured (if any). Can be used with the emulation_isis_config Api
A list of Isis Route handles configured (if any). Can be used with the emulation_isis_network_group_config Api
x key:ipv4_prefix_interface_handle value:A list of Isis Route handles configured (if any). Can be used with the emulation_isis_network_group_config Api
A list of Ospf protocol handles configured (if any). Can be used with the emulation_ospf_config Api
x key:ospfv2_handle value:A list of Ospf protocol handles configured (if any). Can be used with the emulation_ospf_config Api
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_evpn_vxlan_wizard',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_evpn_vxlan_wizard.py_part5
|
A list of Isis Route handles configured (if any). Can be used with the emulation_isis_network_group_config Api
x key:ipv4_prefix_interface_handle value:A list of Isis Route handles configured (if any). Can be used with the emulation_isis_network_group_config Api
A list of Ospf protocol handles configured (if any). Can be used with the emulation_ospf_config Api
x key:ospfv2_handle value:A list of Ospf protocol handles configured (if any). Can be used with the emulation_ospf_config Api
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_evpn_vxlan_wizard',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_evpn_vxlan_wizard.py_part6
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def network_group_config(self, protocol_handle, **kwargs):
r'''
#Procedure Header
Name:
network_group_config
Description:
This procedure creates, modifies and deletes network topologies - IPv4 or Ipv6 Prefix Pools, Simulated routers to design network grid or topologies.
Synopsis:
network_group_config
x -protocol_handle ANY
x [-protocol_name ALPHA]
x [-multiplier NUMERIC]
x [-enable_device CHOICES 0 1]
x [-connected_to_handle ANY]
x [-connected_to_handle_ipv4 ANY]
x [-connected_to_handle_ipv6 ANY]
x [-mode CHOICES create modify delete
x DEFAULT create]
x [-type CHOICES dual-stack-prefix
x CHOICES ipv4-prefix
x CHOICES ipv6-prefix
x CHOICES mac-dual-stack-prefix
x CHOICES mac-ipv4-prefix
x CHOICES mac-ipv6-prefix
x CHOICES mac-pools
x CHOICES grid
x CHOICES mesh
x CHOICES custom
x CHOICES ring
x CHOICES hub-and-spoke
x CHOICES tree
x CHOICES fat-tree
x CHOICES linear]
x [-mac_pools_multiplier NUMERIC]
x [-mac_pools_number_of_addresses RANGE 1-100000000]
x [-mac_pools_prefix_length NUMERIC]
x [-mac_pools_use_vlans CHOICES 0 1]
x [-mac_pools_mac MAC]
x [-mac_pools_mac_step MAC]
x [-mac_pools_vlan_count RANGE 0-2]
x [-mac_pools_vlan_tpid CHOICES 0x8100
x CHOICES 0x88a8
x CHOICES 0x9100
x CHOICES 0x9200
x CHOICES 0x9300]
x [-mac_pools_vlan_priority NUMERIC]
x [-mac_pools_vlan_priority_step NUMERIC]
x [-mac_pools_vlan_id NUMERIC]
x [-mac_pools_vlan_id_step NUMERIC]
x [-ipv6_prefix_network_address IPV6]
x [-ipv6_prefix_network_address_step IPV6]
x [-ipv6_prefix_length NUMERIC]
x [-ipv6_prefix_address_step NUMERIC]
x [-ipv6_prefix_number_of_addresses RANGE 1-100000000]
x [-ipv6_prefix_multiplier NUMERIC]
x [-ipv4_prefix_network_address IP]
x [-ipv4_prefix_network_address_step IP
x DEFAULT 0.0.0.1]
x [-ipv4_prefix_length NUMERIC]
x [-ipv4_prefix_address_step NUMERIC]
x [-ipv4_prefix_number_of_addresses RANGE 1-100000000]
x [-ipv4_prefix_multiplier NUMERIC]
x [-external_link_router_source NUMERIC]
x [-external_link_router_destination NUMERIC]
x [-external_link_network_group_handle ANY]
[-grid_col RANGE 0-10000
DEFAULT 1]
[-grid_row RANGE 0-10000
DEFAULT 1]
x [-grid_include_emulated_device CHOICES 0 1]
x [-grid_link_multiplier NUMERIC]
x [-mesh_number_of_nodes NUMERIC]
x [-mesh_include_emulated_device CHOICES 0 1]
x [-mesh_link_multiplier NUMERIC]
x [-ring_number_of_nodes NUMERIC]
x [-ring_include_emulated_device CHOICES 0 1]
x [-ring_link_multiplier NUMERIC]
x [-hub_spoke_include_emulated_device CHOICES 0 1]
x [-hub_spoke_number_of_first_level NUMERIC]
x [-hub_spoke_number_of_second_level NUMERIC]
x [-hub_spoke_enable_level_2 CHOICES 0 1]
x [-hub_spoke_link_multiplier NUMERIC]
x [-tree_number_of_nodes NUMERIC]
x [-tree_include_emulated_device CHOICES 0 1]
x [-tree_use_tree_depth CHOICES 0 1]
x [-tree_depth NUMERIC]
x [-tree_max_children_per_node NUMERIC]
x [-tree_link_multiplier NUMERIC]
x [-custom_link_multiplier NUMERIC]
x [-custom_from_node_index NUMERIC]
x [-custom_to_node_index NUMERIC]
x [-fat_tree_include_emulated_device CHOICES 0 1]
x [-fat_tree_link_multiplier NUMERIC]
x [-fat_tree_level_count NUMERIC]
x [-fat_tree_node_count NUMERIC]
x [-linear_include_emulated_device CHOICES 0 1]
x [-linear_nodes NUMERIC]
x [-linear_link_multiplier NUMERIC]
Arguments:
x -protocol_handle
x -protocol_name
x -multiplier
x -enable_device
x enables/disables device.
x -connected_to_handle
x Scenario element this connector is connecting to
x -connected_to_handle_ipv4
x Scenario element IPV4_prefix connector is connecting to for dual-stack-prefix mode.
x -connected_to_handle_ipv6
x Scenario element IPV6_prefix connector is connecting to for dual-stack-prefix mode.
x -mode
x Mode of the procedure call.Valid options are:
x create
x modify
x delete
x -type
x The type of topology route to create.
x -mac_pools_multiplier
x Please use mac_pools_number_of_addresses insted of this argument
x -mac_pools_number_of_addresses
x This argument sets the number of mac addresses
x -mac_pools_prefix_length
x -mac_pools_use_vlans
x Flag to determine whether VLANs are enabled.
x -mac_pools_mac
x MAC addresses of the plugin
x -mac_pools_mac_step
x MAC step of the plugin
x -mac_pools_vlan_count
x Number of active VLANs. The maximum value is 2
x -mac_pools_vlan_tpid
x 16-bit Tag Protocol Identifier (TPID) or EtherType in the VLAN tag.
x -mac_pools_vlan_priority
x 3-bit user priority field in the VLAN tag.
x -mac_pools_vlan_priority_step
x 3-bit user priority step field in the VLAN tag.
x -mac_pools_vlan_id
x 12-bit VLAN ID in the VLAN tag.
x -mac_pools_vlan_id_step
x 12-bit VLAN ID step in the VLAN tag.
x -ipv6_prefix_network_address
x Network addresses of the simulated IPv6 network
x -ipv6_prefix_network_address_step
x Network addresses step of the simulated IPv6 network
x -ipv6_prefix_length
x -ipv6_prefix_address_step
x Prefix Address Step of the simulated IPv6 network
x -ipv6_prefix_number_of_addresses
x This argument sets the number of ipv6 addresses
x -ipv6_prefix_multiplier
x Please use ipv6_prefix_network_address insted of this argumen
x -ipv4_prefix_network_address
x Network addresses of the simulated IPv4 network
x -ipv4_prefix_network_address_step
x Network addresses of the simulated IPv4 network
x -ipv4_prefix_length
x -ipv4_prefix_address_step
x Prefix Address Step of the simulated IPv4 network
x -ipv4_prefix_number_of_addresses
x This argument sets the number of ipv4 addresses
x -ipv4_prefix_multiplier
x Please use ipv4_prefix_number_of_addresses insted of this argumen
x -external_link_router_source
x Index of the originating node as defined in fromNetworkTopology
x -external_link_router_destination
x Index of the target node as defined in toNetworkTopology
x -external_link_network_group_handle
x Network Topology this link is pointing to
-grid_col
Defines number of columns in a grid.
This option is valid only when -type is grid, otherwise it
is ignored. This option is available with IxTclNetwork and IxTclProtocol API.
-grid_row
Defines number of rows in a grid.
This option is valid only when -type is grid, otherwise it
is ignored.
This option is available with IxTclNetwork and IxTclProtocol API.
x -grid_include_emulated_device
x -grid_link_multiplier
x -mesh_number_of_nodes
x -mesh_include_emulated_device
x -mesh_link_multiplier
x -ring_number_of_nodes
x -ring_include_emulated_device
x -ring_link_multiplier
x -hub_spoke_include_emulated_device
x -hub_spoke_number_of_first_level
x -hub_spoke_number_of_second_level
x -hub_spoke_enable_level_2
x -hub_spoke_link_multiplier
x -tree_number_of_nodes
x -tree_include_emulated_device
x -tree_use_tree_depth
x -tree_depth
x -tree_max_children_per_node
x -tree_link_multiplier
x -custom_link_multiplier
x number of links between two nodes
x -custom_from_node_index
x -custom_to_node_index
x -fat_tree_include_emulated_device
x -fat_tree_link_multiplier
x number of links between two nodes
x -fat_tree_level_count
x Number of Levels
x -fat_tree_node_count
x Number of Nodes Per Level
x -linear_include_emulated_device
x -linear_nodes
x number of nodes
x -linear_link_multiplier
x number of links between two nodes
Return Values:
A list containing the network group protocol stack handles that were added by the command (if any).
x key:network_group_handle value:A list containing the network group protocol stack handles that were added by the command (if any).
A list containing the mac pools protocol stack handles that were added by the command (if any).
x key:mac_pools_handle value:A list containing the mac pools protocol stack handles that were added by the command (if any).
A list containing the ipv4 prefix pools protocol stack handles that were added by the command (if any).
x key:ipv4_prefix_pools_handle value:A list containing the ipv4 prefix pools protocol stack handles that were added by the command (if any).
A list containing the ipv6 prefix pools protocol stack handles that were added by the command (if any).
x key:ipv6_prefix_pools_handle value:A list containing the ipv6 prefix pools protocol stack handles that were added by the command (if any).
A list containing the simulated router protocol stack handles that were added by the command (if any).
x key:simulated_router_handle value:A list containing the simulated router protocol stack handles that were added by the command (if any).
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/network_group_config.py_part1
|
x enables/disables device.
x -connected_to_handle
x Scenario element this connector is connecting to
x -connected_to_handle_ipv4
x Scenario element IPV4_prefix connector is connecting to for dual-stack-prefix mode.
x -connected_to_handle_ipv6
x Scenario element IPV6_prefix connector is connecting to for dual-stack-prefix mode.
x -mode
x Mode of the procedure call.Valid options are:
x create
x modify
x delete
x -type
x The type of topology route to create.
x -mac_pools_multiplier
x Please use mac_pools_number_of_addresses insted of this argument
x -mac_pools_number_of_addresses
x This argument sets the number of mac addresses
x -mac_pools_prefix_length
x -mac_pools_use_vlans
x Flag to determine whether VLANs are enabled.
x -mac_pools_mac
x MAC addresses of the plugin
x -mac_pools_mac_step
x MAC step of the plugin
x -mac_pools_vlan_count
x Number of active VLANs. The maximum value is 2
x -mac_pools_vlan_tpid
x 16-bit Tag Protocol Identifier (TPID) or EtherType in the VLAN tag.
x -mac_pools_vlan_priority
x 3-bit user priority field in the VLAN tag.
x -mac_pools_vlan_priority_step
x 3-bit user priority step field in the VLAN tag.
x -mac_pools_vlan_id
x 12-bit VLAN ID in the VLAN tag.
x -mac_pools_vlan_id_step
x 12-bit VLAN ID step in the VLAN tag.
x -ipv6_prefix_network_address
x Network addresses of the simulated IPv6 network
x -ipv6_prefix_network_address_step
x Network addresses step of the simulated IPv6 network
x -ipv6_prefix_length
x -ipv6_prefix_address_step
x Prefix Address Step of the simulated IPv6 network
x -ipv6_prefix_number_of_addresses
x This argument sets the number of ipv6 addresses
x -ipv6_prefix_multiplier
x Please use ipv6_prefix_network_address insted of this argumen
x -ipv4_prefix_network_address
x Network addresses of the simulated IPv4 network
x -ipv4_prefix_network_address_step
x Network addresses of the simulated IPv4 network
x -ipv4_prefix_length
x -ipv4_prefix_address_step
x Prefix Address Step of the simulated IPv4 network
x -ipv4_prefix_number_of_addresses
x This argument sets the number of ipv4 addresses
x -ipv4_prefix_multiplier
x Please use ipv4_prefix_number_of_addresses insted of this argumen
x -external_link_router_source
x Index of the originating node as defined in fromNetworkTopology
x -external_link_router_destination
x Index of the target node as defined in toNetworkTopology
x -external_link_network_group_handle
x Network Topology this link is pointing to
-grid_col
Defines number of columns in a grid.
This option is valid only when -type is grid, otherwise it
is ignored. This option is available with IxTclNetwork and IxTclProtocol API.
-grid_row
Defines number of rows in a grid.
This option is valid only when -type is grid, otherwise it
is ignored.
This option is available with IxTclNetwork and IxTclProtocol API.
x -grid_include_emulated_device
x -grid_link_multiplier
x -mesh_number_of_nodes
x -mesh_include_emulated_device
x -mesh_link_multiplier
x -ring_number_of_nodes
x -ring_include_emulated_device
x -ring_link_multiplier
x -hub_spoke_include_emulated_device
x -hub_spoke_number_of_first_level
x -hub_spoke_number_of_second_level
x -hub_spoke_enable_level_2
x -hub_spoke_link_multiplier
x -tree_number_of_nodes
x -tree_include_emulated_device
x -tree_use_tree_depth
x -tree_depth
x -tree_max_children_per_node
x -tree_link_multiplier
x -custom_link_multiplier
x number of links between two nodes
x -custom_from_node_index
x -custom_to_node_index
x -fat_tree_include_emulated_device
x -fat_tree_link_multiplier
x number of links between two nodes
x -fat_tree_level_count
x Number of Levels
x -fat_tree_node_count
x Number of Nodes Per Level
x -linear_include_emulated_device
x -linear_nodes
x number of nodes
x -linear_link_multiplier
x number of links between two nodes
Return Values:
A list containing the network group protocol stack handles that were added by the command (if any).
x key:network_group_handle value:A list containing the network group protocol stack handles that were added by the command (if any).
A list containing the mac pools protocol stack handles that were added by the command (if any).
x key:mac_pools_handle value:A list containing the mac pools protocol stack handles that were added by the command (if any).
A list containing the ipv4 prefix pools protocol stack handles that were added by the command (if any).
x key:ipv4_prefix_pools_handle value:A list containing the ipv4 prefix pools protocol stack handles that were added by the command (if any).
A list containing the ipv6 prefix pools protocol stack handles that were added by the command (if any).
x key:ipv6_prefix_pools_handle value:A list containing the ipv6 prefix pools protocol stack handles that were added by the command (if any).
A list containing the simulated router protocol stack handles that were added by the command (if any).
x key:simulated_router_handle value:A list containing the simulated router protocol stack handles that were added by the command (if any).
A list containing the external1 protocol stack handles that were added by the command (if any).
x key:external1_handle value:A list containing the external1 protocol stack handles that were added by the command (if any).
A list containing the external2 protocol stack handles that were added by the command (if any).
x key:external2_handle value:A list containing the external2 protocol stack handles that were added by the command (if any).
A list containing the nssa protocol stack handles that were added by the command (if any).
x key:nssa_handle value:A list containing the nssa protocol stack handles that were added by the command (if any).
A list containing the stub protocol stack handles that were added by the command (if any).
x key:stub_handle value:A list containing the stub protocol stack handles that were added by the command (if any).
A list containing the summary protocol stack handles that were added by the command (if any).
x key:summary_handle value:A list containing the summary protocol stack handles that were added by the command (if any).
A list containing the sim interface ipv4 config protocol stack handles that were added by the command (if any).
x key:sim_interface_ipv4_config_handle value:A list containing the sim interface ipv4 config protocol stack handles that were added by the command (if any).
A list containing the v3 inter area protocol stack handles that were added by the command (if any).
x key:v3_inter_area_handle value:A list containing the v3 inter area protocol stack handles that were added by the command (if any).
A list containing the v3 external protocol stack handles that were added by the command (if any).
x key:v3_external_handle value:A list containing the v3 external protocol stack handles that were added by the command (if any).
A list containing the v3 intra area prefix protocol stack handles that were added by the command (if any).
x key:v3_intra_area_prefix_handle value:A list containing the v3 intra area prefix protocol stack handles that were added by the command (if any).
A list containing the v3 nssa protocol stack handles that were added by the command (if any).
x key:v3_nssa_handle value:A list containing the v3 nssa protocol stack handles that were added by the command (if any).
A list containing the v3 inter area prefix protocol stack handles that were added by the command (if any).
x key:v3_inter_area_prefix_handle value:A list containing the v3 inter area prefix protocol stack handles that were added by the command (if any).
A list containing the v3 linklsa protocol stack handles that were added by the command (if any).
x key:v3_linklsa_handle value:A list containing the v3 linklsa protocol stack handles that were added by the command (if any).
A list containing the ipv6 prefix interface protocol stack handles that were added by the command (if any).
x key:ipv6_prefix_interface_handle value:A list containing the ipv6 prefix interface protocol stack handles that were added by the command (if any).
A list containing the simulated rbridge protocol stack handles that were added by the command (if any).
x key:simulated_rbridge_handle value:A list containing the simulated rbridge protocol stack handles that were added by the command (if any).
A list containing the simulated interface ipv6 protocol stack handles that were added by the command (if any).
x key:simulated_interface_ipv6_handle value:A list containing the simulated interface ipv6 protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_inter_area_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_external_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_intra_area_prefix_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_nssa_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_inter_area_prefix_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_linklsa_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Examples:
Sample Input:
Sample Output:
Notes:
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: v3_inter_area_handles, v3_external_handles, v3_intra_area_prefix_handles, v3_nssa_handles, v3_inter_area_prefix_handles, v3_linklsa_handles
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'network_group_config',
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/network_group_config.py_part2
|
x key:simulated_router_handle value:A list containing the simulated router protocol stack handles that were added by the command (if any).
A list containing the external1 protocol stack handles that were added by the command (if any).
x key:external1_handle value:A list containing the external1 protocol stack handles that were added by the command (if any).
A list containing the external2 protocol stack handles that were added by the command (if any).
x key:external2_handle value:A list containing the external2 protocol stack handles that were added by the command (if any).
A list containing the nssa protocol stack handles that were added by the command (if any).
x key:nssa_handle value:A list containing the nssa protocol stack handles that were added by the command (if any).
A list containing the stub protocol stack handles that were added by the command (if any).
x key:stub_handle value:A list containing the stub protocol stack handles that were added by the command (if any).
A list containing the summary protocol stack handles that were added by the command (if any).
x key:summary_handle value:A list containing the summary protocol stack handles that were added by the command (if any).
A list containing the sim interface ipv4 config protocol stack handles that were added by the command (if any).
x key:sim_interface_ipv4_config_handle value:A list containing the sim interface ipv4 config protocol stack handles that were added by the command (if any).
A list containing the v3 inter area protocol stack handles that were added by the command (if any).
x key:v3_inter_area_handle value:A list containing the v3 inter area protocol stack handles that were added by the command (if any).
A list containing the v3 external protocol stack handles that were added by the command (if any).
x key:v3_external_handle value:A list containing the v3 external protocol stack handles that were added by the command (if any).
A list containing the v3 intra area prefix protocol stack handles that were added by the command (if any).
x key:v3_intra_area_prefix_handle value:A list containing the v3 intra area prefix protocol stack handles that were added by the command (if any).
A list containing the v3 nssa protocol stack handles that were added by the command (if any).
x key:v3_nssa_handle value:A list containing the v3 nssa protocol stack handles that were added by the command (if any).
A list containing the v3 inter area prefix protocol stack handles that were added by the command (if any).
x key:v3_inter_area_prefix_handle value:A list containing the v3 inter area prefix protocol stack handles that were added by the command (if any).
A list containing the v3 linklsa protocol stack handles that were added by the command (if any).
x key:v3_linklsa_handle value:A list containing the v3 linklsa protocol stack handles that were added by the command (if any).
A list containing the ipv6 prefix interface protocol stack handles that were added by the command (if any).
x key:ipv6_prefix_interface_handle value:A list containing the ipv6 prefix interface protocol stack handles that were added by the command (if any).
A list containing the simulated rbridge protocol stack handles that were added by the command (if any).
x key:simulated_rbridge_handle value:A list containing the simulated rbridge protocol stack handles that were added by the command (if any).
A list containing the simulated interface ipv6 protocol stack handles that were added by the command (if any).
x key:simulated_interface_ipv6_handle value:A list containing the simulated interface ipv6 protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_inter_area_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_external_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_intra_area_prefix_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_nssa_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_inter_area_prefix_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:v3_linklsa_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Examples:
Sample Input:
Sample Output:
Notes:
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: v3_inter_area_handles, v3_external_handles, v3_intra_area_prefix_handles, v3_nssa_handles, v3_inter_area_prefix_handles, v3_linklsa_handles
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'network_group_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/network_group_config.py_part3
|
file_params = []
try:
return self.__execute_command(
'network_group_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/network_group_config.py_part4
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def test_control(self, action, **kwargs):
r'''
#Procedure Header
Name:
test_control
Description:
This command gives more options to control the various operations for a test session.
The command can be used to start or stop any (or all) protocols configured and to apply
pending on the fly changes for NGPF protocols.
The command gives control over quick tests and also supports check_link_state.
Valid only when using IxTclNetwork (new API). Also this command is avaliable only in Ixia.
Synopsis:
test_control
-action CHOICES start_all_protocols
CHOICES stop_all_protocols
CHOICES restart_down
CHOICES start_protocol
CHOICES stop_protocol
CHOICES abort_protocol
CHOICES apply_on_the_fly_changes
CHOICES check_link_state
CHOICES get_all_qt_handles
CHOICES get_available_qt_types
CHOICES get_qt_handles_for_type
CHOICES qt_remove_test
CHOICES qt_apply_config
CHOICES qt_start
CHOICES qt_run
CHOICES qt_stop
CHOICES qt_wait_for_test
CHOICES is_done
CHOICES wait
CHOICES get_result
CHOICES qt_get_input_params
CHOICES configure_all
[-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
[-handle ANY]
[-desired_status CHOICES busy up down unassigned
DEFAULT up]
[-timeout NUMERIC
DEFAULT 60]
[-qt_handle ANY]
[-result_handle ANY]
[-qt_type ANY]
[-input_params ANY]
[-action_mode CHOICES sync async
DEFAULT sync]
[-action_on_failure CHOICES stop continue
DEFAULT continue]
[-args ANY]
[-mandatory_args ANY]
Arguments:
-action
This option specified the action to be taken based on the option provided.
-port_handle
List of ports for which to retrieve information.
Valid when -action is check_link_state
-handle
List of handles to act on.
Valid when -action is start_protocol or stop_protocol.
-desired_status
Valid when -action is check_link_state
-timeout
Numeric value used to specify the timeout.
Valid when -action is check_link_state
-qt_handle
List of handles for the quick test to perform commands
Valid with the following -action values
qt_start with -action_modesync
qt_run with -action_modesync
qt_apply_config -action_modesync
qt_remove_test
Instead of List of handles, only single handle is supported for the following -action values
qt_start with -action_modeasync
qt_run with -action_modeasync
qt_apply_config -action_modeasync
qt_stop
qt_wait_for_test
-result_handle
List of result_handles returned by previously executed asynchronous operations
Valid with the following -action values
is_done
get_result
wait
-qt_type
List of qt types for which the available test handles to be returned.
Valid when -action is get_qt_handles_for_type
-input_params
List of runtime Parameters for the quick test specified by qt_handle.
Valid with the following -action values
qt_start
qt_run
-action_mode
Valid options are:
sync- perform the operation specified in -action in synchronous mode
async- perform the operation specified in -action in asynchronous mode
(DEFAULT - sync)
Valid when -action is qt_start, qt_stop, qt_run and qt_apply_config
-action_on_failure
(DEFAULT- continue)
Valid when -action_mode sync and -action is qt_start, qt_stop, qt_run or qt_apply_config
-args
-mandatory_args
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
On status of failure, gives detailed information.
key:log value:On status of failure, gives detailed information.
up, down, unassigned, busy
key:<port_handle>.state value:up, down, unassigned, busy
List of valid handles for all quick tests available in the config.
key:qt_handle value:List of valid handles for all quick tests available in the config.
Gives detailed information about the test run.
key:<qt_handle>.log value:Gives detailed information about the test run.
$::SUCCESS | $::FAILURE
key:<qt_handle>.is_running value:$::SUCCESS | $::FAILURE
Based on the pass/fail criteria of the test execution, the values none, pass or fail will be returned.
key:<qt_handle>.result value:Based on the pass/fail criteria of the test execution, the values none, pass or fail will be returned.
The local path to the results folder for test specified in qt_handle.
key:<qt_handle>.result_path value:The local path to the results folder for test specified in qt_handle.
The result handle obtained with the -action_mode async for -action types qt_start, qt_stop, qt_run, qt_apply_config
key:<qt_handle>.result_handle value:The result handle obtained with the -action_mode async for -action types qt_start, qt_stop, qt_run, qt_apply_config
List of all supported input parameters for the test specified in qt_handle.
key:<qt_handle>.input_params value:List of all supported input parameters for the test specified in qt_handle.
$::SUCCESS | $::FAILURE, to indicate the asynchronous operation mentioned in result_handle is completed or not.
key:<result_handle>.status value:$::SUCCESS | $::FAILURE, to indicate the asynchronous operation mentioned in result_handle is completed or not.
On status of failure for a given result_handle, gives detailed information.
key:<result_handle>.log value:On status of failure for a given result_handle, gives detailed information.
Based on the pass/fail criteria of the test execution, the values none, pass or fail will be returned.
key:<result_handle>.result value:Based on the pass/fail criteria of the test execution, the values none, pass or fail will be returned.
The local path to the results folder for the test specified in qt_handle.
key:<result_handle>.result_path value:The local path to the results folder for the test specified in qt_handle.
List of all supported qt types.
key:qt_types value:List of all supported qt types.
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'test_control',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/test_control.py_part1
|
Based on the pass/fail criteria of the test execution, the values none, pass or fail will be returned.
key:<result_handle>.result value:Based on the pass/fail criteria of the test execution, the values none, pass or fail will be returned.
The local path to the results folder for the test specified in qt_handle.
key:<result_handle>.result_path value:The local path to the results folder for the test specified in qt_handle.
List of all supported qt types.
key:qt_types value:List of all supported qt types.
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'test_control',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/test_control.py_part2
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_bgp_mvpn_config(self, handle, mode, **kwargs):
r'''
#Procedure Header
Name:
emulation_bgp_mvpn_config
Description:
This procedure configures BGP mVRF neighbors, internal and/or external.
You can configure multiple BGP mVRF peers per interface by calling this
procedure multiple times.This command is also used to configure MVPN Sender
and MVPN Receiver Site. This command will be used to configure MVPN.
Synopsis:
emulation_bgp_mvpn_config
-handle ANY
-mode CHOICES disable enable create modify
x [-protocol_name ALPHA]
x [-spmsi_name ALPHA]
x [-active CHOICES 0 1
x DEFAULT 1]
[-num_sites NUMERIC]
[-target ANY]
[-target_assign NUMERIC]
[-target_type CHOICES as ip as4]
x [-import_rt_as_export_rt CHOICES 0 1]
x [-target_count NUMERIC]
x [-import_target_count NUMERIC]
[-import_target ANY]
[-import_target_assign NUMERIC]
[-import_target_type CHOICES as ip as4]
x [-include_pmsi_tunnel_attribute CHOICES 0 1]
x [-rsvp_p2mp_id IPV4]
x [-rsvp_p2mp_id_as_number NUMERIC]
x [-rsvp_tunnel_id NUMERIC]
x [-root_address IPV4]
x [-multicast_distinguisher_as4_number NUMERIC]
x [-multicast_distinguisher_as_number NUMERIC]
x [-multicast_distinguisher_assigned_number NUMERIC]
x [-multicast_distinguisher_ip_address IPV4]
x [-multicast_distinguisher_type CHOICES as ip as4]
x [-enable_trm CHOICES 0 1]
x [-advertise_impsi_routes CHOICES 0 1]
x [-mvrf_multicast_tunnel_type CHOICES tunneltypersvpp2mp
x CHOICES tunneltypemldpp2mp
x CHOICES tunneltypeingressreplication
x CHOICES tunneltypebier
x CHOICES tunneltypepimsm
x CHOICES tunneltypepimssm]
x [-group_address ANY]
x [-sender_address_p_root_node_address ANY]
x [-umh_export_target_count NUMERIC]
x [-umh_import_target_count NUMERIC]
x [-same_as_export_rt CHOICES 0 1]
x [-same_as_import_rt CHOICES 0 1]
[-umh_import_target_type CHOICES as ip as4]
[-umh_import_target ANY]
[-umh_import_target_assign NUMERIC]
[-umh_target_type CHOICES as ip as4]
[-umh_target_assign NUMERIC]
[-umh_target ANY]
x [-import_target_inner_step NUMERIC]
x [-target_inner_step NUMERIC]
x [-umh_import_target_inner_step NUMERIC]
x [-import_target_assign_inner_step NUMERIC]
x [-target_assign_inner_step NUMERIC]
x [-umh_import_target_assign_inner_step NUMERIC]
x [-umh_target_assign_inner_step NUMERIC]
x [-umh_target_inner_step NUMERIC]
x [-group_address_count NUMERIC]
x [-send_trigger_source_active_adroute CHOICES 0 1]
x [-source_address_count NUMERIC]
x [-source_group_mapping CHOICES fullymeshed onetoone]
x [-start_group_address_ipv4 IPV4]
x [-start_source_address_ipv4 IPV4]
x [-start_source_or_crp_address_ipv4 IPV4]
x [-start_source_or_crp_address_ipv6 IPV6]
x [-start_group_address_ipv6 IPV6]
x [-start_source_address_ipv6 IPV6]
x [-c_multicast_route_type CHOICES sourcetreejoin sharedtreejoin]
x [-downstream_label NUMERIC]
x [-send_triggered_multicast_route CHOICES 0 1]
x [-upstream_or_downstream_assigned_label NUMERIC]
x [-up_or_down_stream_assigned_label NUMERIC]
x [-use_up_or_down_stream_assigned_label CHOICES 0 1]
x [-spmsi_root_address IPV4]
x [-spmsi_rsvp_p2mp_id IPV4]
x [-spmsi_rsvp_p2mp_id_as_number NUMERIC]
x [-spmsi_rsvp_p2mp_id_inner_step NUMERIC]
x [-spmsi_rsvp_tunnel_id NUMERIC]
x [-spmsi_rsvp_tunnel_id_step NUMERIC]
x [-spmsi_tunnel_count NUMERIC]
x [-upstream_or_downstream_assigned_label_step NUMERIC]
x [-use_upstream_or_downstream_assigned_label_step CHOICES 0 1]
x [-include_ipv6_explicit_null_label CHOICES 0 1]
Arguments:
-handle
Valid values are:
BGP mVRF:
For create and modify -mode, handle should be its parent BGP Peer node handle.
For delete -mode, -handle should be its own handle i.e BGP mVRF node handle.
MVPN Sender Site:
For create -mode, handle should be the parent prefix pool node Handle.
For modify and delete -mode, handle should be its own handle i.e MVPN Sender Site node handle.
MVPN Receiver Site:
For create -mode, handle should be the parent prefix pool node handle.
For modify and delete -mode, handle should be its own handle i.e MVPN Receiver Site node handle.
-mode
This option defines the action to be taken on the BGP server.
x -protocol_name
x This is the name of the protocol stack as it appears in the GUI.
x -spmsi_name
x This is the name of the protocol stack as it appears in the GUI.
x -active
x Activates the item(like BGP mVRF, MVPN Sendert Sites or MVPN Receiver Sites)
-num_sites
Number of BGP mVRF to be created.
-target
AS number or IP address list based on the -target_type list.
-target_assign
The assigned number subfield of the value field of the target.It is
a number from a numbering space which is maintained by the enterprise
administers for a given IP address or ASN space.It is the local
part of the target.
-target_type
List of the target type.
x -import_rt_as_export_rt
x Import RT List Same As Export RT List
x -target_count
x Number of AS number or IP address list based on the -target_type list.
x -import_target_count
x Number of RTs in Import Route Target List
-import_target
AS number or IP address list based on the -import_target_type list.
-import_target_assign
The assigned number subfield of the value field of the import target.
It is a number from a numbering space which is maintained by the
enterprise administers for a given IP address or ASN space.It is the
local part of the import target.
-import_target_type
List of the import target type.
x -include_pmsi_tunnel_attribute
x Enable or Disable Include PMSI Tunnel Attribute.If selected, this causes the PE to include PMSI Tunnel Attribute in the Inclusive Multicast Ethernet Tag Routes containing tunnel information for ingress replication or P2MP.
x -rsvp_p2mp_id
x The P2MP Identifier represented in IP address format.
x -rsvp_p2mp_id_as_number
x The P2MP Identifier represented in integer format.
x -rsvp_tunnel_id
x This allows to select the P2MP LSP that can be used for this particular ES. An LSP is uniquely identified by P2MP-Id, Tunnel Id, and Extended Tunnel ID (Tunnel Head Address).
x -root_address
x The root address of the multicast LSP.
x -multicast_distinguisher_as4_number
x The 4-octet user-defined number that is used with the Multicast (Route) Distinguisher IP address or AS number to uniquely identify the MVRFs for this MVPN.
x -multicast_distinguisher_as_number
x If the Admin part Type is set to AS, this is the 2-byte AS number in the Administrator subfield of the Value field of the RD. If the Admin part Type was set to AS 4 Byte, this is the 4-byte AS number in the Administrator subfield of the Value field of the RD.
x -multicast_distinguisher_assigned_number
x If the Multicast (Route) Distinguisher Type is set to "AS", a 2-octet autonomous system number (for the local AS) can be configured in this field. If set to "AS 4 Byte", a 4-octet autonomous system number can be configured in this field.
x -multicast_distinguisher_ip_address
x If the Admin part Type is set to I, this is the 4-byte IP address in the Administrator sub-field of the Value field of the VPN RD.
x -multicast_distinguisher_type
x Choose the type of Route Distinguisher (RD). Options include the following:
x IP-The Administrator subfield is 4 bytes in length, and contains an IP address. (This is a Type 1 RD.)
x AS-The Administrator subfield is 2 bytes in length, and contains an Autonomous System number (ASN). (This is a Type 0 RD.)
x AS 4 Byte-The Administrator subfield is 4 bytes in length, and contains an Autonomous System number (ASN). (This is a Type 2 RD).
x -enable_trm
x Enables Tenant Routed Multicast support in EVPN.
x Upon Enabling,
x - "Advertise I-PMSI Routes" will be disabled (by default).
x - "Multicast Tunnel Type" will be "PIM-SSM" (by default).
x - "VRF Route Import Extended Community" is sent with EVPN Route Type 2 & 5 (always).
x -advertise_impsi_routes
x Enables I-PMSI Route Advertisement for MVPN (if True).
x Disables I-PMSI Route Advertisement for MVPN (if False).
x - Set to False when "Enable TRM" is Enabled (by deafult).
x -mvrf_multicast_tunnel_type
x The type of multicast tunnel to be configured. Options include the following:
x RSVP-TE P2MP: This helps to set up RSVP tunnels as P-Tunnel protocol following new draft.
x MLDP P2MP: This is described by a root address with combination of opaque value.
x Ingress Replication:This helps to setup ingress replication Tunnels as P-Tunnel Protocol for S-PMSI instances using RSVP P2P/LDP.
x BIER: When a multicast data packet enters the domain, the ingress router determines the set of egress routers to which the packets are sent. The ingress router then encapsulates the packet in a BIER header. The BIER header contains a bit string in which each bit represents exactly one egress router in the domain. To forward the packet to a given set of egress routers, the bits corresponding to those routers are set in the BIER header.
x -group_address
x Group Address
x -sender_address_p_root_node_address
x Sender Address/P-Root Node Address
x -umh_export_target_count
x Number of RTs in Export Route Target List(multiplier).
x -umh_import_target_count
x Number of RTs in Import Route Target List(multiplier).
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_bgp_mvpn_config.py_part1
|
For create and modify -mode, handle should be its parent BGP Peer node handle.
For delete -mode, -handle should be its own handle i.e BGP mVRF node handle.
MVPN Sender Site:
For create -mode, handle should be the parent prefix pool node Handle.
For modify and delete -mode, handle should be its own handle i.e MVPN Sender Site node handle.
MVPN Receiver Site:
For create -mode, handle should be the parent prefix pool node handle.
For modify and delete -mode, handle should be its own handle i.e MVPN Receiver Site node handle.
-mode
This option defines the action to be taken on the BGP server.
x -protocol_name
x This is the name of the protocol stack as it appears in the GUI.
x -spmsi_name
x This is the name of the protocol stack as it appears in the GUI.
x -active
x Activates the item(like BGP mVRF, MVPN Sendert Sites or MVPN Receiver Sites)
-num_sites
Number of BGP mVRF to be created.
-target
AS number or IP address list based on the -target_type list.
-target_assign
The assigned number subfield of the value field of the target.It is
a number from a numbering space which is maintained by the enterprise
administers for a given IP address or ASN space.It is the local
part of the target.
-target_type
List of the target type.
x -import_rt_as_export_rt
x Import RT List Same As Export RT List
x -target_count
x Number of AS number or IP address list based on the -target_type list.
x -import_target_count
x Number of RTs in Import Route Target List
-import_target
AS number or IP address list based on the -import_target_type list.
-import_target_assign
The assigned number subfield of the value field of the import target.
It is a number from a numbering space which is maintained by the
enterprise administers for a given IP address or ASN space.It is the
local part of the import target.
-import_target_type
List of the import target type.
x -include_pmsi_tunnel_attribute
x Enable or Disable Include PMSI Tunnel Attribute.If selected, this causes the PE to include PMSI Tunnel Attribute in the Inclusive Multicast Ethernet Tag Routes containing tunnel information for ingress replication or P2MP.
x -rsvp_p2mp_id
x The P2MP Identifier represented in IP address format.
x -rsvp_p2mp_id_as_number
x The P2MP Identifier represented in integer format.
x -rsvp_tunnel_id
x This allows to select the P2MP LSP that can be used for this particular ES. An LSP is uniquely identified by P2MP-Id, Tunnel Id, and Extended Tunnel ID (Tunnel Head Address).
x -root_address
x The root address of the multicast LSP.
x -multicast_distinguisher_as4_number
x The 4-octet user-defined number that is used with the Multicast (Route) Distinguisher IP address or AS number to uniquely identify the MVRFs for this MVPN.
x -multicast_distinguisher_as_number
x If the Admin part Type is set to AS, this is the 2-byte AS number in the Administrator subfield of the Value field of the RD. If the Admin part Type was set to AS 4 Byte, this is the 4-byte AS number in the Administrator subfield of the Value field of the RD.
x -multicast_distinguisher_assigned_number
x If the Multicast (Route) Distinguisher Type is set to "AS", a 2-octet autonomous system number (for the local AS) can be configured in this field. If set to "AS 4 Byte", a 4-octet autonomous system number can be configured in this field.
x -multicast_distinguisher_ip_address
x If the Admin part Type is set to I, this is the 4-byte IP address in the Administrator sub-field of the Value field of the VPN RD.
x -multicast_distinguisher_type
x Choose the type of Route Distinguisher (RD). Options include the following:
x IP-The Administrator subfield is 4 bytes in length, and contains an IP address. (This is a Type 1 RD.)
x AS-The Administrator subfield is 2 bytes in length, and contains an Autonomous System number (ASN). (This is a Type 0 RD.)
x AS 4 Byte-The Administrator subfield is 4 bytes in length, and contains an Autonomous System number (ASN). (This is a Type 2 RD).
x -enable_trm
x Enables Tenant Routed Multicast support in EVPN.
x Upon Enabling,
x - "Advertise I-PMSI Routes" will be disabled (by default).
x - "Multicast Tunnel Type" will be "PIM-SSM" (by default).
x - "VRF Route Import Extended Community" is sent with EVPN Route Type 2 & 5 (always).
x -advertise_impsi_routes
x Enables I-PMSI Route Advertisement for MVPN (if True).
x Disables I-PMSI Route Advertisement for MVPN (if False).
x - Set to False when "Enable TRM" is Enabled (by deafult).
x -mvrf_multicast_tunnel_type
x The type of multicast tunnel to be configured. Options include the following:
x RSVP-TE P2MP: This helps to set up RSVP tunnels as P-Tunnel protocol following new draft.
x MLDP P2MP: This is described by a root address with combination of opaque value.
x Ingress Replication:This helps to setup ingress replication Tunnels as P-Tunnel Protocol for S-PMSI instances using RSVP P2P/LDP.
x BIER: When a multicast data packet enters the domain, the ingress router determines the set of egress routers to which the packets are sent. The ingress router then encapsulates the packet in a BIER header. The BIER header contains a bit string in which each bit represents exactly one egress router in the domain. To forward the packet to a given set of egress routers, the bits corresponding to those routers are set in the BIER header.
x -group_address
x Group Address
x -sender_address_p_root_node_address
x Sender Address/P-Root Node Address
x -umh_export_target_count
x Number of RTs in Export Route Target List(multiplier).
x -umh_import_target_count
x Number of RTs in Import Route Target List(multiplier).
x -same_as_export_rt
x If selected, UMH Export RT List will be same as Export RT List.
x -same_as_import_rt
x If selected, UMH Import RT List will be same as Import RT List.
-umh_import_target_type
List of the import target type.
-umh_import_target
AS number or IP address list based on the -import_target_type list.
-umh_import_target_assign
The assigned number subfield of the value field of the import target.
It is a number from a numbering space which is maintained by the
enterprise administers for a given IP address or ASN space.It is the
local part of the import target.
-umh_target_type
List of the target type.
-umh_target_assign
The assigned number subfield of the value field of the target.It is
a number from a numbering space which is maintained by the enterprise
administers for a given IP address or ASN space.It is the local
part of the target.
-umh_target
AS number or IP address list based on the -target_type list.
x -import_target_inner_step
x Increment value to step the base import target field when -target_count is greater than 1.
x -target_inner_step
x Increment value to step the base import target field when -target_count is greater than 1.
x -umh_import_target_inner_step
x Increment value to step the base import target field when -target_count is greater than 1.
x -import_target_assign_inner_step
x Increment value to step the base import target assigned number field when -target_count is greater than 1.
x -target_assign_inner_step
x Increment value to step the base import target assigned number field when -target_count is greater than 1.
x -umh_import_target_assign_inner_step
x Increment value to step the base import target assigned number field when -target_count is greater than 1.
x -umh_target_assign_inner_step
x Increment value to step the base target assigned number fieldwhen -target_count is greater than 1.
x -umh_target_inner_step
x Increment value to step the base target field when -target_count is greater than 1.
x -group_address_count
x The number of group addresses to be included in the Join message/ C-Multicast route.
x -send_trigger_source_active_adroute
x If selected, allows to send the Source Active A-D Route after receiving Source Tree Join C-Multicast route.
x -source_address_count
x The number of multicast source addresses to be included. The maximum number of valid possible addresses depends on the values for the Source Address and the Source Mask Width.
x The value changes to 1 and is not available for change when the C-Multicast Route Type is Shared Tree Join/meshing is One to one.
x -source_group_mapping
x Indicates the source group mapping. Options include the following:
x Fully-Meshed, One-To-One.
x -start_group_address_ipv4
x The first IPv4 Multicast group address in the range of group addresses included in this Join message/ C-Multicast route.
x -start_source_address_ipv4
x The Start Source Address is the first IPv4 source addresses that like to send multicast traffic towards interested receivers.
x (IPv4 Multicast addresses are not valid for sources)
x -start_source_or_crp_address_ipv4
x The Start Source Address is the first IPv4 source address to be included in this Join message when C-Multicast Route Type is Source Tree Join.
x (IPv4 Multicast addresses are not valid for sources)
x The C-RP Address is the IPv4 address of C-RP when C-Multicast Route Type is Shared Tree Join.
x -start_source_or_crp_address_ipv6
x The Start Source Address is the first IPv6 source address to be included in this Join message when C-Multicast Route Type is Source Tree Join.
x The C-RP Address is the IPv6 address of C-RP when C-Multicast Route Type is Shared Tree Join.
x -start_group_address_ipv6
x The first IPv6 Multicast group address in the range of group addresses included in this Join message/ C-Multicast route.
x -start_source_address_ipv6
x The Start Source Address is the first IPv6 source addresses that like to send multicast traffic towards interested receivers.
x -c_multicast_route_type
x Choose one of the C-Multicast Route Types. Options include the following:
x Source Tree Join, Shared Tree Join.
x -downstream_label
x Downstream Assigned Label in Leaf A-D route when tunnel type is Ingress Replication
x -send_triggered_multicast_route
x This helps to send Source Tree Join C-Multicast route after receiving Source Active A-D route. This is also required by Shared Tree Join C-Multicast route to send Source Tree Join after receiving Source Active A-D Route.
x -upstream_or_downstream_assigned_label
x This label is used when Use Upstream/Downstream is selected. The PMSI Tunnel Identifier contains this label value.
x -up_or_down_stream_assigned_label
x Upstream/Downstream Assigned Label
x -use_up_or_down_stream_assigned_label
x This field indicates whether the configured upstream label or downstream label(Ingress Replication) need to be used. If not selected, MPLS Assigned Upstream/Downstream Label is unavailable.
x -spmsi_root_address
x The root address of the multicast tunnel type. This field is available when Multicast Tunnel Type is mLDP P2MP.
x -spmsi_rsvp_p2mp_id
x The P2MP ID represented in IP address format. This field is available when Multicast Tunnel Type is RSVP-TE P2MP.
x -spmsi_rsvp_p2mp_id_as_number
x The P2MP ID represented in integer format. This field is available when Multicast Tunnel Type is RSVP-TE P2MP.
x -spmsi_rsvp_p2mp_id_inner_step
x The increment value in the range of RSVP P2MP IDs for that S-PMSI range. This field is available when Multicast Tunnel Type is RSVP-TE P2MP.
x -spmsi_rsvp_tunnel_id
x The first Tunnel ID value in the range of Tunnel IDs. This field is available when Multicast Tunnel Type is RSVP-TE P2MP.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_bgp_mvpn_config.py_part2
|
x Number of RTs in Import Route Target List(multiplier).
x -same_as_export_rt
x If selected, UMH Export RT List will be same as Export RT List.
x -same_as_import_rt
x If selected, UMH Import RT List will be same as Import RT List.
-umh_import_target_type
List of the import target type.
-umh_import_target
AS number or IP address list based on the -import_target_type list.
-umh_import_target_assign
The assigned number subfield of the value field of the import target.
It is a number from a numbering space which is maintained by the
enterprise administers for a given IP address or ASN space.It is the
local part of the import target.
-umh_target_type
List of the target type.
-umh_target_assign
The assigned number subfield of the value field of the target.It is
a number from a numbering space which is maintained by the enterprise
administers for a given IP address or ASN space.It is the local
part of the target.
-umh_target
AS number or IP address list based on the -target_type list.
x -import_target_inner_step
x Increment value to step the base import target field when -target_count is greater than 1.
x -target_inner_step
x Increment value to step the base import target field when -target_count is greater than 1.
x -umh_import_target_inner_step
x Increment value to step the base import target field when -target_count is greater than 1.
x -import_target_assign_inner_step
x Increment value to step the base import target assigned number field when -target_count is greater than 1.
x -target_assign_inner_step
x Increment value to step the base import target assigned number field when -target_count is greater than 1.
x -umh_import_target_assign_inner_step
x Increment value to step the base import target assigned number field when -target_count is greater than 1.
x -umh_target_assign_inner_step
x Increment value to step the base target assigned number fieldwhen -target_count is greater than 1.
x -umh_target_inner_step
x Increment value to step the base target field when -target_count is greater than 1.
x -group_address_count
x The number of group addresses to be included in the Join message/ C-Multicast route.
x -send_trigger_source_active_adroute
x If selected, allows to send the Source Active A-D Route after receiving Source Tree Join C-Multicast route.
x -source_address_count
x The number of multicast source addresses to be included. The maximum number of valid possible addresses depends on the values for the Source Address and the Source Mask Width.
x The value changes to 1 and is not available for change when the C-Multicast Route Type is Shared Tree Join/meshing is One to one.
x -source_group_mapping
x Indicates the source group mapping. Options include the following:
x Fully-Meshed, One-To-One.
x -start_group_address_ipv4
x The first IPv4 Multicast group address in the range of group addresses included in this Join message/ C-Multicast route.
x -start_source_address_ipv4
x The Start Source Address is the first IPv4 source addresses that like to send multicast traffic towards interested receivers.
x (IPv4 Multicast addresses are not valid for sources)
x -start_source_or_crp_address_ipv4
x The Start Source Address is the first IPv4 source address to be included in this Join message when C-Multicast Route Type is Source Tree Join.
x (IPv4 Multicast addresses are not valid for sources)
x The C-RP Address is the IPv4 address of C-RP when C-Multicast Route Type is Shared Tree Join.
x -start_source_or_crp_address_ipv6
x The Start Source Address is the first IPv6 source address to be included in this Join message when C-Multicast Route Type is Source Tree Join.
x The C-RP Address is the IPv6 address of C-RP when C-Multicast Route Type is Shared Tree Join.
x -start_group_address_ipv6
x The first IPv6 Multicast group address in the range of group addresses included in this Join message/ C-Multicast route.
x -start_source_address_ipv6
x The Start Source Address is the first IPv6 source addresses that like to send multicast traffic towards interested receivers.
x -c_multicast_route_type
x Choose one of the C-Multicast Route Types. Options include the following:
x Source Tree Join, Shared Tree Join.
x -downstream_label
x Downstream Assigned Label in Leaf A-D route when tunnel type is Ingress Replication
x -send_triggered_multicast_route
x This helps to send Source Tree Join C-Multicast route after receiving Source Active A-D route. This is also required by Shared Tree Join C-Multicast route to send Source Tree Join after receiving Source Active A-D Route.
x -upstream_or_downstream_assigned_label
x This label is used when Use Upstream/Downstream is selected. The PMSI Tunnel Identifier contains this label value.
x -up_or_down_stream_assigned_label
x Upstream/Downstream Assigned Label
x -use_up_or_down_stream_assigned_label
x This field indicates whether the configured upstream label or downstream label(Ingress Replication) need to be used. If not selected, MPLS Assigned Upstream/Downstream Label is unavailable.
x -spmsi_root_address
x The root address of the multicast tunnel type. This field is available when Multicast Tunnel Type is mLDP P2MP.
x -spmsi_rsvp_p2mp_id
x The P2MP ID represented in IP address format. This field is available when Multicast Tunnel Type is RSVP-TE P2MP.
x -spmsi_rsvp_p2mp_id_as_number
x The P2MP ID represented in integer format. This field is available when Multicast Tunnel Type is RSVP-TE P2MP.
x -spmsi_rsvp_p2mp_id_inner_step
x The increment value in the range of RSVP P2MP IDs for that S-PMSI range. This field is available when Multicast Tunnel Type is RSVP-TE P2MP.
x -spmsi_rsvp_tunnel_id
x The first Tunnel ID value in the range of Tunnel IDs. This field is available when Multicast Tunnel Type is RSVP-TE P2MP.
x -spmsi_rsvp_tunnel_id_step
x The increment value in the range of Tunnel IDs for that S-PMSI range. This field is available when Multicast Tunnel Type is RSVP-TE P2MP.
x -spmsi_tunnel_count
x The total count of the S-PMSI Tunnel Count.
x -upstream_or_downstream_assigned_label_step
x This helps to assign unique upstream assigned label for each flow. This is applicable only if Use Upstream Assigned Label is selected.
x -use_upstream_or_downstream_assigned_label_step
x Indicates whether the configured upstream label or downstream label(Ingress Replication) need to be used. Except for BIER as Multicast Tunnel Type, if not selected, MPLS Assigned Upstream/Downstream Label is unavailable.
x -include_ipv6_explicit_null_label
x If selected, allows to include Explicit NULL label (2) in I-PMSI IPv6 PE-to-CE Traffic.
Return Values:
A list containing the network group protocol stack handles that were added by the command (if any).
x key:network_group_handle value:A list containing the network group protocol stack handles that were added by the command (if any).
A list containing the bgp mvrf protocol stack handles that were added by the command (if any).
x key:bgp_mvrf value:A list containing the bgp mvrf protocol stack handles that were added by the command (if any).
A list containing the mvpn receiver site v4 protocol stack handles that were added by the command (if any).
x key:mvpn_receiver_site_v4 value:A list containing the mvpn receiver site v4 protocol stack handles that were added by the command (if any).
A list containing the mvpn sender site v4 protocol stack handles that were added by the command (if any).
x key:mvpn_sender_site_v4 value:A list containing the mvpn sender site v4 protocol stack handles that were added by the command (if any).
A list containing the mvpn sender site spmsi v4 protocol stack handles that were added by the command (if any).
x key:mvpn_sender_site_spmsi_v4 value:A list containing the mvpn sender site spmsi v4 protocol stack handles that were added by the command (if any).
A list containing the mvpn receiver site v6 protocol stack handles that were added by the command (if any).
x key:mvpn_receiver_site_v6 value:A list containing the mvpn receiver site v6 protocol stack handles that were added by the command (if any).
A list containing the mvpn sender site v6 protocol stack handles that were added by the command (if any).
x key:mvpn_sender_site_v6 value:A list containing the mvpn sender site v6 protocol stack handles that were added by the command (if any).
A list containing the mvpn sender site spmsi v6 protocol stack handles that were added by the command (if any).
x key:mvpn_sender_site_spmsi_v6 value:A list containing the mvpn sender site spmsi v6 protocol stack handles that were added by the command (if any).
Examples:
Sample Input:
Sample Output:
Notes:
Coded versus functional specification.
1) You can configure multiple BGP mVRF on each Ixia interface.
2) You can configure multiple MVPN(MVN Sender and Receiver Sites).
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_bgp_mvpn_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_bgp_mvpn_config.py_part3
|
x -spmsi_rsvp_tunnel_id_step
x The increment value in the range of Tunnel IDs for that S-PMSI range. This field is available when Multicast Tunnel Type is RSVP-TE P2MP.
x -spmsi_tunnel_count
x The total count of the S-PMSI Tunnel Count.
x -upstream_or_downstream_assigned_label_step
x This helps to assign unique upstream assigned label for each flow. This is applicable only if Use Upstream Assigned Label is selected.
x -use_upstream_or_downstream_assigned_label_step
x Indicates whether the configured upstream label or downstream label(Ingress Replication) need to be used. Except for BIER as Multicast Tunnel Type, if not selected, MPLS Assigned Upstream/Downstream Label is unavailable.
x -include_ipv6_explicit_null_label
x If selected, allows to include Explicit NULL label (2) in I-PMSI IPv6 PE-to-CE Traffic.
Return Values:
A list containing the network group protocol stack handles that were added by the command (if any).
x key:network_group_handle value:A list containing the network group protocol stack handles that were added by the command (if any).
A list containing the bgp mvrf protocol stack handles that were added by the command (if any).
x key:bgp_mvrf value:A list containing the bgp mvrf protocol stack handles that were added by the command (if any).
A list containing the mvpn receiver site v4 protocol stack handles that were added by the command (if any).
x key:mvpn_receiver_site_v4 value:A list containing the mvpn receiver site v4 protocol stack handles that were added by the command (if any).
A list containing the mvpn sender site v4 protocol stack handles that were added by the command (if any).
x key:mvpn_sender_site_v4 value:A list containing the mvpn sender site v4 protocol stack handles that were added by the command (if any).
A list containing the mvpn sender site spmsi v4 protocol stack handles that were added by the command (if any).
x key:mvpn_sender_site_spmsi_v4 value:A list containing the mvpn sender site spmsi v4 protocol stack handles that were added by the command (if any).
A list containing the mvpn receiver site v6 protocol stack handles that were added by the command (if any).
x key:mvpn_receiver_site_v6 value:A list containing the mvpn receiver site v6 protocol stack handles that were added by the command (if any).
A list containing the mvpn sender site v6 protocol stack handles that were added by the command (if any).
x key:mvpn_sender_site_v6 value:A list containing the mvpn sender site v6 protocol stack handles that were added by the command (if any).
A list containing the mvpn sender site spmsi v6 protocol stack handles that were added by the command (if any).
x key:mvpn_sender_site_spmsi_v6 value:A list containing the mvpn sender site spmsi v6 protocol stack handles that were added by the command (if any).
Examples:
Sample Input:
Sample Output:
Notes:
Coded versus functional specification.
1) You can configure multiple BGP mVRF on each Ixia interface.
2) You can configure multiple MVPN(MVN Sender and Receiver Sites).
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_bgp_mvpn_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_bgp_mvpn_config.py_part4
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_lacp_control(self, mode, **kwargs):
r'''
#Procedure Header
Name:
emulation_lacp_control
Description:
Control Operation on the LACP/Static LAG Protocol
The following operations are done:
1. Restart
2. Send Marker Request
3. Start
4. Start PDU
5. Stop
6. Stop PDU
Synopsis:
emulation_lacp_control
-mode CHOICES restart
CHOICES send_marker_req
CHOICES start
CHOICES restart_down
CHOICES start_pdu
CHOICES stop
CHOICES stop_pdu
CHOICES abort
[-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
[-handle ANY]
[-session_type CHOICES lacp staticLag
DEFAULT lacp]
Arguments:
-mode
What is being done to the protocol.Valid choices are:
restart - Restart the protocol.
start- Start the protocol.
stop- Stop the protocol.
start_pdu- start_pdu the protocol.
stop_pdu- stop_pdu the protocol.
send_marker_req- send_marker_req the protocol.
-port_handle
The port on which to perform action.
-handle
-session_type
The LACP to be emulated. CHOICES: lacp staticLag.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
If status is failure, detailed information provided.
key:log value:If status is failure, detailed information provided.
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_lacp_control',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_lacp_control.py_part1
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_netconf_server_config(self, mode, **kwargs):
r'''
#Procedure Header
Name:
emulation_netconf_server_config
Description:
This procedure will add and configure Netconf Server to a particular Ixia Interface.
Synopsis:
emulation_netconf_server_config
-mode CHOICES create
CHOICES delete
CHOICES modify
CHOICES enable
CHOICES disable
[-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
[-handle ANY]
x [-netconf_server_active ANY]
x [-netconf_server_name ALPHA]
x [-multiplier NUMERIC]
x [-client_ipv4_address ANY]
x [-client_ipv4_address_step ANY]
x [-port_number ANY]
x [-include_rx_timestamp_in_reply_msg ANY]
x [-capabilities_base1_dot0 ANY]
x [-capabilities_base1_dot1 ANY]
x [-capabilities_writable_running ANY]
x [-capabilities_candidate ANY]
x [-capabilities_rollback_on_error ANY]
x [-capabilities_startup ANY]
x [-capabilities_url ANY]
x [-capabilities_xpath ANY]
x [-capabilities_confirmed_commit ANY]
x [-capabilities_validate ANY]
x [-capabilities_notification ANY]
x [-capabilities_interleave ANY]
x [-ssh_authentication_mechanism CHOICES noauthentication
x CHOICES usernamepassword
x CHOICES keybased]
x [-user_name ALPHA]
x [-password ALPHA]
x [-public_key_directory ALPHA]
x [-public_key_file_name ALPHA]
x [-output_directory ALPHA]
x [-decrypted_capture ANY]
x [-error_percentage ANY]
x [-error_type CHOICES transport
x CHOICES rpc
x CHOICES protocol
x CHOICES application]
x [-error_tag CHOICES inuse
x CHOICES invalidvalue
x CHOICES toobig
x CHOICES missingattribute
x CHOICES badattribute
x CHOICES unknownattribute
x CHOICES missingelement
x CHOICES badelement
x CHOICES unknownelement
x CHOICES unknownnamespace
x CHOICES accessdenied
x CHOICES lockdenied
x CHOICES resourcedenied
x CHOICES rollbackfailed
x CHOICES dataexists
x CHOICES datamissing
x CHOICES operationnotsupported
x CHOICES operationfailed
x CHOICES partialoperation
x CHOICES malformedmessage]
x [-error_severity CHOICES error warning]
x [-include_error_info ANY]
x [-error_info ALPHA]
x [-send_ok_response ANY]
x [-response_xml_directory ALPHA]
x [-get_config_reply_xml ALPHA]
Arguments:
-mode
This option defines whether to Create/Modify/Delete/Enable/Disable Netconf Server.
-port_handle
Port handle.
-handle
Specifies the parent node handle ( For ex : IP stack output of interface_config) on which the Netconf server is configured with create -mode.
The Netconf server handle(s) are returned by the procedure "emulation_netconf_server_config" when configuring Netconf server on the Ixia interface.
For modify/delete -mode, -handle can be Netconf Server's node handle.
For enable/disable -mode, -handle can be Netconf Server's node handle or session(item) handle of the node.
x -netconf_server_active
x Activate/Deactivate Configuration
x -netconf_server_name
x Name of NGPF element, guaranteed to be unique in Scenario
x -multiplier
x Number of layer instances per parent instance (multiplier)
x -client_ipv4_address
x Specify the IPv4 address of the Netconf Client which will connect with this Server.
x -client_ipv4_address_step
x Step argument of Client IPv4 address
x -port_number
x The TCP Port Number the Netconf Server is listening on to which to connect.
x -include_rx_timestamp_in_reply_msg
x This specifies whether timestamp of received request messages will be included in the replies.
x -capabilities_base1_dot0
x Whether base1.0 support should be advertised in Capabilities.
x -capabilities_base1_dot1
x Whether base1.1 support should be advertised in Capabilities.
x -capabilities_writable_running
x Whether supports capability writable-running to directly modify running config.
x -capabilities_candidate
x Whether supports capability candidate to make changes into an intermediate candidate database. Normally this is preferred over writable-running.
x -capabilities_rollback_on_error
x Whether supports capability rollback to rollback partial changes make changes on detection of error during validate or commit.
x -capabilities_startup
x Whether supports capability startup to make changes in config persistent on device restart.
x -capabilities_url
x Whether supports capability url to specify netconf commands using url.
x -capabilities_xpath
x Whether supports capability xpath to specify netconf commands and filters using xpath extensions.
x -capabilities_confirmed_commit
x Whether supports capability confirmed-commit to specify ability to commit a group of commands or none as a batch.
x -capabilities_validate
x Whether supports capability validate to specify ability to validate a netconf command prior to commit.
x -capabilities_notification
x Whether supports capability notification to aynchronously send notifications to Netconf client.
x -capabilities_interleave
x Whether supports capability interleave to interleave notifications and responses.
x -ssh_authentication_mechanism
x The authentication mechanism for connecting to Netconf Client.
x -user_name
x Username for Username/Password mode and Username for Key-Based authentication mode if applicable.
x -password
x Password for Username/Password mode.
x -public_key_directory
x Directory containing public key file for this session
x -public_key_file_name
x File containing public key (e.g. generated using ssh_keygen). For multiple server rows and assymetric public key filenames
x ( which cannot be expressed easily as a pattern) please explore "File" option in Master Row Pattern Editor by putting the file names
x in a .csv and pulling those values into the column cells.
x -output_directory
x Location of Directory in Client where the decrypted capture, if enabled, and server replies, if enabled,will be stored.
x -decrypted_capture
x Whether SSH packets for this session will be captured and stored on client in decrypted form.
x Note that this is not linked to IxNetwork control or data capture which will capture the packets in encrypted format only.
x The Decrypted Capture can be viewed by either doing right-click on a client where this option is enabled and doing "Get Decrypted Capture"
x ( allowed on 5 clients at a time ; each of the captures will be opened in a new Wireshark pop-up) OR by stopping the client and then directly
x opening it from the configured Output Directory from inside the current run folder/capture.
x This option can be enabled even when a session is already up in which case the capture will be started from that point of time.
x -error_percentage
x The percentage of requests whose response will be errors.
x -error_type
x Defines the conceptual layer on which the error occurred.
x -error_tag
x Contains a string identifying the error condition.
x -error_severity
x Contains a string identifying the error severity, as determined by the device.
x -include_error_info
x This specifies whether 'error-info' element should be included in rpc error messages.
x -error_info
x Contains protocol or data-model-specific error content.
x -send_ok_response
x This specifies whether <ok> element should be sent in <rpc-reply> in response to <get-config> requests. If this is unchecked, custom reply based on <get-config> response xml will be sent out.
x -response_xml_directory
x Directory where Reply XMLs for <get-config> operations are present.
x -get_config_reply_xml
x File containing the response to a <get-config> request.
Return Values:
A list containing the ipv4 loopback protocol stack handles that were added by the command (if any).
x key:ipv4_loopback_handle value:A list containing the ipv4 loopback protocol stack handles that were added by the command (if any).
A list containing the ipv4 protocol stack handles that were added by the command (if any).
x key:ipv4_handle value:A list containing the ipv4 protocol stack handles that were added by the command (if any).
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
When status is $::FAILURE, log shows the detailed information of failure.
key:log value:When status is $::FAILURE, log shows the detailed information of failure.
Handle of Netconf Server configured
key:netconf_server_handle value:Handle of Netconf Server configured
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_netconf_server_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_netconf_server_config.py_part1
|
x -ssh_authentication_mechanism
x The authentication mechanism for connecting to Netconf Client.
x -user_name
x Username for Username/Password mode and Username for Key-Based authentication mode if applicable.
x -password
x Password for Username/Password mode.
x -public_key_directory
x Directory containing public key file for this session
x -public_key_file_name
x File containing public key (e.g. generated using ssh_keygen). For multiple server rows and assymetric public key filenames
x ( which cannot be expressed easily as a pattern) please explore "File" option in Master Row Pattern Editor by putting the file names
x in a .csv and pulling those values into the column cells.
x -output_directory
x Location of Directory in Client where the decrypted capture, if enabled, and server replies, if enabled,will be stored.
x -decrypted_capture
x Whether SSH packets for this session will be captured and stored on client in decrypted form.
x Note that this is not linked to IxNetwork control or data capture which will capture the packets in encrypted format only.
x The Decrypted Capture can be viewed by either doing right-click on a client where this option is enabled and doing "Get Decrypted Capture"
x ( allowed on 5 clients at a time ; each of the captures will be opened in a new Wireshark pop-up) OR by stopping the client and then directly
x opening it from the configured Output Directory from inside the current run folder/capture.
x This option can be enabled even when a session is already up in which case the capture will be started from that point of time.
x -error_percentage
x The percentage of requests whose response will be errors.
x -error_type
x Defines the conceptual layer on which the error occurred.
x -error_tag
x Contains a string identifying the error condition.
x -error_severity
x Contains a string identifying the error severity, as determined by the device.
x -include_error_info
x This specifies whether 'error-info' element should be included in rpc error messages.
x -error_info
x Contains protocol or data-model-specific error content.
x -send_ok_response
x This specifies whether <ok> element should be sent in <rpc-reply> in response to <get-config> requests. If this is unchecked, custom reply based on <get-config> response xml will be sent out.
x -response_xml_directory
x Directory where Reply XMLs for <get-config> operations are present.
x -get_config_reply_xml
x File containing the response to a <get-config> request.
Return Values:
A list containing the ipv4 loopback protocol stack handles that were added by the command (if any).
x key:ipv4_loopback_handle value:A list containing the ipv4 loopback protocol stack handles that were added by the command (if any).
A list containing the ipv4 protocol stack handles that were added by the command (if any).
x key:ipv4_handle value:A list containing the ipv4 protocol stack handles that were added by the command (if any).
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
When status is $::FAILURE, log shows the detailed information of failure.
key:log value:When status is $::FAILURE, log shows the detailed information of failure.
Handle of Netconf Server configured
key:netconf_server_handle value:Handle of Netconf Server configured
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_netconf_server_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_netconf_server_config.py_part2
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_ospf_config(self, **kwargs):
r'''
#Procedure Header
Name:
emulation_ospf_config
Description:
This procedure is used to add, enable, disable, modify, and delete one or more emulated Open Shortest Path First (OSPF) routers to a particular Ixia Interface. The user can then configure OSPF routes by using the procedure "emulation_ospf_route_config".
Synopsis:
emulation_ospf_config
[-handle ANY]
x [-return_detailed_handles CHOICES 0 1
x DEFAULT 0]
[-area_id IPV4
DEFAULT 0.0.0.0]
[-area_id_step IPV4]
x [-area_id_as_number NUMERIC]
x [-area_id_as_number_step NUMERIC]
x [-area_id_type CHOICES number
x CHOICES ip
x CHOICES area_id_as_number
x CHOICES area_id_as_ip
x DEFAULT ip]
n [-area_type ANY]
[-authentication_mode CHOICES null simple md5]
[-count RANGE 1-2000
DEFAULT 1]
[-dead_interval RANGE 1-65535]
[-demand_circuit CHOICES 0 1
DEFAULT 0]
n [-enable_support_rfc_5838 ANY]
[-graceful_restart_enable CHOICES 0 1]
[-hello_interval RANGE 1-65535]
n [-ignore_db_desc_mtu ANY]
x [-router_interface_active CHOICES 0 1]
x [-enable_fast_hello CHOICES 0 1]
x [-hello_multiplier NUMERIC]
x [-max_mtu NUMERIC]
x [-protocol_name ALPHA]
x [-router_active CHOICES 0 1]
x [-router_asbr CHOICES 0 1
x DEFAULT 0]
x [-do_not_generate_router_lsa CHOICES 0 1]
x [-router_abr CHOICES 0 1
x DEFAULT 0]
x [-inter_flood_lsupdate_burst_gap NUMERIC]
x [-lsa_refresh_time NUMERIC]
x [-lsa_retransmit_time NUMERIC]
x [-max_ls_updates_per_burst NUMERIC]
x [-oob_resync_breakout CHOICES 0 1]
[-interface_cost RANGE 0-4294967295]
[-intf_ip_addr IP]
[-intf_ip_addr_step IP
DEFAULT 0.0.1.0]
[-intf_prefix_length RANGE 1-128
DEFAULT 24]
x [-interface_handle ANY]
[-instance_id RANGE 0-255
DEFAULT 0]
[-instance_id_step RANGE 0-255
DEFAULT 0]
[-loopback_ip_addr IP
DEFAULT 0.0.0.0]
[-loopback_ip_addr_step IP
DEFAULT 0.0.0.0]
[-lsa_discard_mode CHOICES 0 1]
x [-mac_address_init MAC]
x [-mac_address_step MAC
x DEFAULT 0000.0000.0001]
[-md5_key ALPHA]
[-md5_key_id RANGE 0-255]
[-mtu RANGE 68-14000]
[-network_type CHOICES broadcast ptomp ptop]
[-neighbor_intf_ip_addr IP
DEFAULT 0.0.0.0]
[-neighbor_intf_ip_addr_step IP
DEFAULT 0.0.0.0]
[-neighbor_router_id IPV4]
[-neighbor_router_id_step IPV4
DEFAULT 0.0.1.0]
[-option_bits ANY]
x [-type_of_service_routing CHOICES 0 1]
x [-external_capabilities CHOICES 0 1]
x [-multicast_capability CHOICES 0 1]
x [-nssa_capability CHOICES 0 1]
x [-external_attribute CHOICES 0 1]
x [-opaque_lsa_forwarded CHOICES 0 1]
x [-unused CHOICES 0 1]
x [-override_existence_check CHOICES 0 1
x DEFAULT 0]
x [-override_tracking CHOICES 0 1
x DEFAULT 0]
[-password ALPHA]
x [-reset FLAG]
[-router_id IPV4]
[-router_id_step IPV4
DEFAULT 0.0.1.0]
[-router_priority RANGE 0-255]
x [-no_of_te_profile NUMERIC]
[-te_enable CHOICES 0 1]
[-te_max_bw REGEXP ^[0-9]+]
[-te_max_resv_bw REGEXP ^[0-9]+$]
[-te_unresv_bw_priority0 REGEXP ^[0-9]+$]
[-te_unresv_bw_priority1 REGEXP ^[0-9]+$]
[-te_unresv_bw_priority2 REGEXP ^[0-9]+$]
[-te_unresv_bw_priority3 REGEXP ^[0-9]+$]
[-te_unresv_bw_priority4 REGEXP ^[0-9]+$]
[-te_unresv_bw_priority5 REGEXP ^[0-9]+$]
[-te_unresv_bw_priority6 REGEXP ^[0-9]+$]
[-te_unresv_bw_priority7 REGEXP ^[0-9]+$]
[-te_metric RANGE 0-2147483647]
[-te_admin_group HEX]
x [-advertise_ext_admin_group CHOICES 0 1]
x [-ext_admin_group_length RANGE 1-5
x DEFAULT 1]
x [-ext_admin_group HEX]
n [-te_router_id ANY]
x [-vlan CHOICES 0 1]
[-vlan_id_mode CHOICES fixed increment
DEFAULT increment]
[-vlan_id RANGE 0-4096]
[-vlan_id_step RANGE 0-4096
DEFAULT 1]
[-vlan_user_priority RANGE 0-7
DEFAULT 0]
n [-atm_encapsulation ANY]
x [-bfd_registration CHOICES 0 1
x DEFAULT 0]
x [-enable_dr_bdr CHOICES 0 1
x DEFAULT 0]
n [-vci ANY]
n [-vci_step ANY]
n [-vpi ANY]
n [-vpi_step ANY]
n [-get_next_session_mode ANY]
n [-no_write ANY]
x [-validate_received_mtu CHOICES 0 1
x DEFAULT 1]
[-graceful_restart_helper_mode_enable CHOICES 0 1
DEFAULT 0]
[-strict_lsa_checking CHOICES 0 1
DEFAULT 1]
[-support_reason_sw_restart CHOICES 0 1
DEFAULT 1]
[-support_reason_sw_reload_or_upgrade CHOICES 0 1
DEFAULT 1]
[-support_reason_switch_to_redundant_processor_control CHOICES 0 1
DEFAULT 1]
[-support_reason_unknown CHOICES 0 1
DEFAULT 0]
[-mode CHOICES create
CHOICES delete
CHOICES modify
CHOICES enable
CHOICES disable
DEFAULT create]
[-session_type CHOICES ospfv2 ospfv3
DEFAULT ospfv2]
n [-graceful_restart_restarting_mode_enable ANY]
n [-grace_period ANY]
n [-restart_reason ANY]
n [-number_of_restarts ANY]
n [-restart_start_time ANY]
n [-restart_down_time ANY]
n [-restart_up_time ANY]
x [-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
x [-rate_control_interval NUMERIC]
x [-flood_lsupdates_per_interval NUMERIC]
x [-attempt_scale_mode CHOICES port device_group
x DEFAULT port]
x [-attempt_rate RANGE 1-10000]
x [-attempt_interval NUMERIC]
x [-attempt_enabled CHOICES 0 1]
x [-disconnect_scale_mode CHOICES port device_group
x DEFAULT port]
x [-disconnect_rate RANGE 1-10000]
x [-disconnect_interval NUMERIC]
x [-disconnect_enabled CHOICES 0 1]
n [-gre_checksum ANY]
n [-gre_local_ip ANY]
n [-gre_remote_ip ANY]
n [-gre_tunnel ANY]
n [-host_route ANY]
n [-int_msg_exchange ANY]
n [-lsa_retransmit_delay ANY]
n [-max_lsas_per_pkt ANY]
n [-neighbor_dr_eligibility ANY]
n [-poll_interval ANY]
n [-transmit_delay ANY]
n [-vlan_cfi ANY]
x [-link_metric RANGE 0-4294967295
x DEFAULT 0]
x [-enable_ignore_db_desc_mtu CHOICES 0 1
x DEFAULT 0]
x [-router_bit CHOICES 0 1
x DEFAULT 0]
x [-v6 CHOICES 0 1
x DEFAULT 0]
x [-disable_auto_generate_link_lsa ANY]
x [-ospfv3_lsa_flood_rate_control ANY
x DEFAULT 1]
x [-intf_ipv6_addr IPV6]
x [-intf_ipv6_addr_step IPV6]
x [-ipv6_gateway_ip IPV6]
x [-ipv6_gateway_ip_step IPV6]
x [-intf_ipv6_prefix_length RANGE 1-128
x DEFAULT 64]
x [-enable_segment_routing CHOICES 0 1]
x [-configure_s_i_d_index_label ANY]
x [-configure_sid_index_label ANY]
x [-sid_index_label ANY]
x [-algorithm ANY]
x [-np_flag ANY]
x [-m_flag ANY]
x [-e_flag ANY]
x [-v_flag ANY]
x [-adj_sid_v_flag ANY]
x [-l_flag ANY]
x [-adj_sid_l_flag ANY]
x [-no_of_addiotnal_algo_sid_count RANGE 0-128
x DEFAULT 0]
x [-advertise_fapm CHOICES 0 1]
x [-fapm_metric NUMERIC]
x [-srgb_range_count NUMERIC]
x [-s_r_algorithm_count NUMERIC]
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_config.py_part1
|
[-te_unresv_bw_priority5 REGEXP ^[0-9]+$]
[-te_unresv_bw_priority6 REGEXP ^[0-9]+$]
[-te_unresv_bw_priority7 REGEXP ^[0-9]+$]
[-te_metric RANGE 0-2147483647]
[-te_admin_group HEX]
x [-advertise_ext_admin_group CHOICES 0 1]
x [-ext_admin_group_length RANGE 1-5
x DEFAULT 1]
x [-ext_admin_group HEX]
n [-te_router_id ANY]
x [-vlan CHOICES 0 1]
[-vlan_id_mode CHOICES fixed increment
DEFAULT increment]
[-vlan_id RANGE 0-4096]
[-vlan_id_step RANGE 0-4096
DEFAULT 1]
[-vlan_user_priority RANGE 0-7
DEFAULT 0]
n [-atm_encapsulation ANY]
x [-bfd_registration CHOICES 0 1
x DEFAULT 0]
x [-enable_dr_bdr CHOICES 0 1
x DEFAULT 0]
n [-vci ANY]
n [-vci_step ANY]
n [-vpi ANY]
n [-vpi_step ANY]
n [-get_next_session_mode ANY]
n [-no_write ANY]
x [-validate_received_mtu CHOICES 0 1
x DEFAULT 1]
[-graceful_restart_helper_mode_enable CHOICES 0 1
DEFAULT 0]
[-strict_lsa_checking CHOICES 0 1
DEFAULT 1]
[-support_reason_sw_restart CHOICES 0 1
DEFAULT 1]
[-support_reason_sw_reload_or_upgrade CHOICES 0 1
DEFAULT 1]
[-support_reason_switch_to_redundant_processor_control CHOICES 0 1
DEFAULT 1]
[-support_reason_unknown CHOICES 0 1
DEFAULT 0]
[-mode CHOICES create
CHOICES delete
CHOICES modify
CHOICES enable
CHOICES disable
DEFAULT create]
[-session_type CHOICES ospfv2 ospfv3
DEFAULT ospfv2]
n [-graceful_restart_restarting_mode_enable ANY]
n [-grace_period ANY]
n [-restart_reason ANY]
n [-number_of_restarts ANY]
n [-restart_start_time ANY]
n [-restart_down_time ANY]
n [-restart_up_time ANY]
x [-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
x [-rate_control_interval NUMERIC]
x [-flood_lsupdates_per_interval NUMERIC]
x [-attempt_scale_mode CHOICES port device_group
x DEFAULT port]
x [-attempt_rate RANGE 1-10000]
x [-attempt_interval NUMERIC]
x [-attempt_enabled CHOICES 0 1]
x [-disconnect_scale_mode CHOICES port device_group
x DEFAULT port]
x [-disconnect_rate RANGE 1-10000]
x [-disconnect_interval NUMERIC]
x [-disconnect_enabled CHOICES 0 1]
n [-gre_checksum ANY]
n [-gre_local_ip ANY]
n [-gre_remote_ip ANY]
n [-gre_tunnel ANY]
n [-host_route ANY]
n [-int_msg_exchange ANY]
n [-lsa_retransmit_delay ANY]
n [-max_lsas_per_pkt ANY]
n [-neighbor_dr_eligibility ANY]
n [-poll_interval ANY]
n [-transmit_delay ANY]
n [-vlan_cfi ANY]
x [-link_metric RANGE 0-4294967295
x DEFAULT 0]
x [-enable_ignore_db_desc_mtu CHOICES 0 1
x DEFAULT 0]
x [-router_bit CHOICES 0 1
x DEFAULT 0]
x [-v6 CHOICES 0 1
x DEFAULT 0]
x [-disable_auto_generate_link_lsa ANY]
x [-ospfv3_lsa_flood_rate_control ANY
x DEFAULT 1]
x [-intf_ipv6_addr IPV6]
x [-intf_ipv6_addr_step IPV6]
x [-ipv6_gateway_ip IPV6]
x [-ipv6_gateway_ip_step IPV6]
x [-intf_ipv6_prefix_length RANGE 1-128
x DEFAULT 64]
x [-enable_segment_routing CHOICES 0 1]
x [-configure_s_i_d_index_label ANY]
x [-configure_sid_index_label ANY]
x [-sid_index_label ANY]
x [-algorithm ANY]
x [-np_flag ANY]
x [-m_flag ANY]
x [-e_flag ANY]
x [-v_flag ANY]
x [-adj_sid_v_flag ANY]
x [-l_flag ANY]
x [-adj_sid_l_flag ANY]
x [-no_of_addiotnal_algo_sid_count RANGE 0-128
x DEFAULT 0]
x [-advertise_fapm CHOICES 0 1]
x [-fapm_metric NUMERIC]
x [-srgb_range_count NUMERIC]
x [-s_r_algorithm_count NUMERIC]
x [-start_s_i_d_label ANY]
x [-start_sid_label ANY]
x [-sid_count ANY]
x [-enable_adj_sid ANY]
x [-enable_adj_s_i_d ANY]
x [-adj_sid ANY]
x [-adj_s_i_d ANY]
x [-b_flag ANY]
x [-s_flag ANY]
x [-v_flag_if ANY]
x [-l_flag_if ANY]
x [-p_flag ANY]
x [-weight ANY]
x [-enable_s_r_l_g ANY]
x [-srlg_count NUMERIC]
x [-srlg_value ANY]
x [-ospf_sr_algorithm ANY]
x [-en_link_protection ANY]
x [-extra_traffic ANY]
x [-unprotected ANY]
x [-shared ANY]
x [-dedicated1_to1 ANY]
x [-dedicated1_plus1 ANY]
x [-enhanced ANY]
x [-reserved40 ANY]
x [-reserved80 ANY]
x [-high_perf_learning_mode_for_sr ANY]
x [-enable_srlb CHOICES 0 1]
x [-srlb_range_count NUMERIC]
x [-srlb_start_sid_label ANY]
x [-srlb_sid_count ANY]
x [-loopback_address IPV6]
x [-prefix_options HEX]
x [-extended_prefix_flags HEX]
x [-enable_sr_mpls CHOICES 0 1]
x [-enable_authentication CHOICES 0 1]
x [-auth_algo CHOICES sha1 sha256 sha384 sha512]
x [-sa_id NUMERIC]
x [-key ANY]
x [-stacked_layers ANY]
x [-g_flag CHOICES 0 1]
x [-additional_active CHOICES 0 1]
x [-additional_sid_index_label RANGE 0-1048575]
x [-additional_algorithm RANGE 0-255]
x [-additional_np_flag CHOICES 0 1]
x [-additional_m_flag CHOICES 0 1]
x [-additional_e_flag CHOICES 0 1]
x [-additional_v_flag CHOICES 0 1]
x [-additional_l_flag CHOICES 0 1]
x [-additional_advertise_fapm CHOICES 0 1]
x [-additional_fapm_metric RANGE 0-4294967295]
x [-flex_algo_count NUMERIC]
x [-flex_algo_active CHOICES 0 1]
x [-flex_algo RANGE 0-255
x DEFAULT 128]
x [-metric_type RANGE 0-2
x DEFAULT 0]
x [-calc_type RANGE 0-1
x DEFAULT 0]
x [-priority RANGE 0-255
x DEFAULT 0]
x [-enable_exclude_ag CHOICES 0 1]
x [-exclude_ag_ext_ag_len RANGE 1-10
x DEFAULT 1]
x [-exclude_ag_ext_ag HEX]
x [-enable_include_any_ag CHOICES 0 1]
x [-include_any_ag_ext_ag_len RANGE 1-10
x DEFAULT 1]
x [-include_any_ag_ext_ag HEX]
x [-enable_include_all_ag CHOICES 0 1]
x [-include_all_ag_ext_ag_len RANGE 1-10
x DEFAULT 1]
x [-include_all_ag_ext_ag HEX]
x [-enable_fadf_tlv CHOICES 0 1]
x [-fadf_len RANGE 1-10
x DEFAULT 1]
x [-fad_flag HEX]
x [-fad_sub_tlv_type RANGE 0-255
x DEFAULT 16]
x [-fa_eag_sub_tlv_type RANGE 0-255
x DEFAULT 1]
x [-fai_any_ag_sub_tlv_type RANGE 0-255
x DEFAULT 2]
x [-fai_all_ag_sub_tlv_type RANGE 0-255
x DEFAULT 3]
x [-fadf_sub_tlv_type RANGE 0-255
x DEFAULT 4]
x [-fae_srlg_sub_tlv_type RANGE 0-255
x DEFAULT 4]
x [-fapm_prefix_metric_sub_tlv_type RANGE 0-255
x DEFAULT 3]
Arguments:
-handle
OSPF session handle for using the modes delete, modify, enable, and disable.
When -handle is provided with the /globals value the arguments that configure global protocol
setting accept both multivalue handles and simple values.
When -handle is provided with a a protocol stack handle or a protocol session handle, the arguments
that configure global settings will only accept simple values. In this situation, these arguments will
configure only the settings of the parent device group or the ports associated with the parent topology.
x -return_detailed_handles
x This argument determines if individual interface, session or router handles are returned by the current command.
x This applies only to the command on which it is specified.
x Setting this to 0 means that only NGPF-specific protocol stack handles will be returned. This will significantly
x decrease the size of command results and speed up script execution.
x The default is 0, meaning only protocol stack handles will be returned.
-area_id
The OSPF area ID associated with the interface.
-area_id_step
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_config.py_part2
|
x [-s_r_algorithm_count NUMERIC]
x [-start_s_i_d_label ANY]
x [-start_sid_label ANY]
x [-sid_count ANY]
x [-enable_adj_sid ANY]
x [-enable_adj_s_i_d ANY]
x [-adj_sid ANY]
x [-adj_s_i_d ANY]
x [-b_flag ANY]
x [-s_flag ANY]
x [-v_flag_if ANY]
x [-l_flag_if ANY]
x [-p_flag ANY]
x [-weight ANY]
x [-enable_s_r_l_g ANY]
x [-srlg_count NUMERIC]
x [-srlg_value ANY]
x [-ospf_sr_algorithm ANY]
x [-en_link_protection ANY]
x [-extra_traffic ANY]
x [-unprotected ANY]
x [-shared ANY]
x [-dedicated1_to1 ANY]
x [-dedicated1_plus1 ANY]
x [-enhanced ANY]
x [-reserved40 ANY]
x [-reserved80 ANY]
x [-high_perf_learning_mode_for_sr ANY]
x [-enable_srlb CHOICES 0 1]
x [-srlb_range_count NUMERIC]
x [-srlb_start_sid_label ANY]
x [-srlb_sid_count ANY]
x [-loopback_address IPV6]
x [-prefix_options HEX]
x [-extended_prefix_flags HEX]
x [-enable_sr_mpls CHOICES 0 1]
x [-enable_authentication CHOICES 0 1]
x [-auth_algo CHOICES sha1 sha256 sha384 sha512]
x [-sa_id NUMERIC]
x [-key ANY]
x [-stacked_layers ANY]
x [-g_flag CHOICES 0 1]
x [-additional_active CHOICES 0 1]
x [-additional_sid_index_label RANGE 0-1048575]
x [-additional_algorithm RANGE 0-255]
x [-additional_np_flag CHOICES 0 1]
x [-additional_m_flag CHOICES 0 1]
x [-additional_e_flag CHOICES 0 1]
x [-additional_v_flag CHOICES 0 1]
x [-additional_l_flag CHOICES 0 1]
x [-additional_advertise_fapm CHOICES 0 1]
x [-additional_fapm_metric RANGE 0-4294967295]
x [-flex_algo_count NUMERIC]
x [-flex_algo_active CHOICES 0 1]
x [-flex_algo RANGE 0-255
x DEFAULT 128]
x [-metric_type RANGE 0-2
x DEFAULT 0]
x [-calc_type RANGE 0-1
x DEFAULT 0]
x [-priority RANGE 0-255
x DEFAULT 0]
x [-enable_exclude_ag CHOICES 0 1]
x [-exclude_ag_ext_ag_len RANGE 1-10
x DEFAULT 1]
x [-exclude_ag_ext_ag HEX]
x [-enable_include_any_ag CHOICES 0 1]
x [-include_any_ag_ext_ag_len RANGE 1-10
x DEFAULT 1]
x [-include_any_ag_ext_ag HEX]
x [-enable_include_all_ag CHOICES 0 1]
x [-include_all_ag_ext_ag_len RANGE 1-10
x DEFAULT 1]
x [-include_all_ag_ext_ag HEX]
x [-enable_fadf_tlv CHOICES 0 1]
x [-fadf_len RANGE 1-10
x DEFAULT 1]
x [-fad_flag HEX]
x [-fad_sub_tlv_type RANGE 0-255
x DEFAULT 16]
x [-fa_eag_sub_tlv_type RANGE 0-255
x DEFAULT 1]
x [-fai_any_ag_sub_tlv_type RANGE 0-255
x DEFAULT 2]
x [-fai_all_ag_sub_tlv_type RANGE 0-255
x DEFAULT 3]
x [-fadf_sub_tlv_type RANGE 0-255
x DEFAULT 4]
x [-fae_srlg_sub_tlv_type RANGE 0-255
x DEFAULT 4]
x [-fapm_prefix_metric_sub_tlv_type RANGE 0-255
x DEFAULT 3]
Arguments:
-handle
OSPF session handle for using the modes delete, modify, enable, and disable.
When -handle is provided with the /globals value the arguments that configure global protocol
setting accept both multivalue handles and simple values.
When -handle is provided with a a protocol stack handle or a protocol session handle, the arguments
that configure global settings will only accept simple values. In this situation, these arguments will
configure only the settings of the parent device group or the ports associated with the parent topology.
x -return_detailed_handles
x This argument determines if individual interface, session or router handles are returned by the current command.
x This applies only to the command on which it is specified.
x Setting this to 0 means that only NGPF-specific protocol stack handles will be returned. This will significantly
x decrease the size of command results and speed up script execution.
x The default is 0, meaning only protocol stack handles will be returned.
-area_id
The OSPF area ID associated with the interface.
-area_id_step
The OSPF area ID step associated with the -area_id option on the ISPF
interface.
x -area_id_as_number
x OSPF Area ID for a non-connected interface, displayed in Integer format.
x -area_id_as_number_step
x OSPF Area ID step for a non-connected interface, displayed in Integer format.
x -area_id_type
x Choice for Area ID Type of the Interface.
n -area_type
n This argument defined by Cisco is not supported for NGPF implementation.
-authentication_mode
This option defines the authentification mode used for OSPF.
-count
Defines the number of OSPF routers to configure on the -port_handle.
-dead_interval
The time after which the DUT router is considered dead if it
does not send HELLO messages.
-demand_circuit
Enables the Demand Circuit bit.Pertains to handling of demand
circuits (DCs) by the router. CHOICES 0 1.
n -enable_support_rfc_5838
n This argument defined by Cisco is not supported for NGPF implementation.
-graceful_restart_enable
This will enable graceful restart (HA) on the OSPF neighbor.
-hello_interval
The time between HELLO messages sent over the interface. RANGE 1-65535.
n -ignore_db_desc_mtu
n This argument defined by Cisco is not supported for NGPF implementation.
x -router_interface_active
x Enable/disable router interface.
x -enable_fast_hello
x Enable/disable fast hello.
x -hello_multiplier
x This is required when fast hello is enabled. The hello-multiplier value is set to the number of hello packets you want to send during the dead-interval.
x -max_mtu
x Maximum transmission unit of the frame.
x -protocol_name
x Name of the ospf protocol as it should appear in the IxNetwork GUI.
x -router_active
x Enable/disable the ospf router.
x -router_asbr
x If true (1), set router to be an AS boundary router (ASBR).
x Correspond to B (Border) bit in router LSA.
x This option is valid only when -type is router or grid, otherwise it
x is ignored.
x This option is available with IxTclNetwork and IxTclProtocol API.
x -do_not_generate_router_lsa
x A router originates a router-LSA for each area that it belongs to. Such an LSA describes the collected states of the router's links to the area.
x If this field is activated then auto generation of Router LSA does not happen.
x -router_abr
x If true (1), set router to be an area boundary router (ABR).
x Correspond to E (external) bit in router LSA.
x This option is valid only when -type is router or grid, otherwise it
x is ignored.
x This option is available with IxTclNetwork and IxTclProtocol API.
x -inter_flood_lsupdate_burst_gap
x Inter flood LSUpdate burst gap (ms) is a gap between two consecutive bursts of LSA.
x -lsa_refresh_time
x LSA refresh time (s) is a time interval after which the router will send fresh copies of LSA.
x -lsa_retransmit_time
x LSA's are retransmitted until they are acknowledged. This interval defines the time between retransmission.
x -max_ls_updates_per_burst
x Maximum ls updates which can be flooded in each burst.
x -oob_resync_breakout
x Enable out-of-band resynchronization breakout.
-interface_cost
The metric associated with the OSPF interface. RANGE 1-65535.
-intf_ip_addr
The IP address of the Ixia Simulated OSPF router. This parameter is
not valid on mode modify when IxTclProtocol is used. IP.
-intf_ip_addr_step
What step will be use for incrementing the -intf_ip_addr option.
This parameter is not valid on mode modify when IxTclProtocol is used.
-intf_prefix_length
Defines the mask of the IP address used for the Ixia (-intf_ip_addr)
and the DUT interface. This parameter is not valid on mode modify when
IxTclProtocol is used. RANGE 1-128
x -interface_handle
x A handle or list of the handles that are returned from the
x interface_config call. These provide a direct link to an already
x existing interface and supercede the use of the intf_ip_addr value.
x Starting with IxNetwork 5.60 this parameter accepts handles returned by
x emulation_dhcp_group_config procedure and pppox_config procedure in the following format:
x <DHCP Group Handle>|<interface index X>,<interface index Y>-<interface index Z>, ...
x The DHCP ranges are separated from the Interface Index identifiers with the (|) character.
x The Interface Index identifiers are separated with comas (,).
x A range of Interface Index identifiers can be defined using the dash (-) character.
x Ranges along with the Interface Index identifiers are grouped together in TCL Lists. The
x lists can contain mixed items, protocol interface handles returned by interface_config
x and handles returned by emulation_dhcp_group_config along with the interface index.
x Example:
x count 10 (10 OSPF routers). 3 DHCP range handles returned by ::ixia::emulation_dhcp_group_config.
x Each DHCP range has 20 sessions (interfaces). If we pass 'interface_handle
x in the following format: [list $dhcp_r1|1,5 $dhcp_r2|1-3 $dhcp_r3|1,3,5-9,13]
x The interfaces will be distributed to the routers in the following manner:
x OSPF Router 1: $dhcp_r1 -> interface 1
x OSPF Router 2: $dhcp_r1 -> interface 5
x OSPF Router 3: $dhcp_r2 -> interface 1
x OSPF Router 4: $dhcp_r2 -> interface 2
x OSPF Router 5: $dhcp_r2 -> interface 3
x OSPF Router 6: $dhcp_r3 -> interface 1
x OSPF Router 7: $dhcp_r3 -> interface 3
x OSPF Router 8: $dhcp_r3 -> interface 5
x OSPF Router 9: $dhcp_r3 -> interface 6
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_config.py_part3
|
The OSPF area ID step associated with the -area_id option on the ISPF
interface.
x -area_id_as_number
x OSPF Area ID for a non-connected interface, displayed in Integer format.
x -area_id_as_number_step
x OSPF Area ID step for a non-connected interface, displayed in Integer format.
x -area_id_type
x Choice for Area ID Type of the Interface.
n -area_type
n This argument defined by Cisco is not supported for NGPF implementation.
-authentication_mode
This option defines the authentification mode used for OSPF.
-count
Defines the number of OSPF routers to configure on the -port_handle.
-dead_interval
The time after which the DUT router is considered dead if it
does not send HELLO messages.
-demand_circuit
Enables the Demand Circuit bit.Pertains to handling of demand
circuits (DCs) by the router. CHOICES 0 1.
n -enable_support_rfc_5838
n This argument defined by Cisco is not supported for NGPF implementation.
-graceful_restart_enable
This will enable graceful restart (HA) on the OSPF neighbor.
-hello_interval
The time between HELLO messages sent over the interface. RANGE 1-65535.
n -ignore_db_desc_mtu
n This argument defined by Cisco is not supported for NGPF implementation.
x -router_interface_active
x Enable/disable router interface.
x -enable_fast_hello
x Enable/disable fast hello.
x -hello_multiplier
x This is required when fast hello is enabled. The hello-multiplier value is set to the number of hello packets you want to send during the dead-interval.
x -max_mtu
x Maximum transmission unit of the frame.
x -protocol_name
x Name of the ospf protocol as it should appear in the IxNetwork GUI.
x -router_active
x Enable/disable the ospf router.
x -router_asbr
x If true (1), set router to be an AS boundary router (ASBR).
x Correspond to B (Border) bit in router LSA.
x This option is valid only when -type is router or grid, otherwise it
x is ignored.
x This option is available with IxTclNetwork and IxTclProtocol API.
x -do_not_generate_router_lsa
x A router originates a router-LSA for each area that it belongs to. Such an LSA describes the collected states of the router's links to the area.
x If this field is activated then auto generation of Router LSA does not happen.
x -router_abr
x If true (1), set router to be an area boundary router (ABR).
x Correspond to E (external) bit in router LSA.
x This option is valid only when -type is router or grid, otherwise it
x is ignored.
x This option is available with IxTclNetwork and IxTclProtocol API.
x -inter_flood_lsupdate_burst_gap
x Inter flood LSUpdate burst gap (ms) is a gap between two consecutive bursts of LSA.
x -lsa_refresh_time
x LSA refresh time (s) is a time interval after which the router will send fresh copies of LSA.
x -lsa_retransmit_time
x LSA's are retransmitted until they are acknowledged. This interval defines the time between retransmission.
x -max_ls_updates_per_burst
x Maximum ls updates which can be flooded in each burst.
x -oob_resync_breakout
x Enable out-of-band resynchronization breakout.
-interface_cost
The metric associated with the OSPF interface. RANGE 1-65535.
-intf_ip_addr
The IP address of the Ixia Simulated OSPF router. This parameter is
not valid on mode modify when IxTclProtocol is used. IP.
-intf_ip_addr_step
What step will be use for incrementing the -intf_ip_addr option.
This parameter is not valid on mode modify when IxTclProtocol is used.
-intf_prefix_length
Defines the mask of the IP address used for the Ixia (-intf_ip_addr)
and the DUT interface. This parameter is not valid on mode modify when
IxTclProtocol is used. RANGE 1-128
x -interface_handle
x A handle or list of the handles that are returned from the
x interface_config call. These provide a direct link to an already
x existing interface and supercede the use of the intf_ip_addr value.
x Starting with IxNetwork 5.60 this parameter accepts handles returned by
x emulation_dhcp_group_config procedure and pppox_config procedure in the following format:
x <DHCP Group Handle>|<interface index X>,<interface index Y>-<interface index Z>, ...
x The DHCP ranges are separated from the Interface Index identifiers with the (|) character.
x The Interface Index identifiers are separated with comas (,).
x A range of Interface Index identifiers can be defined using the dash (-) character.
x Ranges along with the Interface Index identifiers are grouped together in TCL Lists. The
x lists can contain mixed items, protocol interface handles returned by interface_config
x and handles returned by emulation_dhcp_group_config along with the interface index.
x Example:
x count 10 (10 OSPF routers). 3 DHCP range handles returned by ::ixia::emulation_dhcp_group_config.
x Each DHCP range has 20 sessions (interfaces). If we pass 'interface_handle
x in the following format: [list $dhcp_r1|1,5 $dhcp_r2|1-3 $dhcp_r3|1,3,5-9,13]
x The interfaces will be distributed to the routers in the following manner:
x OSPF Router 1: $dhcp_r1 -> interface 1
x OSPF Router 2: $dhcp_r1 -> interface 5
x OSPF Router 3: $dhcp_r2 -> interface 1
x OSPF Router 4: $dhcp_r2 -> interface 2
x OSPF Router 5: $dhcp_r2 -> interface 3
x OSPF Router 6: $dhcp_r3 -> interface 1
x OSPF Router 7: $dhcp_r3 -> interface 3
x OSPF Router 8: $dhcp_r3 -> interface 5
x OSPF Router 9: $dhcp_r3 -> interface 6
x OSPF Router 10: $dhcp_r3 -> interface 7
x OSPF Router 11: $dhcp_r3 -> interface 8
x OSPF Router 12: $dhcp_r3 -> interface 9
x OSPF Router 13 $dhcp_r3 -> interface 13
x Valid for mode create for IxTclNetwork only.
-instance_id
Defines the instance ID of the OSPFv3 process. It allows
multiple instances of the OSPFv3 protocol to be run simultaneously
over the same link. RANGE 0-255
-instance_id_step
Step at which the -instance_id will be incremented. RANGE 0-255
-loopback_ip_addr
Defines the IP address of the loopback interface for MPLS VPN testing.
This parameter is not valid on mode modify when IxTclProtocol is used.
-loopback_ip_addr_step
Defines the IP address step of the loopback interface for MPLS VPN.
This parameter is not valid on mode modify when IxTclProtocol is used.
-lsa_discard_mode
Enables/Disables the LSA discard mode on the OSPF router. CHOICES 0 1
x -mac_address_init
x This option defines the MAC address that will be configured on
x the Ixia interface. This parameter is not valid on mode modify when
x IxTclProtocol is used.
x -mac_address_step
x This option defines the incrementing step for the MAC address that
x will be configured on the Ixia interface. This option is valid only
x when IxTclNetwork API is used.
-md5_key
Active only when "MD5" is selected in the Authentication field.
Enter a character string (maximum 16 characters) to be used as
a "secret" MD5 Key.
-md5_key_id
Active only when "MD5" is selected in the Authentication field.
Enter a value to be used as a Key ID.This identifier is associated
with the MD5 Key entered previously.
-mtu
The advertised MTU value in database entries sent to other routers
create on the Ixia interface. RANGE 68-14000.
OSPFv2 Only. For OSPFv3 this option is ignored.
-network_type
Indicates the type of network for the interface.
-neighbor_intf_ip_addr
The IP address of the DUT OSPF Interface.
This parameter is not valid on mode modify when IxTclProtocol is used.
-neighbor_intf_ip_addr_step
This parameter is not valid on mode modify when IxTclProtocol is used.
Determines the step which will be use for incrementing the -neighbor_intf_ip_addr option.
-neighbor_router_id
Available only for use when the Point-Multipoint network type is
selected. The DUT IP Interface address can be provided.
-neighbor_router_id_step
Available only for use when the Point-Multipoint network type is
selected. The DUT IP Interface address step can be provided.
-option_bits
The bit sum of the different OSPF option bits. This switch is for
users to customize options since area_type will determine a default
value for those bits. The Demand circuit option can be modified with
the -demand_circuit option. In HEX.
If (option_bits & 0x8) then area_id must not be 0.
(option_bits & 0x2) is not allowed - can't have external routing and NSSA capability at the same time.
x -type_of_service_routing
x Option bit 0. This describes the router's TOS capability. If the T-bit is reset,
x then the router supports only a single TOS (TOS 0). Such a router is also said to be incapable of TOS-routing.
x -external_capabilities
x Option bit 1. Disabled (0) means area is stub i.e. does not accept type 5 External LSAs.
x -multicast_capability
x Option bit 2. This bit describes whether IP multicast datagrams are forwarded
x according to the specifications in Multicast Extensions to OSPF, RFC 1584.
x -nssa_capability
x Option bit 3. When enabled (1), this means area is not-so-stubby i.e. does not accept type 5 External LSAs
x but converts type 7 LSAs into type 5 in order to advertise route to other areas.
x -external_attribute
x Option bit 4. This bit describes the router's willingness to receive and
x forward External-Attributes-LSAs, as specified in The OSPF External Attributes LSA.
x -opaque_lsa_forwarded
x Option bit 6. Always disabled (0) in Hello packets and used on DBD packets ONLY to signal support for Opaque LSAs (RFC5250).
x -unused
x Option bit 7. This is Unused Bit.
x -override_existence_check
x If this option is enabled, the interface existence check is skipped but
x the list of interfaces is still created and maintained in order to keep
x track of existing interfaces if required. Using this option will speed
x up the interfaces' creation.
x -override_tracking
x If this option is enabled, the list of interfaces won't be created and
x maintained anymore, thus, speeding up the interfaces' creation even
x more. Also, it will enable -override_existence_check in case it wasn't
x already enabled because checking for interface existence becomes
x impossible if the the list of interfaces doesn't exist anymore.
-password
Password to be used in the OSPF authentication mode is enabled and
set to "simple".
x -reset
x If this option is selected, this will clear any OSPF router on
x the targeted interface.
-router_id
The Router ID for this emulated OSPF Router, in IPv4 format. IP.
-router_id_step
The Router ID step for this emulated OSPF Router, in IPv4 format. IP.
-router_priority
The priority of the interface, for use in election of the designated or
backup master. RANGE 0-255
x -no_of_te_profile
x Number of Traffic Engineering Profile which is configured and advertised.
-te_enable
If set to 1, this will enable Traffic Engineering on the OSPF router.
The user can then configure the TE parameters by using "-te_metric",
"-te_max_bw", "-te_max_resv_bw", "-te_unresv_bw_priority0-7".
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_config.py_part4
|
x OSPF Router 9: $dhcp_r3 -> interface 6
x OSPF Router 10: $dhcp_r3 -> interface 7
x OSPF Router 11: $dhcp_r3 -> interface 8
x OSPF Router 12: $dhcp_r3 -> interface 9
x OSPF Router 13 $dhcp_r3 -> interface 13
x Valid for mode create for IxTclNetwork only.
-instance_id
Defines the instance ID of the OSPFv3 process. It allows
multiple instances of the OSPFv3 protocol to be run simultaneously
over the same link. RANGE 0-255
-instance_id_step
Step at which the -instance_id will be incremented. RANGE 0-255
-loopback_ip_addr
Defines the IP address of the loopback interface for MPLS VPN testing.
This parameter is not valid on mode modify when IxTclProtocol is used.
-loopback_ip_addr_step
Defines the IP address step of the loopback interface for MPLS VPN.
This parameter is not valid on mode modify when IxTclProtocol is used.
-lsa_discard_mode
Enables/Disables the LSA discard mode on the OSPF router. CHOICES 0 1
x -mac_address_init
x This option defines the MAC address that will be configured on
x the Ixia interface. This parameter is not valid on mode modify when
x IxTclProtocol is used.
x -mac_address_step
x This option defines the incrementing step for the MAC address that
x will be configured on the Ixia interface. This option is valid only
x when IxTclNetwork API is used.
-md5_key
Active only when "MD5" is selected in the Authentication field.
Enter a character string (maximum 16 characters) to be used as
a "secret" MD5 Key.
-md5_key_id
Active only when "MD5" is selected in the Authentication field.
Enter a value to be used as a Key ID.This identifier is associated
with the MD5 Key entered previously.
-mtu
The advertised MTU value in database entries sent to other routers
create on the Ixia interface. RANGE 68-14000.
OSPFv2 Only. For OSPFv3 this option is ignored.
-network_type
Indicates the type of network for the interface.
-neighbor_intf_ip_addr
The IP address of the DUT OSPF Interface.
This parameter is not valid on mode modify when IxTclProtocol is used.
-neighbor_intf_ip_addr_step
This parameter is not valid on mode modify when IxTclProtocol is used.
Determines the step which will be use for incrementing the -neighbor_intf_ip_addr option.
-neighbor_router_id
Available only for use when the Point-Multipoint network type is
selected. The DUT IP Interface address can be provided.
-neighbor_router_id_step
Available only for use when the Point-Multipoint network type is
selected. The DUT IP Interface address step can be provided.
-option_bits
The bit sum of the different OSPF option bits. This switch is for
users to customize options since area_type will determine a default
value for those bits. The Demand circuit option can be modified with
the -demand_circuit option. In HEX.
If (option_bits & 0x8) then area_id must not be 0.
(option_bits & 0x2) is not allowed - can't have external routing and NSSA capability at the same time.
x -type_of_service_routing
x Option bit 0. This describes the router's TOS capability. If the T-bit is reset,
x then the router supports only a single TOS (TOS 0). Such a router is also said to be incapable of TOS-routing.
x -external_capabilities
x Option bit 1. Disabled (0) means area is stub i.e. does not accept type 5 External LSAs.
x -multicast_capability
x Option bit 2. This bit describes whether IP multicast datagrams are forwarded
x according to the specifications in Multicast Extensions to OSPF, RFC 1584.
x -nssa_capability
x Option bit 3. When enabled (1), this means area is not-so-stubby i.e. does not accept type 5 External LSAs
x but converts type 7 LSAs into type 5 in order to advertise route to other areas.
x -external_attribute
x Option bit 4. This bit describes the router's willingness to receive and
x forward External-Attributes-LSAs, as specified in The OSPF External Attributes LSA.
x -opaque_lsa_forwarded
x Option bit 6. Always disabled (0) in Hello packets and used on DBD packets ONLY to signal support for Opaque LSAs (RFC5250).
x -unused
x Option bit 7. This is Unused Bit.
x -override_existence_check
x If this option is enabled, the interface existence check is skipped but
x the list of interfaces is still created and maintained in order to keep
x track of existing interfaces if required. Using this option will speed
x up the interfaces' creation.
x -override_tracking
x If this option is enabled, the list of interfaces won't be created and
x maintained anymore, thus, speeding up the interfaces' creation even
x more. Also, it will enable -override_existence_check in case it wasn't
x already enabled because checking for interface existence becomes
x impossible if the the list of interfaces doesn't exist anymore.
-password
Password to be used in the OSPF authentication mode is enabled and
set to "simple".
x -reset
x If this option is selected, this will clear any OSPF router on
x the targeted interface.
-router_id
The Router ID for this emulated OSPF Router, in IPv4 format. IP.
-router_id_step
The Router ID step for this emulated OSPF Router, in IPv4 format. IP.
-router_priority
The priority of the interface, for use in election of the designated or
backup master. RANGE 0-255
x -no_of_te_profile
x Number of Traffic Engineering Profile which is configured and advertised.
-te_enable
If set to 1, this will enable Traffic Engineering on the OSPF router.
The user can then configure the TE parameters by using "-te_metric",
"-te_max_bw", "-te_max_resv_bw", "-te_unresv_bw_priority0-7".
-te_max_bw
If "-te_enable" is 1, then this indicates the maximum bandwidth
that can be used on the link between this interface and its
neighbors in the outbound direction.
-te_max_resv_bw
If "-te_enable" is 1, then this indicates the maximum bandwidth,
in bytes per second, that can be reserved on the link between
this interface and its neighbors in the outbound direction.
-te_unresv_bw_priority0
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 0 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 0. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority1
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 1 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 1. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority2
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 2 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 2. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority3
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 3 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 3. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority4
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 4 priority level.This
value corresponds to the bandwidth that can be reserved with a setup
priority of 4.The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority5
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 5 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 5. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority6
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 6 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 6. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority7
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 7 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 7. The value must be less than the maxReservableBandwidth
option.
-te_metric
If set to 1, then this indicates the traffic engineering metric
associated with the interface. RANGE 1-2147483647
-te_admin_group
Assignment of traffic engineering administrative group numbers to the interface.
Valid only with IxTclNetwork API.
x -advertise_ext_admin_group
x If selected, the Extended Administrative Group is advertised.
x On enabling, Ext Admin Group Length and Ext Admin Group becomes editale.
x -ext_admin_group_length
x Ext Admin Group Length denotes length of the Extended Administrative Group.
x -ext_admin_group
x Ext Admin Group denotes the value of the Extended Administrative Group that is advertised
n -te_router_id
n This argument defined by Cisco is not supported for NGPF implementation.
x -vlan
x Enables vlan on the directly connected OSPF router interface.
x Valid options are: 0 - disable, 1 - enable.
x This option is valid only when -mode is create or -mode is modify
x and -handle is a OSPF router handle.
x This option is available only when IxNetwork tcl API is used.
-vlan_id_mode
If the user configures more than one interface on the Ixia with
VLAN, he can choose to automatically increment the VLAN tag or
leave it idle for each interface. CHOICES fixed increment.
This parameter is not valid on mode modify when IxTclProtocol is used.
-vlan_id
If VLAN is enable on the Ixia interface, this option will configure
the VLAN number. This parameter is not valid on mode modify when
IxTclProtocol is used. RANGE 0-4095
-vlan_id_step
This parameter is not valid on mode modify when IxTclProtocol is used.
If the -vlan_id_mode is increment, this will be the step value by
which the VLAN tags are incremented. RANGE 0-4095
When vlan_id_step causes the vlan_id value to exceed it's maximum value the
increment will be done modulo <number of possible vlan ids>.
Examples: vlan_id = 4094; vlan_id_step = 2-> new vlan_id value = 0
vlan_id = 4095; vlan_id_step = 11 -> new vlan_id value = 10
-vlan_user_priority
This parameter is not valid on mode modify when IxTclProtocol is used.
n -atm_encapsulation
n This argument defined by Cisco is not supported for NGPF implementation.
x -bfd_registration
x Enable or disable BFD registration.
x -enable_dr_bdr
x If 1, enables the OSPF Designated Router/Backup Designated Router
x DR/BDR) feature for all router interfaces on this port.
n -vci
n This argument defined by Cisco is not supported for NGPF implementation.
n -vci_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -vpi
n This argument defined by Cisco is not supported for NGPF implementation.
n -vpi_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -get_next_session_mode
n This argument defined by Cisco is not supported for NGPF implementation.
n -no_write
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_config.py_part5
|
"-te_max_bw", "-te_max_resv_bw", "-te_unresv_bw_priority0-7".
-te_max_bw
If "-te_enable" is 1, then this indicates the maximum bandwidth
that can be used on the link between this interface and its
neighbors in the outbound direction.
-te_max_resv_bw
If "-te_enable" is 1, then this indicates the maximum bandwidth,
in bytes per second, that can be reserved on the link between
this interface and its neighbors in the outbound direction.
-te_unresv_bw_priority0
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 0 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 0. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority1
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 1 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 1. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority2
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 2 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 2. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority3
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 3 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 3. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority4
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 4 priority level.This
value corresponds to the bandwidth that can be reserved with a setup
priority of 4.The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority5
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 5 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 5. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority6
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 6 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 6. The value must be less than the maxReservableBandwidth
option.
-te_unresv_bw_priority7
If "-te_enable" is 1, then this value indicates the amount of bandwidth,
in bytes per second, not yet reserved at the 7 priority level. This
value corresponds to the bandwidth that can be reserved with a setup
priority of 7. The value must be less than the maxReservableBandwidth
option.
-te_metric
If set to 1, then this indicates the traffic engineering metric
associated with the interface. RANGE 1-2147483647
-te_admin_group
Assignment of traffic engineering administrative group numbers to the interface.
Valid only with IxTclNetwork API.
x -advertise_ext_admin_group
x If selected, the Extended Administrative Group is advertised.
x On enabling, Ext Admin Group Length and Ext Admin Group becomes editale.
x -ext_admin_group_length
x Ext Admin Group Length denotes length of the Extended Administrative Group.
x -ext_admin_group
x Ext Admin Group denotes the value of the Extended Administrative Group that is advertised
n -te_router_id
n This argument defined by Cisco is not supported for NGPF implementation.
x -vlan
x Enables vlan on the directly connected OSPF router interface.
x Valid options are: 0 - disable, 1 - enable.
x This option is valid only when -mode is create or -mode is modify
x and -handle is a OSPF router handle.
x This option is available only when IxNetwork tcl API is used.
-vlan_id_mode
If the user configures more than one interface on the Ixia with
VLAN, he can choose to automatically increment the VLAN tag or
leave it idle for each interface. CHOICES fixed increment.
This parameter is not valid on mode modify when IxTclProtocol is used.
-vlan_id
If VLAN is enable on the Ixia interface, this option will configure
the VLAN number. This parameter is not valid on mode modify when
IxTclProtocol is used. RANGE 0-4095
-vlan_id_step
This parameter is not valid on mode modify when IxTclProtocol is used.
If the -vlan_id_mode is increment, this will be the step value by
which the VLAN tags are incremented. RANGE 0-4095
When vlan_id_step causes the vlan_id value to exceed it's maximum value the
increment will be done modulo <number of possible vlan ids>.
Examples: vlan_id = 4094; vlan_id_step = 2-> new vlan_id value = 0
vlan_id = 4095; vlan_id_step = 11 -> new vlan_id value = 10
-vlan_user_priority
This parameter is not valid on mode modify when IxTclProtocol is used.
n -atm_encapsulation
n This argument defined by Cisco is not supported for NGPF implementation.
x -bfd_registration
x Enable or disable BFD registration.
x -enable_dr_bdr
x If 1, enables the OSPF Designated Router/Backup Designated Router
x DR/BDR) feature for all router interfaces on this port.
n -vci
n This argument defined by Cisco is not supported for NGPF implementation.
n -vci_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -vpi
n This argument defined by Cisco is not supported for NGPF implementation.
n -vpi_step
n This argument defined by Cisco is not supported for NGPF implementation.
n -get_next_session_mode
n This argument defined by Cisco is not supported for NGPF implementation.
n -no_write
n This argument defined by Cisco is not supported for NGPF implementation.
x -validate_received_mtu
x Enabling this option means that the MTU will be verified during the DB exchange.
x This is only available for OSPFv2 interfaces that are directly connected to the DUT.
-graceful_restart_helper_mode_enable
This parameter -graceful_restart_helper_mode_enable will allow Ixia to
act as a helping neighbor to a restarting router.If the attribute is
set to 1, the router will act as restarting router's neighbors, which must
cooperate in order for the restart to be graceful.This attribute/argument
is valid when session_type is ospfV3.
Valid choices are:
0 - disable (default)
1 - enable
-strict_lsa_checking
If enabled, the helping router continues to help the restarting router even if there is a
topology change detected. Relevant with 'graceful_restart_helper_mode_enable'.
This attribute is associated with the four Graceful Restart reasons. This attribute/argument
is valid when session_type is ospfV3.
-support_reason_sw_restart
This is one of the reasons supported by this helping router when the neighboring router
gracefully restarts. Helping router will support only those restart reasons which are
enabled by the user. User can select more than one reason at a time. Relevant with
'graceful_restart_helper_mode_enable'.This attribute/argument is valid when session_type is ospfV3.
-support_reason_sw_reload_or_upgrade
This is one of the reasons supported by this helping router when the neighboring router gracefully restarts.
Helping router will support only those restart reasons which are enabled by the user. User can
select more than one reason at a time. Relevant with 'graceful_restart_helper_mode_enable'.
This attribute/argument is valid when session_type is ospfV3.
-support_reason_switch_to_redundant_processor_control
This is one of the reasons supported by this helping router when the neighboring router gracefully restarts.
Helping router will support only those restart reasons which are enabled by the user. User can
select more than one reason at a time. Relevant with 'graceful_restart_helper_mode_enable'.
This attribute/argument is valid when session_type is ospfV3.
-support_reason_unknown
This is one of the reasons supported by this helping router when the neighboring router gracefully restarts.
Helping router will support only those restart reasons which are enabled by the user. User can
select more than one reason at a time. Relevant with 'graceful_restart_helper_mode_enable'.
This attribute/argument is valid when session_type is ospfV3.
-mode
-session_type
The OSPF version to be emulated. CHOICES: ospfv2 ospfv3.
n -graceful_restart_restarting_mode_enable
n This argument defined by Cisco is not supported for NGPF implementation.
n -grace_period
n This argument defined by Cisco is not supported for NGPF implementation.
n -restart_reason
n This argument defined by Cisco is not supported for NGPF implementation.
n -number_of_restarts
n This argument defined by Cisco is not supported for NGPF implementation.
n -restart_start_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -restart_down_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -restart_up_time
n This argument defined by Cisco is not supported for NGPF implementation.
x -port_handle
x Ixia interface upon which to act.
x -rate_control_interval
x Flood link state updates per interval.
x -flood_lsupdates_per_interval
x Flood link state updates per interval.
x -attempt_scale_mode
x Indicates whether the control is specified per port or per device group.
x This setting is global for all the ospf protocols configured in the ixncfg
x and can be configured just when handle is /globals (when the user wants to configure just the global settings).
x -attempt_rate
x Number of times an action is triggered per second.
x -attempt_interval
x Time interval used to calculate the rate for triggering an action(rate = count/interval).
x -attempt_enabled
x Activates the selected port on which the protocol is configured.
x For Device Group Level, the Device Group that you have added in the Scenario is activated.
x -disconnect_scale_mode
x Indicates whether the control is specified per port or per device group.
x This setting is global for all the ospf protocols configured in the ixncfg
x and can be configured just when handle is /globals (when the user wants to configure just the global settings).
x -disconnect_rate
x Number of times an action is triggered per second.
x -disconnect_interval
x Time interval used to calculate the rate for triggering an action(rate = count/interval).
x -disconnect_enabled
x Activates the selected port on which the protocol is configured.
x For Device Group Level, the Device Group that you have added in the Scenario is activated.
n -gre_checksum
n This argument defined by Cisco is not supported for NGPF implementation.
n -gre_local_ip
n This argument defined by Cisco is not supported for NGPF implementation.
n -gre_remote_ip
n This argument defined by Cisco is not supported for NGPF implementation.
n -gre_tunnel
n This argument defined by Cisco is not supported for NGPF implementation.
n -host_route
n This argument defined by Cisco is not supported for NGPF implementation.
n -int_msg_exchange
n This argument defined by Cisco is not supported for NGPF implementation.
n -lsa_retransmit_delay
n This argument defined by Cisco is not supported for NGPF implementation.
n -max_lsas_per_pkt
n This argument defined by Cisco is not supported for NGPF implementation.
n -neighbor_dr_eligibility
n This argument defined by Cisco is not supported for NGPF implementation.
n -poll_interval
n This argument defined by Cisco is not supported for NGPF implementation.
n -transmit_delay
n This argument defined by Cisco is not supported for NGPF implementation.
n -vlan_cfi
n This argument defined by Cisco is not supported for NGPF implementation.
x -link_metric
x A value indicating the cost of transmitting data on this link. This cost is configured by the system administrator.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_config.py_part6
|
n This argument defined by Cisco is not supported for NGPF implementation.
n -no_write
n This argument defined by Cisco is not supported for NGPF implementation.
x -validate_received_mtu
x Enabling this option means that the MTU will be verified during the DB exchange.
x This is only available for OSPFv2 interfaces that are directly connected to the DUT.
-graceful_restart_helper_mode_enable
This parameter -graceful_restart_helper_mode_enable will allow Ixia to
act as a helping neighbor to a restarting router.If the attribute is
set to 1, the router will act as restarting router's neighbors, which must
cooperate in order for the restart to be graceful.This attribute/argument
is valid when session_type is ospfV3.
Valid choices are:
0 - disable (default)
1 - enable
-strict_lsa_checking
If enabled, the helping router continues to help the restarting router even if there is a
topology change detected. Relevant with 'graceful_restart_helper_mode_enable'.
This attribute is associated with the four Graceful Restart reasons. This attribute/argument
is valid when session_type is ospfV3.
-support_reason_sw_restart
This is one of the reasons supported by this helping router when the neighboring router
gracefully restarts. Helping router will support only those restart reasons which are
enabled by the user. User can select more than one reason at a time. Relevant with
'graceful_restart_helper_mode_enable'.This attribute/argument is valid when session_type is ospfV3.
-support_reason_sw_reload_or_upgrade
This is one of the reasons supported by this helping router when the neighboring router gracefully restarts.
Helping router will support only those restart reasons which are enabled by the user. User can
select more than one reason at a time. Relevant with 'graceful_restart_helper_mode_enable'.
This attribute/argument is valid when session_type is ospfV3.
-support_reason_switch_to_redundant_processor_control
This is one of the reasons supported by this helping router when the neighboring router gracefully restarts.
Helping router will support only those restart reasons which are enabled by the user. User can
select more than one reason at a time. Relevant with 'graceful_restart_helper_mode_enable'.
This attribute/argument is valid when session_type is ospfV3.
-support_reason_unknown
This is one of the reasons supported by this helping router when the neighboring router gracefully restarts.
Helping router will support only those restart reasons which are enabled by the user. User can
select more than one reason at a time. Relevant with 'graceful_restart_helper_mode_enable'.
This attribute/argument is valid when session_type is ospfV3.
-mode
-session_type
The OSPF version to be emulated. CHOICES: ospfv2 ospfv3.
n -graceful_restart_restarting_mode_enable
n This argument defined by Cisco is not supported for NGPF implementation.
n -grace_period
n This argument defined by Cisco is not supported for NGPF implementation.
n -restart_reason
n This argument defined by Cisco is not supported for NGPF implementation.
n -number_of_restarts
n This argument defined by Cisco is not supported for NGPF implementation.
n -restart_start_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -restart_down_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -restart_up_time
n This argument defined by Cisco is not supported for NGPF implementation.
x -port_handle
x Ixia interface upon which to act.
x -rate_control_interval
x Flood link state updates per interval.
x -flood_lsupdates_per_interval
x Flood link state updates per interval.
x -attempt_scale_mode
x Indicates whether the control is specified per port or per device group.
x This setting is global for all the ospf protocols configured in the ixncfg
x and can be configured just when handle is /globals (when the user wants to configure just the global settings).
x -attempt_rate
x Number of times an action is triggered per second.
x -attempt_interval
x Time interval used to calculate the rate for triggering an action(rate = count/interval).
x -attempt_enabled
x Activates the selected port on which the protocol is configured.
x For Device Group Level, the Device Group that you have added in the Scenario is activated.
x -disconnect_scale_mode
x Indicates whether the control is specified per port or per device group.
x This setting is global for all the ospf protocols configured in the ixncfg
x and can be configured just when handle is /globals (when the user wants to configure just the global settings).
x -disconnect_rate
x Number of times an action is triggered per second.
x -disconnect_interval
x Time interval used to calculate the rate for triggering an action(rate = count/interval).
x -disconnect_enabled
x Activates the selected port on which the protocol is configured.
x For Device Group Level, the Device Group that you have added in the Scenario is activated.
n -gre_checksum
n This argument defined by Cisco is not supported for NGPF implementation.
n -gre_local_ip
n This argument defined by Cisco is not supported for NGPF implementation.
n -gre_remote_ip
n This argument defined by Cisco is not supported for NGPF implementation.
n -gre_tunnel
n This argument defined by Cisco is not supported for NGPF implementation.
n -host_route
n This argument defined by Cisco is not supported for NGPF implementation.
n -int_msg_exchange
n This argument defined by Cisco is not supported for NGPF implementation.
n -lsa_retransmit_delay
n This argument defined by Cisco is not supported for NGPF implementation.
n -max_lsas_per_pkt
n This argument defined by Cisco is not supported for NGPF implementation.
n -neighbor_dr_eligibility
n This argument defined by Cisco is not supported for NGPF implementation.
n -poll_interval
n This argument defined by Cisco is not supported for NGPF implementation.
n -transmit_delay
n This argument defined by Cisco is not supported for NGPF implementation.
n -vlan_cfi
n This argument defined by Cisco is not supported for NGPF implementation.
x -link_metric
x A value indicating the cost of transmitting data on this link. This cost is configured by the system administrator.
x Generally, the lower the cost, the more likely the link is used to forward traffic. By default, all links have a cost of 1.
x -enable_ignore_db_desc_mtu
x The OSPFv3 device to ignore the set Maximum Transmit Unit.
x -router_bit
x Option bit 4. The Router Bit in the options field that indicates if the originator is an active router is set.
x -v6
x Option bit 0. The v6 bit which indicates that it supports the version 6 of the Internet Protocol (IPv6).
x -disable_auto_generate_link_lsa
x Support graceful restart helper mode when restart reason is unknown and unplanned.
x -ospfv3_lsa_flood_rate_control
x Inter Flood LSUpdate burst gap (ms).
x -intf_ipv6_addr
x IPv6 addresses of the layer.
x -intf_ipv6_addr_step
x The value which is used to increase the address range value.
x -ipv6_gateway_ip
x gateways of the layer
x -ipv6_gateway_ip_step
x The value which is used to increase the gateway address range value.
x -intf_ipv6_prefix_length
x Defines the mask of the IP address used for the Ixia (-intf_ipv6_addr)
x and the DUT interface. This parameter is not valid on mode modify when
x IxTclProtocol is used. RANGE 1-128.
x -enable_segment_routing
x Enable Segment Routing. Turns On the configuration of Segment Routing fields.
x -configure_s_i_d_index_label
x Configure SID/Index/Label
x -configure_sid_index_label
x Configure SID/Index/Label. This is selected to let the correponding router send Prefix SID.
x -sid_index_label
x SID/Index/Label. This is the value associated with IGP Prefix Segment attached to the specific IPv4 or IPv6 prefix.
x -algorithm
x Algorithm for the Node SID/Label. This indicates the algorithm supported by this node and is applicable to all of its routes.
x -np_flag
x No-PHP Flag. Indicates No Penultimate Hop Pop Flag.
x -m_flag
x Mapping Server Flag. Indicates the Redistribution Flag.
x -e_flag
x Explicit-Null Flag. Indicates the Explicit Null Flag.
x -v_flag
x Value or Index Flag. Indicates the value flag. If selected, SID/Index/Label carries an absolute value. Else, it carries an index.
x -adj_sid_v_flag
x Value or Index Flag. Indicates the absolute value of SID/Index/Label.
x -l_flag
x Local or Global Flag. Local/Global Flag. If set, then the value/index carried by the Prefix-SID has local significance.
x If not set, then the value/index carried by this sub-TLV has global significance.
x -adj_sid_l_flag
x Local or Global Flag. This indicates that value/index carried by the Prefix-SID has local significance.
x -no_of_addiotnal_algo_sid_count
x Additional Algo/SID Count. Denotes the number of additional algoritms and associated SID per Node prefix.
x -advertise_fapm
x Advertise FAPM. It advertises the OSPFv2 Flexible Algorithm Prefix Metric.
x -fapm_metric
x It denotes the Flexible Algorithm Prefix Metric. The default value is 10.
x -srgb_range_count
x SRGB Range Count. This field provides the configurable list of SRGB.
x -s_r_algorithm_count
x SR Algorithm Count. Denotes the number of supported SR algorithms.
x -start_s_i_d_label
x Start SID/Label. This field indicates the start value of the SID.
x -start_sid_label
x Start SID/Label. This field indicates the start value of the SID.
x -sid_count
x SID Count. This field indicates the count of SID range.
x -enable_adj_sid
x Enable Adj SID. Makes Adjacency Segment Identifier (SID) available and part a part of of the packet.
x -enable_adj_s_i_d
x Enable Adj SID. Makes Adjacency Segment Identifier (SID) available and part a part of of the packet.
x -adj_sid
x Adjacency SID. The corresponding Adj (SID) for a link.
x -adj_s_i_d
x Adjacency SID. The corresponding Adj (SID) for a link.
x -b_flag
x Backup Flag. Backup Flag. If set, the Adj-SID refers to an adjacency that is eligible for protection
x (e.g., using IP Fast Reroute (IPFRR) or MPLS-FRR (MPLS Fast Reroute))
x -s_flag
x Set/Group Flag. This checkbox indicates the set/group flag. When set, the S-Flag indicates that the Adj-SID refers to a group of adjacencies.
x -v_flag_if
x Value/Index Flag. If set, then the Adj-SID carries an absolute value.If not set, then the Adj-SID carries an index.
x -l_flag_if
x Local/Global Flag. If set, then the value/index carried by the Adj-SID has local significance.
x If not set, then the value/index carried by this sub-TLV has global significance.
x -p_flag
x Persistent Flag. When set, the P-Flag indicates that the Adj-SID is persistently allocated, i.e., the
x Adj-SID value remains consistent across router restart and/or interface flap.
x -weight
x Weight is an integer value used for load-balancing purposes of the link.
x -enable_s_r_l_g
x This enables the SRLG on the OSPF link between two mentioned interfaces.
x -srlg_count
x This field value shows how many SRLG Value columns would be there in the GUI.
x -srlg_value
x This is the SRLG Value for the link between two mentioned interfaces.
x -ospf_sr_algorithm
x SR Algorithm. The SR-Algorithm TLV is a top-level TLV of the Router Information Opaque LSA.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_config.py_part7
|
x A value indicating the cost of transmitting data on this link. This cost is configured by the system administrator.
x Generally, the lower the cost, the more likely the link is used to forward traffic. By default, all links have a cost of 1.
x -enable_ignore_db_desc_mtu
x The OSPFv3 device to ignore the set Maximum Transmit Unit.
x -router_bit
x Option bit 4. The Router Bit in the options field that indicates if the originator is an active router is set.
x -v6
x Option bit 0. The v6 bit which indicates that it supports the version 6 of the Internet Protocol (IPv6).
x -disable_auto_generate_link_lsa
x Support graceful restart helper mode when restart reason is unknown and unplanned.
x -ospfv3_lsa_flood_rate_control
x Inter Flood LSUpdate burst gap (ms).
x -intf_ipv6_addr
x IPv6 addresses of the layer.
x -intf_ipv6_addr_step
x The value which is used to increase the address range value.
x -ipv6_gateway_ip
x gateways of the layer
x -ipv6_gateway_ip_step
x The value which is used to increase the gateway address range value.
x -intf_ipv6_prefix_length
x Defines the mask of the IP address used for the Ixia (-intf_ipv6_addr)
x and the DUT interface. This parameter is not valid on mode modify when
x IxTclProtocol is used. RANGE 1-128.
x -enable_segment_routing
x Enable Segment Routing. Turns On the configuration of Segment Routing fields.
x -configure_s_i_d_index_label
x Configure SID/Index/Label
x -configure_sid_index_label
x Configure SID/Index/Label. This is selected to let the correponding router send Prefix SID.
x -sid_index_label
x SID/Index/Label. This is the value associated with IGP Prefix Segment attached to the specific IPv4 or IPv6 prefix.
x -algorithm
x Algorithm for the Node SID/Label. This indicates the algorithm supported by this node and is applicable to all of its routes.
x -np_flag
x No-PHP Flag. Indicates No Penultimate Hop Pop Flag.
x -m_flag
x Mapping Server Flag. Indicates the Redistribution Flag.
x -e_flag
x Explicit-Null Flag. Indicates the Explicit Null Flag.
x -v_flag
x Value or Index Flag. Indicates the value flag. If selected, SID/Index/Label carries an absolute value. Else, it carries an index.
x -adj_sid_v_flag
x Value or Index Flag. Indicates the absolute value of SID/Index/Label.
x -l_flag
x Local or Global Flag. Local/Global Flag. If set, then the value/index carried by the Prefix-SID has local significance.
x If not set, then the value/index carried by this sub-TLV has global significance.
x -adj_sid_l_flag
x Local or Global Flag. This indicates that value/index carried by the Prefix-SID has local significance.
x -no_of_addiotnal_algo_sid_count
x Additional Algo/SID Count. Denotes the number of additional algoritms and associated SID per Node prefix.
x -advertise_fapm
x Advertise FAPM. It advertises the OSPFv2 Flexible Algorithm Prefix Metric.
x -fapm_metric
x It denotes the Flexible Algorithm Prefix Metric. The default value is 10.
x -srgb_range_count
x SRGB Range Count. This field provides the configurable list of SRGB.
x -s_r_algorithm_count
x SR Algorithm Count. Denotes the number of supported SR algorithms.
x -start_s_i_d_label
x Start SID/Label. This field indicates the start value of the SID.
x -start_sid_label
x Start SID/Label. This field indicates the start value of the SID.
x -sid_count
x SID Count. This field indicates the count of SID range.
x -enable_adj_sid
x Enable Adj SID. Makes Adjacency Segment Identifier (SID) available and part a part of of the packet.
x -enable_adj_s_i_d
x Enable Adj SID. Makes Adjacency Segment Identifier (SID) available and part a part of of the packet.
x -adj_sid
x Adjacency SID. The corresponding Adj (SID) for a link.
x -adj_s_i_d
x Adjacency SID. The corresponding Adj (SID) for a link.
x -b_flag
x Backup Flag. Backup Flag. If set, the Adj-SID refers to an adjacency that is eligible for protection
x (e.g., using IP Fast Reroute (IPFRR) or MPLS-FRR (MPLS Fast Reroute))
x -s_flag
x Set/Group Flag. This checkbox indicates the set/group flag. When set, the S-Flag indicates that the Adj-SID refers to a group of adjacencies.
x -v_flag_if
x Value/Index Flag. If set, then the Adj-SID carries an absolute value.If not set, then the Adj-SID carries an index.
x -l_flag_if
x Local/Global Flag. If set, then the value/index carried by the Adj-SID has local significance.
x If not set, then the value/index carried by this sub-TLV has global significance.
x -p_flag
x Persistent Flag. When set, the P-Flag indicates that the Adj-SID is persistently allocated, i.e., the
x Adj-SID value remains consistent across router restart and/or interface flap.
x -weight
x Weight is an integer value used for load-balancing purposes of the link.
x -enable_s_r_l_g
x This enables the SRLG on the OSPF link between two mentioned interfaces.
x -srlg_count
x This field value shows how many SRLG Value columns would be there in the GUI.
x -srlg_value
x This is the SRLG Value for the link between two mentioned interfaces.
x -ospf_sr_algorithm
x SR Algorithm. The SR-Algorithm TLV is a top-level TLV of the Router Information Opaque LSA.
x The SR-Algorithm TLV is optional.It SHOULD only be advertised once in the Router Information Opaque LSA.If the SR-Algorithm TLV is not
x advertised by the node, such a node is considered as not being Segment Routing capable.
x -en_link_protection
x This enables the link protection on the OSPF link between two mentioned interfaces.
x -extra_traffic
x This is a Protection Scheme with value 0x01. It means that the link is protecting another link or links.The LSPs on a link of this type will be lost if any of the links it is protecting fail.
x -unprotected
x This is a Protection Scheme with value 0x02. It means that there is no other link protecting this link.The LSPs on a link of this type will be lost if the link fails.
x -shared
x This is a Protection Scheme with value 0x04. It means that there are one or more disjoint links of type Extra Traffic that are protecting this link.These Extra Traffic links are shared between one or more links of type Shared.
x -dedicated1_to1
x This is a Protection Scheme with value 0x08. It means that there is one dedicated disjoint link of type Extra Traffic that is protecting this link.
x -dedicated1_plus1
x This is a Protection Scheme with value 0x10. It means that a dedicated disjoint link is protecting this link.However, the protecting link is not advertised in the link state database and is therefore not available for the routing of LSPs.
x -enhanced
x This is a Protection Scheme with value 0x20. It means that a protection scheme that is more reliable than Dedicated 1+1, e.g., 4 fiber BLSR/MS-SPRING, is being used to protect this link.
x -reserved40
x This is a Protection Scheme with value 0x40.
x -reserved80
x This is a Protection Scheme with value 0x80.
x -high_perf_learning_mode_for_sr
x This option can be used to increase scale.When enabled then the minimum information required to generate traffic is stored instead of the entire LSA. For example, for SR traffic generation, sid, vflag, SRGB details are stored and label is calculated accordingly. Please note when this flag is enabled, we will not store any LSAs so Learned Info will not display any details. Currently this is supported for only SR opaque LSAs, other Opaque LSAs like BIER, Graceful Restart is not supported.
x -enable_srlb
x Enables SRLB feature if SR is enabled.Maximum allowed count is 5.
x -srlb_range_count
x Defines the SRLB range that needs to be configured.
x -srlb_start_sid_label
x Defines the starting value of sid label.
x -srlb_sid_count
x Defines the count for the configured sid.
x -loopback_address
x The IPv6 loopback prefix.
x -prefix_options
x Each prefix is advertised along with an 8-bit field ||| N|DN| P| x|LA|NU| of capabilities.
x -extended_prefix_flags
x Each prefix is advertised along with an 8-bit field ||| N|DN| P| x|LA|NU| of capabilities.
x -enable_sr_mpls
x Makes the Segment Routing configuration enabled.
x -enable_authentication
x Enable Authentication
x -auth_algo
x Authentication Algorithms
x -sa_id
x Security Association ID
x -key
x Key
x -stacked_layers
x List of secondary (many to one) child layer protocols
x -g_flag
x G-Flag: Group Flag: If set, the G-Flag indicates that
x the Adj-SID refers to a group of adjacencies where it may be assigned
x -additional_active
x Advertise FAPM
x -additional_sid_index_label
x SID/Index/Label
x -additional_algorithm
x Algorithm
x -additional_np_flag
x No-PHP Flag
x -additional_m_flag
x Mapping Server Flag
x -additional_e_flag
x Explicit-Null Flag
x -additional_v_flag
x Value or Index Flag
x -additional_l_flag
x Local or Global Flag
x -additional_advertise_fapm
x Advertise FAPM
x -additional_fapm_metric
x FAPM Metric
x -flex_algo_count
x If the count is greater than 0, then the Flex Algo tab will appear after OSPF RTR tab.
x Default is 0. Range is 0-128.
x -flex_algo_active
x Activate FlexAlgorithm Tab.
x -flex_algo
x Flex Algo
x -metric_type
x Metric Type
x -calc_type
x Calc Type
x -priority
x Priority
x -enable_exclude_ag
x If this is enabled, Flexible Algorithm Exclude Admin Group Sub-Sub TLV will be
x advertised with FAD sub-TLV.
x -exclude_ag_ext_ag_len
x Ext AG Length
x -exclude_ag_ext_ag
x Ext Admin Group
x -enable_include_any_ag
x If this is enabled, Flexible Algorithm Include-Any Admin Group Sub-Sub TLV will be
x advertised with FAD sub-TLV.
x -include_any_ag_ext_ag_len
x Ext AG Length
x -include_any_ag_ext_ag
x Ext Include-Any AG
x -enable_include_all_ag
x If this is enabled, Flexible Algorithm Include-All Admin Group Sub-Sub TLV will be
x advertised with FAD sub-TLV.
x -include_all_ag_ext_ag_len
x Ext AG Length
x -include_all_ag_ext_ag
x Ext Include-All AG
x -enable_fadf_tlv
x If enabled then following attributes will get enabled and OSPF Flexible Algorithm Definition Flags Sub-TLV or
x FADF sub-sub-TLV will be advertised with FAD Sub-TLV
x -fadf_len
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_config.py_part8
|
x SR Algorithm. The SR-Algorithm TLV is a top-level TLV of the Router Information Opaque LSA.
x The SR-Algorithm TLV is optional.It SHOULD only be advertised once in the Router Information Opaque LSA.If the SR-Algorithm TLV is not
x advertised by the node, such a node is considered as not being Segment Routing capable.
x -en_link_protection
x This enables the link protection on the OSPF link between two mentioned interfaces.
x -extra_traffic
x This is a Protection Scheme with value 0x01. It means that the link is protecting another link or links.The LSPs on a link of this type will be lost if any of the links it is protecting fail.
x -unprotected
x This is a Protection Scheme with value 0x02. It means that there is no other link protecting this link.The LSPs on a link of this type will be lost if the link fails.
x -shared
x This is a Protection Scheme with value 0x04. It means that there are one or more disjoint links of type Extra Traffic that are protecting this link.These Extra Traffic links are shared between one or more links of type Shared.
x -dedicated1_to1
x This is a Protection Scheme with value 0x08. It means that there is one dedicated disjoint link of type Extra Traffic that is protecting this link.
x -dedicated1_plus1
x This is a Protection Scheme with value 0x10. It means that a dedicated disjoint link is protecting this link.However, the protecting link is not advertised in the link state database and is therefore not available for the routing of LSPs.
x -enhanced
x This is a Protection Scheme with value 0x20. It means that a protection scheme that is more reliable than Dedicated 1+1, e.g., 4 fiber BLSR/MS-SPRING, is being used to protect this link.
x -reserved40
x This is a Protection Scheme with value 0x40.
x -reserved80
x This is a Protection Scheme with value 0x80.
x -high_perf_learning_mode_for_sr
x This option can be used to increase scale.When enabled then the minimum information required to generate traffic is stored instead of the entire LSA. For example, for SR traffic generation, sid, vflag, SRGB details are stored and label is calculated accordingly. Please note when this flag is enabled, we will not store any LSAs so Learned Info will not display any details. Currently this is supported for only SR opaque LSAs, other Opaque LSAs like BIER, Graceful Restart is not supported.
x -enable_srlb
x Enables SRLB feature if SR is enabled.Maximum allowed count is 5.
x -srlb_range_count
x Defines the SRLB range that needs to be configured.
x -srlb_start_sid_label
x Defines the starting value of sid label.
x -srlb_sid_count
x Defines the count for the configured sid.
x -loopback_address
x The IPv6 loopback prefix.
x -prefix_options
x Each prefix is advertised along with an 8-bit field ||| N|DN| P| x|LA|NU| of capabilities.
x -extended_prefix_flags
x Each prefix is advertised along with an 8-bit field ||| N|DN| P| x|LA|NU| of capabilities.
x -enable_sr_mpls
x Makes the Segment Routing configuration enabled.
x -enable_authentication
x Enable Authentication
x -auth_algo
x Authentication Algorithms
x -sa_id
x Security Association ID
x -key
x Key
x -stacked_layers
x List of secondary (many to one) child layer protocols
x -g_flag
x G-Flag: Group Flag: If set, the G-Flag indicates that
x the Adj-SID refers to a group of adjacencies where it may be assigned
x -additional_active
x Advertise FAPM
x -additional_sid_index_label
x SID/Index/Label
x -additional_algorithm
x Algorithm
x -additional_np_flag
x No-PHP Flag
x -additional_m_flag
x Mapping Server Flag
x -additional_e_flag
x Explicit-Null Flag
x -additional_v_flag
x Value or Index Flag
x -additional_l_flag
x Local or Global Flag
x -additional_advertise_fapm
x Advertise FAPM
x -additional_fapm_metric
x FAPM Metric
x -flex_algo_count
x If the count is greater than 0, then the Flex Algo tab will appear after OSPF RTR tab.
x Default is 0. Range is 0-128.
x -flex_algo_active
x Activate FlexAlgorithm Tab.
x -flex_algo
x Flex Algo
x -metric_type
x Metric Type
x -calc_type
x Calc Type
x -priority
x Priority
x -enable_exclude_ag
x If this is enabled, Flexible Algorithm Exclude Admin Group Sub-Sub TLV will be
x advertised with FAD sub-TLV.
x -exclude_ag_ext_ag_len
x Ext AG Length
x -exclude_ag_ext_ag
x Ext Admin Group
x -enable_include_any_ag
x If this is enabled, Flexible Algorithm Include-Any Admin Group Sub-Sub TLV will be
x advertised with FAD sub-TLV.
x -include_any_ag_ext_ag_len
x Ext AG Length
x -include_any_ag_ext_ag
x Ext Include-Any AG
x -enable_include_all_ag
x If this is enabled, Flexible Algorithm Include-All Admin Group Sub-Sub TLV will be
x advertised with FAD sub-TLV.
x -include_all_ag_ext_ag_len
x Ext AG Length
x -include_all_ag_ext_ag
x Ext Include-All AG
x -enable_fadf_tlv
x If enabled then following attributes will get enabled and OSPF Flexible Algorithm Definition Flags Sub-TLV or
x FADF sub-sub-TLV will be advertised with FAD Sub-TLV
x -fadf_len
x FADF AG Length
x -fad_flag
x Flags
x -fad_sub_tlv_type
x FAD Sub-TLV Type
x -fa_eag_sub_tlv_type
x FAEAG Sub-TLV Type
x -fai_any_ag_sub_tlv_type
x FAIAnyAG Sub-TLV Type
x -fai_all_ag_sub_tlv_type
x FAIAllAG Sub-TLV Type
x -fadf_sub_tlv_type
x FADF Sub-TLV Type
x -fae_srlg_sub_tlv_type
x FAESRLG Sub-TLV type
x -fapm_prefix_metric_sub_tlv_type
x FAPM Prefix Metric Sub-TLV type
Return Values:
A list containing the ethernet protocol stack handles that were added by the command (if any).
x key:ethernet_handle value:A list containing the ethernet protocol stack handles that were added by the command (if any).
A list containing the ipv4 protocol stack handles that were added by the command (if any).
x key:ipv4_handle value:A list containing the ipv4 protocol stack handles that were added by the command (if any).
A list containing the ospfv2 protocol stack handles that were added by the command (if any).
x key:ospfv2_handle value:A list containing the ospfv2 protocol stack handles that were added by the command (if any).
A list containing the ipv6 protocol stack handles that were added by the command (if any).
x key:ipv6_handle value:A list containing the ipv6 protocol stack handles that were added by the command (if any).
A list containing the ospfv3 protocol stack handles that were added by the command (if any).
x key:ospfv3_handle value:A list containing the ospfv3 protocol stack handles that were added by the command (if any).
$::SUCCESS or $::FAILURE
key:status value:$::SUCCESS or $::FAILURE
If failure, will contain more information
key:log value:If failure, will contain more information
The router numbers Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
key:handle value:The router numbers Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Examples:
Sample Input:
Sample Output:
Notes:
1) Coded versus functional specification.
2) When -handle is provided with the /globals value the arguments that configure global protocol
setting accept both multivalue handles and simple values.
When -handle is provided with a a protocol stack handle or a protocol session handle, the arguments
that configure global settings will only accept simple values. In this situation, these arguments will
configure only the settings of the parent device group or the ports associated with the parent topology.
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: handle
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_ospf_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_config.py_part9
|
x FADF sub-sub-TLV will be advertised with FAD Sub-TLV
x -fadf_len
x FADF AG Length
x -fad_flag
x Flags
x -fad_sub_tlv_type
x FAD Sub-TLV Type
x -fa_eag_sub_tlv_type
x FAEAG Sub-TLV Type
x -fai_any_ag_sub_tlv_type
x FAIAnyAG Sub-TLV Type
x -fai_all_ag_sub_tlv_type
x FAIAllAG Sub-TLV Type
x -fadf_sub_tlv_type
x FADF Sub-TLV Type
x -fae_srlg_sub_tlv_type
x FAESRLG Sub-TLV type
x -fapm_prefix_metric_sub_tlv_type
x FAPM Prefix Metric Sub-TLV type
Return Values:
A list containing the ethernet protocol stack handles that were added by the command (if any).
x key:ethernet_handle value:A list containing the ethernet protocol stack handles that were added by the command (if any).
A list containing the ipv4 protocol stack handles that were added by the command (if any).
x key:ipv4_handle value:A list containing the ipv4 protocol stack handles that were added by the command (if any).
A list containing the ospfv2 protocol stack handles that were added by the command (if any).
x key:ospfv2_handle value:A list containing the ospfv2 protocol stack handles that were added by the command (if any).
A list containing the ipv6 protocol stack handles that were added by the command (if any).
x key:ipv6_handle value:A list containing the ipv6 protocol stack handles that were added by the command (if any).
A list containing the ospfv3 protocol stack handles that were added by the command (if any).
x key:ospfv3_handle value:A list containing the ospfv3 protocol stack handles that were added by the command (if any).
$::SUCCESS or $::FAILURE
key:status value:$::SUCCESS or $::FAILURE
If failure, will contain more information
key:log value:If failure, will contain more information
The router numbers Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
key:handle value:The router numbers Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Examples:
Sample Input:
Sample Output:
Notes:
1) Coded versus functional specification.
2) When -handle is provided with the /globals value the arguments that configure global protocol
setting accept both multivalue handles and simple values.
When -handle is provided with a a protocol stack handle or a protocol session handle, the arguments
that configure global settings will only accept simple values. In this situation, these arguments will
configure only the settings of the parent device group or the ports associated with the parent topology.
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: handle
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_ospf_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_ospf_config.py_part10
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_pim_info(self, handle, **kwargs):
r'''
#Procedure Header
Name:
emulation_pim_info
Description:
This command is used to retrieve aggregate statistics about PIM from a port, and
learned CRP_BSR info.
Synopsis:
emulation_pim_info
-handle ANY
[-mode CHOICES aggregate
CHOICES stats_per_device_group
CHOICES stats_per_session
CHOICES learned_crp
CHOICES clear_stats
DEFAULT aggregate]
Arguments:
-handle
For -mode aggregate, this parameter should be provided with an emulated
router or join/prune or source handle, but the command will return per port
aggregated stats. For -mode learned_crp, this parameters should be provided
with an emulated router or interface (for the emulated router) and the
command will return per interface learned CRP and BSR info.
-mode
Using this argument, you can return aggregate statistics or learned crp-bsr info
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
On status of failure, gives detailed information.
key:log value:On status of failure, gives detailed information.
PIMSM Aggregated Hellos Tx; valid only with -mode aggregate
key:port_name value:PIMSM Aggregated Hellos Tx; valid only with -mode aggregate
PIMSM Aggregated Hellos Tx; valid only with -mode aggregate
key:hello_tx value:PIMSM Aggregated Hellos Tx; valid only with -mode aggregate
PIMSM Aggregated Hellos Rx; valid only with -mode aggregate
key:hello_rx value:PIMSM Aggregated Hellos Rx; valid only with -mode aggregate
PIMSM Aggregated Join (*,G) Tx; valid only with -mode aggregate
key:group_join_tx value:PIMSM Aggregated Join (*,G) Tx; valid only with -mode aggregate
PIMSM Aggregated Join (*,G) Rx; valid only with -mode aggregate
key:group_join_rx value:PIMSM Aggregated Join (*,G) Rx; valid only with -mode aggregate
PIMSM Aggregated Prune (*,G) Tx; valid only with -mode aggregate
key:group_prune_tx value:PIMSM Aggregated Prune (*,G) Tx; valid only with -mode aggregate
PIMSM Aggregated Prune (*,G) Rx; valid only with -mode aggregate
key:group_prune_rx value:PIMSM Aggregated Prune (*,G) Rx; valid only with -mode aggregate
PIMSM Aggregated Join (S,G) Tx; valid only with -mode aggregate
key:s_g_join_tx value:PIMSM Aggregated Join (S,G) Tx; valid only with -mode aggregate
PIMSM Aggregated Join(S,G) Rx; valid only with -mode aggregate
key:s_g_join_rx value:PIMSM Aggregated Join(S,G) Rx; valid only with -mode aggregate
PIMSM Aggregated Prune(S,G) Tx; valid only with -mode aggregate
key:s_g_prune_tx value:PIMSM Aggregated Prune(S,G) Tx; valid only with -mode aggregate
PIMSM Aggregated Prune(S,G) Rx; valid only with -mode aggregate
key:s_g_prune_rx value:PIMSM Aggregated Prune(S,G) Rx; valid only with -mode aggregate
PIMSM Aggregated Register Tx; valid only with -mode aggregate
key:reg_tx value:PIMSM Aggregated Register Tx; valid only with -mode aggregate
PIMSM Aggregated Register Rx; valid only with -mode aggregate
key:reg_rx value:PIMSM Aggregated Register Rx; valid only with -mode aggregate
PIMSM Aggregated RegisterStop Tx; valid only with -mode aggregate
key:reg_stop_tx value:PIMSM Aggregated RegisterStop Tx; valid only with -mode aggregate
PIMSM Aggregated RegisterStop Rx; valid only with -mode aggregate
key:reg_stop_rx value:PIMSM Aggregated RegisterStop Rx; valid only with -mode aggregate
PIMSM Aggregated RegisterNull Tx; valid only with -mode aggregate
key:null_reg_tx value:PIMSM Aggregated RegisterNull Tx; valid only with -mode aggregate
PIMSM Aggregated RegisterNull Rx; valid only with -mode aggregate
key:null_reg_rx value:PIMSM Aggregated RegisterNull Rx; valid only with -mode aggregate
PIMSM Aggregated Hellos Tx
key:<port handle>.aggregate.port_name value:PIMSM Aggregated Hellos Tx
PIMSM Aggregated Hellos Tx
key:<port handle>.aggregate.hello_tx value:PIMSM Aggregated Hellos Tx
PIMSM Aggregated Hellos Rx
key:<port handle>.aggregate.hello_rx value:PIMSM Aggregated Hellos Rx
PIMSM Aggregated Join (*,G) Tx
key:<port handle>.aggregate.group_join_tx value:PIMSM Aggregated Join (*,G) Tx
PIMSM Aggregated Join (*,G) Rx
key:<port handle>.aggregate.group_join_rx value:PIMSM Aggregated Join (*,G) Rx
PIMSM Aggregated Prune (*,G) Tx
key:<port handle>.aggregate.group_prune_tx value:PIMSM Aggregated Prune (*,G) Tx
PIMSM Aggregated Prune (*,G) Rx
key:<port handle>.aggregate.group_prune_rx value:PIMSM Aggregated Prune (*,G) Rx
PIMSM Aggregated Join (S,G) Tx
key:<port handle>.aggregate.s_g_join_tx value:PIMSM Aggregated Join (S,G) Tx
PIMSM Aggregated Join(S,G) Rx
key:<port handle>.aggregate.s_g_join_rx value:PIMSM Aggregated Join(S,G) Rx
PIMSM Aggregated Prune(S,G) Tx
key:<port handle>.aggregate.s_g_prune_tx value:PIMSM Aggregated Prune(S,G) Tx
PIMSM Aggregated Prune(S,G) Rx
key:<port handle>.aggregate.s_g_prune_rx value:PIMSM Aggregated Prune(S,G) Rx
PIMSM Aggregated Register Tx
key:<port handle>.aggregate.reg_tx value:PIMSM Aggregated Register Tx
PIMSM Aggregated Register Rx
key:<port handle>.aggregate.reg_rx value:PIMSM Aggregated Register Rx
PIMSM Aggregated RegisterStop Tx
key:<port handle>.aggregate.reg_stop_tx value:PIMSM Aggregated RegisterStop Tx
PIMSM Aggregated RegisterStop Rx
key:<port handle>.aggregate.reg_stop_rx value:PIMSM Aggregated RegisterStop Rx
PIMSM Aggregated RegisterNull Tx
key:<port handle>.aggregate.null_reg_tx value:PIMSM Aggregated RegisterNull Tx
PIMSM Aggregated RegisterNull Rx
key:<port handle>.aggregate.null_reg_rx value:PIMSM Aggregated RegisterNull Rx
PIMSM Number of Routers Configured; valid only with -mode aggregate
x key:num_routers_configured value:PIMSM Number of Routers Configured; valid only with -mode aggregate
PIMSM Number of Routers Running; valid only with -mode aggregate
x key:num_routers_running value:PIMSM Number of Routers Running; valid only with -mode aggregate
PIMSM Number of Neighbors Learnt; valid only with -mode aggregate
x key:num_neighbors_learnt value:PIMSM Number of Neighbors Learnt; valid only with -mode aggregate
PIMSM Aggregated Join (*,*,RP) Tx; valid only with -mode aggregate
x key:rp_join_tx value:PIMSM Aggregated Join (*,*,RP) Tx; valid only with -mode aggregate
PIMSM Aggregated Join (*,*,RP) Rx; valid only with -mode aggregate
x key:rp_join_rx value:PIMSM Aggregated Join (*,*,RP) Rx; valid only with -mode aggregate
PIMSM Aggregated Prune (*,*,RP) Tx; valid only with -mode aggregate
x key:rp_prune_tx value:PIMSM Aggregated Prune (*,*,RP) Tx; valid only with -mode aggregate
PIMSM Aggregated Prune (*,*,RP) Rx; valid only with -mode aggregate
x key:rp_prune_rx value:PIMSM Aggregated Prune (*,*,RP) Rx; valid only with -mode aggregate
PIMSM Aggregated Join (S,G,RPT) Tx; valid only with -mode aggregate
x key:s_g_rpt_join_tx value:PIMSM Aggregated Join (S,G,RPT) Tx; valid only with -mode aggregate
PIMSM Aggregated Join (S,G,RPT) Rx; valid only with -mode aggregate
x key:s_g_rpt_join_rx value:PIMSM Aggregated Join (S,G,RPT) Rx; valid only with -mode aggregate
PIMSM Aggregated Prune (S,G,RPT) Tx; valid only with -mode aggregate
x key:s_g_rpt_prune_tx value:PIMSM Aggregated Prune (S,G,RPT) Tx; valid only with -mode aggregate
PIMSM Aggregated Prune (S,G,RPT) Rx; valid only with -mode aggregate
x key:s_g_rpt_prune_rx value:PIMSM Aggregated Prune (S,G,RPT) Rx; valid only with -mode aggregate
PIMSM Aggregated DataMDT TLV Tx; valid only with -mode aggregate
x key:data_mdt_tlv_tx value:PIMSM Aggregated DataMDT TLV Tx; valid only with -mode aggregate
PIMSM Aggregated DataMDT TLV Rx; valid only with -mode aggregate
x key:data_mdt_tlv_rx value:PIMSM Aggregated DataMDT TLV Rx; valid only with -mode aggregate
PIMSM Number of Routers Configured
x key:<port handle>.aggregate.num_routers_configured value:PIMSM Number of Routers Configured
PIMSM Number of Routers Running
x key:<port handle>.aggregate.num_routers_running value:PIMSM Number of Routers Running
PIMSM Number of Neighbors Learnt
x key:<port handle>.aggregate.num_neighbors_learnt value:PIMSM Number of Neighbors Learnt
PIMSM Aggregated Join (*,*,RP) Tx
x key:<port handle>.aggregate.rp_join_tx value:PIMSM Aggregated Join (*,*,RP) Tx
PIMSM Aggregated Join (*,*,RP) Rx
x key:<port handle>.aggregate.rp_join_rx value:PIMSM Aggregated Join (*,*,RP) Rx
PIMSM Aggregated Prune (*,*,RP) Tx
x key:<port handle>.aggregate.rp_prune_tx value:PIMSM Aggregated Prune (*,*,RP) Tx
PIMSM Aggregated Prune (*,*,RP) Rx
x key:<port handle>.aggregate.rp_prune_rx value:PIMSM Aggregated Prune (*,*,RP) Rx
PIMSM Aggregated Join (S,G,RPT) Tx
x key:<port handle>.aggregate.s_g_rpt_join_tx value:PIMSM Aggregated Join (S,G,RPT) Tx
PIMSM Aggregated Join (S,G,RPT) Rx
x key:<port handle>.aggregate.s_g_rpt_join_rx value:PIMSM Aggregated Join (S,G,RPT) Rx
PIMSM Aggregated Prune (S,G,RPT) Tx
x key:<port handle>.aggregate.s_g_rpt_prune_tx value:PIMSM Aggregated Prune (S,G,RPT) Tx
PIMSM Aggregated Prune (S,G,RPT) Rx
x key:<port handle>.aggregate.s_g_rpt_prune_rx value:PIMSM Aggregated Prune (S,G,RPT) Rx
PIMSM Aggregated DataMDT TLV Tx
x key:<port handle>.aggregate.data_mdt_tlv_tx value:PIMSM Aggregated DataMDT TLV Tx
PIMSM Aggregated DataMDT TLV Rx
x key:<port handle>.aggregate.data_mdt_tlv_rx value:PIMSM Aggregated DataMDT TLV Rx
the RP address expresing candidacy for the specific group of RPs; valid only with -mode learned_crp
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_pim_info.py_part1
|
key:<port handle>.aggregate.s_g_prune_rx value:PIMSM Aggregated Prune(S,G) Rx
PIMSM Aggregated Register Tx
key:<port handle>.aggregate.reg_tx value:PIMSM Aggregated Register Tx
PIMSM Aggregated Register Rx
key:<port handle>.aggregate.reg_rx value:PIMSM Aggregated Register Rx
PIMSM Aggregated RegisterStop Tx
key:<port handle>.aggregate.reg_stop_tx value:PIMSM Aggregated RegisterStop Tx
PIMSM Aggregated RegisterStop Rx
key:<port handle>.aggregate.reg_stop_rx value:PIMSM Aggregated RegisterStop Rx
PIMSM Aggregated RegisterNull Tx
key:<port handle>.aggregate.null_reg_tx value:PIMSM Aggregated RegisterNull Tx
PIMSM Aggregated RegisterNull Rx
key:<port handle>.aggregate.null_reg_rx value:PIMSM Aggregated RegisterNull Rx
PIMSM Number of Routers Configured; valid only with -mode aggregate
x key:num_routers_configured value:PIMSM Number of Routers Configured; valid only with -mode aggregate
PIMSM Number of Routers Running; valid only with -mode aggregate
x key:num_routers_running value:PIMSM Number of Routers Running; valid only with -mode aggregate
PIMSM Number of Neighbors Learnt; valid only with -mode aggregate
x key:num_neighbors_learnt value:PIMSM Number of Neighbors Learnt; valid only with -mode aggregate
PIMSM Aggregated Join (*,*,RP) Tx; valid only with -mode aggregate
x key:rp_join_tx value:PIMSM Aggregated Join (*,*,RP) Tx; valid only with -mode aggregate
PIMSM Aggregated Join (*,*,RP) Rx; valid only with -mode aggregate
x key:rp_join_rx value:PIMSM Aggregated Join (*,*,RP) Rx; valid only with -mode aggregate
PIMSM Aggregated Prune (*,*,RP) Tx; valid only with -mode aggregate
x key:rp_prune_tx value:PIMSM Aggregated Prune (*,*,RP) Tx; valid only with -mode aggregate
PIMSM Aggregated Prune (*,*,RP) Rx; valid only with -mode aggregate
x key:rp_prune_rx value:PIMSM Aggregated Prune (*,*,RP) Rx; valid only with -mode aggregate
PIMSM Aggregated Join (S,G,RPT) Tx; valid only with -mode aggregate
x key:s_g_rpt_join_tx value:PIMSM Aggregated Join (S,G,RPT) Tx; valid only with -mode aggregate
PIMSM Aggregated Join (S,G,RPT) Rx; valid only with -mode aggregate
x key:s_g_rpt_join_rx value:PIMSM Aggregated Join (S,G,RPT) Rx; valid only with -mode aggregate
PIMSM Aggregated Prune (S,G,RPT) Tx; valid only with -mode aggregate
x key:s_g_rpt_prune_tx value:PIMSM Aggregated Prune (S,G,RPT) Tx; valid only with -mode aggregate
PIMSM Aggregated Prune (S,G,RPT) Rx; valid only with -mode aggregate
x key:s_g_rpt_prune_rx value:PIMSM Aggregated Prune (S,G,RPT) Rx; valid only with -mode aggregate
PIMSM Aggregated DataMDT TLV Tx; valid only with -mode aggregate
x key:data_mdt_tlv_tx value:PIMSM Aggregated DataMDT TLV Tx; valid only with -mode aggregate
PIMSM Aggregated DataMDT TLV Rx; valid only with -mode aggregate
x key:data_mdt_tlv_rx value:PIMSM Aggregated DataMDT TLV Rx; valid only with -mode aggregate
PIMSM Number of Routers Configured
x key:<port handle>.aggregate.num_routers_configured value:PIMSM Number of Routers Configured
PIMSM Number of Routers Running
x key:<port handle>.aggregate.num_routers_running value:PIMSM Number of Routers Running
PIMSM Number of Neighbors Learnt
x key:<port handle>.aggregate.num_neighbors_learnt value:PIMSM Number of Neighbors Learnt
PIMSM Aggregated Join (*,*,RP) Tx
x key:<port handle>.aggregate.rp_join_tx value:PIMSM Aggregated Join (*,*,RP) Tx
PIMSM Aggregated Join (*,*,RP) Rx
x key:<port handle>.aggregate.rp_join_rx value:PIMSM Aggregated Join (*,*,RP) Rx
PIMSM Aggregated Prune (*,*,RP) Tx
x key:<port handle>.aggregate.rp_prune_tx value:PIMSM Aggregated Prune (*,*,RP) Tx
PIMSM Aggregated Prune (*,*,RP) Rx
x key:<port handle>.aggregate.rp_prune_rx value:PIMSM Aggregated Prune (*,*,RP) Rx
PIMSM Aggregated Join (S,G,RPT) Tx
x key:<port handle>.aggregate.s_g_rpt_join_tx value:PIMSM Aggregated Join (S,G,RPT) Tx
PIMSM Aggregated Join (S,G,RPT) Rx
x key:<port handle>.aggregate.s_g_rpt_join_rx value:PIMSM Aggregated Join (S,G,RPT) Rx
PIMSM Aggregated Prune (S,G,RPT) Tx
x key:<port handle>.aggregate.s_g_rpt_prune_tx value:PIMSM Aggregated Prune (S,G,RPT) Tx
PIMSM Aggregated Prune (S,G,RPT) Rx
x key:<port handle>.aggregate.s_g_rpt_prune_rx value:PIMSM Aggregated Prune (S,G,RPT) Rx
PIMSM Aggregated DataMDT TLV Tx
x key:<port handle>.aggregate.data_mdt_tlv_tx value:PIMSM Aggregated DataMDT TLV Tx
PIMSM Aggregated DataMDT TLV Rx
x key:<port handle>.aggregate.data_mdt_tlv_rx value:PIMSM Aggregated DataMDT TLV Rx
the RP address expresing candidacy for the specific group of RPs; valid only with -mode learned_crp
x key:learned_crp.<interface_handle>.<id>.crp_addr value:the RP address expresing candidacy for the specific group of RPs; valid only with -mode learned_crp
the expiry timer for the specific record as received in CRP Adv Message; valid only with -mode learned_crp
x key:learned_crp.<interface_handle>.<id>.expiry_timer value:the expiry timer for the specific record as received in CRP Adv Message; valid only with -mode learned_crp
the Group Address learnt through Candidate RP advertisments; valid only with -mode learned_crp
x key:learned_crp.<interface_handle>.<id>.group_addr value:the Group Address learnt through Candidate RP advertisments; valid only with -mode learned_crp
shows the prefix lenght of the group address learnt; valid only with -mode learned_crp
x key:learned_crp.<interface_handle>.<id>.group_mask_width value:shows the prefix lenght of the group address learnt; valid only with -mode learned_crp
priority of the selected Candidate RP; valid only with -mode learned_crp
x key:learned_crp.<interface_handle>.<id>.priority value:priority of the selected Candidate RP; valid only with -mode learned_crp
the address of the elected bootstrap router that is sending periodic bootstrap messages; valid only with -mode learned_crp
x key:learned_bsr.<interface_handle>.bsr_addr value:the address of the elected bootstrap router that is sending periodic bootstrap messages; valid only with -mode learned_crp
indicates the elapsed time (in seconds) since the last bootstrap message was received or sent; valid only with -mode learned_crp
x key:learned_bsr.<interface_handle>.last_bsm_send_recv value:indicates the elapsed time (in seconds) since the last bootstrap message was received or sent; valid only with -mode learned_crp
indicates the state of the configured bootstrap router; valid only with -mode learned_crp
x key:learned_bsr.<interface_handle>.our_bsr_state value:indicates the state of the configured bootstrap router; valid only with -mode learned_crp
priority of the elected bootstrap router as received in Bootstrap messages or configured priority; valid only with -mode learned_crp
x key:learned_bsr.<interface_handle>.priority value:priority of the elected bootstrap router as received in Bootstrap messages or configured priority; valid only with -mode learned_crp
Examples:
ixia::emulation_pim_info -handle <router_handle> -mode aggregate
Sample Input:
Sample Output:
Notes:
1) For many handles specified as parameters this procedure will return a keyed
list formatted as follows: <port_handle>.aggregate.<key_name> when mode is aggregate,
or learned_crp.<interface_handle>.<key_name>, learned_bsr.<interface_handle>.<key_name>
when mode is learned_crp.
2) MVPN parameters are not supported with IxTclNetwork API (new API).
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_pim_info',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_pim_info.py_part2
|
the RP address expresing candidacy for the specific group of RPs; valid only with -mode learned_crp
x key:learned_crp.<interface_handle>.<id>.crp_addr value:the RP address expresing candidacy for the specific group of RPs; valid only with -mode learned_crp
the expiry timer for the specific record as received in CRP Adv Message; valid only with -mode learned_crp
x key:learned_crp.<interface_handle>.<id>.expiry_timer value:the expiry timer for the specific record as received in CRP Adv Message; valid only with -mode learned_crp
the Group Address learnt through Candidate RP advertisments; valid only with -mode learned_crp
x key:learned_crp.<interface_handle>.<id>.group_addr value:the Group Address learnt through Candidate RP advertisments; valid only with -mode learned_crp
shows the prefix lenght of the group address learnt; valid only with -mode learned_crp
x key:learned_crp.<interface_handle>.<id>.group_mask_width value:shows the prefix lenght of the group address learnt; valid only with -mode learned_crp
priority of the selected Candidate RP; valid only with -mode learned_crp
x key:learned_crp.<interface_handle>.<id>.priority value:priority of the selected Candidate RP; valid only with -mode learned_crp
the address of the elected bootstrap router that is sending periodic bootstrap messages; valid only with -mode learned_crp
x key:learned_bsr.<interface_handle>.bsr_addr value:the address of the elected bootstrap router that is sending periodic bootstrap messages; valid only with -mode learned_crp
indicates the elapsed time (in seconds) since the last bootstrap message was received or sent; valid only with -mode learned_crp
x key:learned_bsr.<interface_handle>.last_bsm_send_recv value:indicates the elapsed time (in seconds) since the last bootstrap message was received or sent; valid only with -mode learned_crp
indicates the state of the configured bootstrap router; valid only with -mode learned_crp
x key:learned_bsr.<interface_handle>.our_bsr_state value:indicates the state of the configured bootstrap router; valid only with -mode learned_crp
priority of the elected bootstrap router as received in Bootstrap messages or configured priority; valid only with -mode learned_crp
x key:learned_bsr.<interface_handle>.priority value:priority of the elected bootstrap router as received in Bootstrap messages or configured priority; valid only with -mode learned_crp
Examples:
ixia::emulation_pim_info -handle <router_handle> -mode aggregate
Sample Input:
Sample Output:
Notes:
1) For many handles specified as parameters this procedure will return a keyed
list formatted as follows: <port_handle>.aggregate.<key_name> when mode is aggregate,
or learned_crp.<interface_handle>.<key_name>, learned_bsr.<interface_handle>.<key_name>
when mode is learned_crp.
2) MVPN parameters are not supported with IxTclNetwork API (new API).
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_pim_info',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_pim_info.py_part3
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def ixvm_control(self, action, virtual_chassis, **kwargs):
r'''
#Procedure Header
Name:
ixvm_control
Description:
This command enables the user to control the cards on IxVM virtual chassis.
Synopsis:
ixvm_control
x -action CHOICES connect disconnect
x -virtual_chassis ANY
x [-card_no NUMERIC]
x [-management_ip IP]
x [-break_locks CHOICES 0 1]
Arguments:
x -action
x -virtual_chassis
x The ip or hostname of the virtual chassis. If a DNS name is provided, please make sure the name can be resolved using the dns provider from the ixnetwork_tcl_server machine.
x -card_no
x The number of the card affected by the chosen action. If management_ip is provided this argument is ignored.
x -management_ip
x The management IPv4 adress of the virtual card affected by the choosen action. Card_no can also be provided insted of management ip. If both are provided, management_ip will take precedence and card_no will be ignored.
x -break_locks
x This argument, if specified, will force clear ownership if the virtual card is in use (has ownership taken by any user).
x Please note that forcefully clearing port ownership will disconnect any existing user from the port causing current running script failure.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
If status is failure, detailed information provided.
key:log value:If status is failure, detailed information provided.
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'ixvm_control',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ixvm_control.py_part1
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_isis_control(self, mode, **kwargs):
r'''
#Procedure Header
Name:
emulation_isis_control
Description:
This procedure is used to start, stop, and restart the ISIS protocol.
Synopsis:
emulation_isis_control
-mode CHOICES start
CHOICES stop
CHOICES restart
CHOICES abort
CHOICES restart_down
CHOICES stop_hello
CHOICES resume_hello
CHOICES age_out_routes
CHOICES readvertise_routes
CHOICES disconnect
CHOICES reconnect
x [-age_out_percent NUMERIC]
n [-port_handle ANY]
[-handle ANY]
n [-advertise ANY]
n [-flap_count ANY]
n [-flap_down_time ANY]
n [-flap_interval_time ANY]
n [-flap_routes ANY]
n [-withdraw ANY]
Arguments:
-mode
x -age_out_percent
x The percentage of addresses that will be aged out. This argument is ignored when mode is not age_out_routes and *must* be specified in such circumstances.
n -port_handle
n This argument defined by Cisco is not supported for NGPF implementation.
-handle
ISIS session handle where the ISIS control action is applied.
n -advertise
n This argument defined by Cisco is not supported for NGPF implementation.
n -flap_count
n This argument defined by Cisco is not supported for NGPF implementation.
n -flap_down_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -flap_interval_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -flap_routes
n This argument defined by Cisco is not supported for NGPF implementation.
n -withdraw
n This argument defined by Cisco is not supported for NGPF implementation.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
If status is failure, detailed information provided.
key:log value:If status is failure, detailed information provided.
Examples:
Sample Input:
Sample Output:
Notes:
Coded versus functional specification.
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_isis_control',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_isis_control.py_part1
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def traffic_tag_config(self, **kwargs):
r'''
#Procedure Header
Name:
traffic_tag_config
Description:
This procedure is used to configure L23 Data traffic items using traffic tags. These tags need to be set at various end points (IP/IPv6 stack, NetworkGroup IP and etc) from where traffic can be sourced or destined.
Synopsis:
traffic_tag_config
x [-handle ANY]
[-mode CHOICES create modify delete
DEFAULT create]
x [-enabled CHOICES 0 1]
x [-name ALPHA]
x [-id NUMERIC]
Arguments:
x -handle
x For create: protocol stack handle needed to configure traffic tag.
x For modify/delete: tag handle that must be modified/deleted
-mode
Which mode is being performed.
x -enabled
x Enables/disables tags
x -name
x specifies the name of the tag the entity will be part of
x -id
x the tag ids that this entity will use/publish
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
On status of failure, gives detailed information.
key:log value:On status of failure, gives detailed information.
A handle that can be used to modify/delete the tag
key:traffic_tag_handle value:A handle that can be used to modify/delete the tag
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'traffic_tag_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/traffic_tag_config.py_part1
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_dhcp_config(self, **kwargs):
r'''
#Procedure Header
Name:
emulation_dhcp_config
Description:
This procedure configures the DHCP emulation client. It creates, modifies, or resets an emulated Dynamic Host Configuration Protocol (DHCP) client or Dynamic Host Configuration Protocol for the specified HLTAPI port or handle.
Synopsis:
emulation_dhcp_config
[-handle ANY]
[-mode CHOICES create modify reset
DEFAULT create]
[-msg_timeout NUMERIC
DEFAULT 4]
[-outstanding_releases_count RANGE 1-100000
DEFAULT 500]
[-outstanding_session_count NUMERIC
DEFAULT 50]
[-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
[-release_rate RANGE 1-100000
DEFAULT 50]
n [-release_rate_increment ANY]
[-request_rate RANGE 1-100000
DEFAULT 10]
n [-request_rate_increment ANY]
[-retry_count RANGE 1-65536
DEFAULT 3]
[-client_port NUMERIC
DEFAULT 68]
[-start_scale_mode CHOICES device_group port
DEFAULT port]
[-stop_scale_mode CHOICES device_group port
DEFAULT port]
[-sessionlifetime_scale_mode CHOICES device_group port
DEFAULT port]
[-interval_stop NUMERIC
DEFAULT 1000]
[-interval_start NUMERIC
DEFAULT 1000]
[-min_lifetime NUMERIC
DEFAULT 1]
[-max_restarts NUMERIC
DEFAULT 10]
[-max_lifetime NUMERIC
DEFAULT 10]
[-enable_restart CHOICES 0 1
DEFAULT 0]
[-enable_lifetime CHOICES 0 1
DEFAULT 0]
x [-unlimited_restarts CHOICES 0 1
x DEFAULT 0]
[-server_port RANGE 0-65535
DEFAULT 67]
x [-dhcp6_echo_ia_info CHOICES 0 1
x DEFAULT 0]
x [-dhcp6_reb_max_rt RANGE 1-10000
x DEFAULT 600]
x [-dhcp6_reb_timeout RANGE 1-100
x DEFAULT 10]
x [-dhcp6_rel_max_rc RANGE 1-100
x DEFAULT 5]
x [-dhcp6_rel_timeout RANGE 1-100
x DEFAULT 1]
x [-dhcp6_ren_max_rt RANGE 1-10000
x DEFAULT 600]
x [-dhcp6_ren_timeout RANGE 1-100
x DEFAULT 10]
x [-dhcp6_req_max_rc RANGE 1-100
x DEFAULT 5]
x [-dhcp6_req_max_rt RANGE 1-10000
x DEFAULT 30]
x [-dhcp6_req_timeout RANGE 1-100
x DEFAULT 1]
x [-dhcp6_sol_max_rc RANGE 1-65536
x DEFAULT 3]
x [-dhcp6_sol_max_rt RANGE 1-10000
x DEFAULT 120]
x [-dhcp6_sol_timeout RANGE 1-100
x DEFAULT 1]
x [-dhcp6_info_req_timeout NUMERIC
x DEFAULT 4]
x [-dhcp6_info_req_max_rt NUMERIC
x DEFAULT 120]
x [-dhcp6_info_req_max_rc NUMERIC
x DEFAULT 3]
x [-msg_timeout_factor RANGE 1-100
x DEFAULT 2]
x [-msg_max_timeout RANGE 1-100
x DEFAULT 2]
x [-override_global_setup_rate CHOICES 0 1
x DEFAULT 1]
x [-override_global_teardown_rate CHOICES 0 1
x DEFAULT 1]
x [-skip_release_on_stop CHOICES 0 1
x DEFAULT 0]
x [-renew_on_link_up CHOICES 0 1
x DEFAULT 0]
n [-accept_partial_config ANY]
n [-lease_time ANY]
n [-max_dhcp_msg_size ANY]
n [-wait_for_completion ANY]
n [-associates ANY]
n [-no_write ANY]
n [-release_rate_max ANY]
n [-request_rate_max ANY]
n [-reset ANY]
n [-version ANY]
n [-response_wait ANY]
n [-retry_timer ANY]
x [-ip_version CHOICES 4 6
x DEFAULT 4]
x [-dhcp4_arp_gw CHOICES 0 1]
x [-dhcp6_ns_gw CHOICES 0 1]
Arguments:
-handle
Specifies the handle of the port upon which emulation is configured.
Mandatory for the mode -modify.
Valid for -version ixtclhal, ixnetwork.
When -handle is provided with the /globals value the arguments that configure global protocol
setting accept both multivalue handles and simple values.
When -handle is provided with a a protocol stack handle or a protocol session handle, the arguments
that configure global settings will only accept simple values. In this situation, these arguments will
configure only the settings of the parent device group or the ports associated with the parent topology.
-mode
This option defines the action to be taken on the port specified by
the port_handle argument.
Valid for -version ixtclhal, ixnetwork.
-msg_timeout
Specifies the maximum time to wait in milliseconds for receipt of an
offer or ack message after the sending of a corresponding discover or
request message.
Valid for -version ixnetwork.
-outstanding_releases_count
The maximum number of release sessions opened at any time by the DHCPv6
network stack element. The default is 500.
Valid for -version ixnetwork.
-outstanding_session_count
Specifies the maximum number of outstanding sessions (unacknowledged
discover or request message) allowed to exist. In effect, this is a
rate limiting mechanism that stops dhcp servers from being
overwhelmed with reqests.
Valid for -version ixnetwork.
-port_handle
This parameter specifies the port upon which emulation is configured.
Mandatory for the modes -create and -reset.
Valid for -version ixtclhal, ixnetwork.
-release_rate
The number of addresses to release in the first second after stop command
is received. The default is 50.
Valid for -version ixnetwork.
n -release_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
-request_rate
Specifies the desired request rate in sessions per second.
Valid for -version ixnetwork.
n -request_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
-retry_count
Limits the number of additional transmissions of either a discover or
request message when no acknowledgement is received.
Valid for -version ixnetwork.
-client_port
UDP port that the client listens on for DHCP responses.
Valid for dhcpv4 client.
-start_scale_mode
Indicates whether the control is specified per port or per device group.
This setting is global for all the dhcp client protocols configured in the ixncfg
and can be configured just when handle is /globals (when the user wants to configure just the global settings)
-stop_scale_mode
Indicates whether the control is specified per port or per device group.
This setting is global for all the dhcp client protocols configured in the ixncfg
and can be configured just when handle is /globals (when the user wants to configure just the global settings)
-sessionlifetime_scale_mode
Indicates whether the control is specified per port or per device group.
This setting is global for all the dhcp client protocols configured in the ixncfg
and can be configured just when handle is /globals (when the user wants to configure just the global settings)
-interval_stop
Time interval used to calculate the rate for triggering an action.
Valid for both dhcpv4 and dhcpv6 client.
-interval_start
Time interval used to calculate the rate for triggering an action.
Valid for both dhcpv4 and dhcpv6 client.
-min_lifetime
Minimum session lifetime (in seconds).
Valid for both dhcpv4 and dhcpv6 client.
-max_restarts
Maximum number of times each session is automatically restarted.
Valid for both dhcpv4 and dhcpv6 client.
-max_lifetime
Maximum session lifetime(in seconds).
Valid for both dhcpv4 and dhcpv6 client.
-enable_restart
Enable automatic session restart after stop at lifetime expiry.
Valid for both dhcpv4 and dhcpv6 client.
-enable_lifetime
Enable session lifetime.
Valid for both dhcpv4 and dhcpv6 client.
x -unlimited_restarts
x Allow each session to always be automatically restarted
x Valid for both dhcpv4 and dhcpv6 client.
-server_port
The UDP port to which the client addresses its server requests. The
default value port number is 67.
Valid for -version ixnetwork.
x -dhcp6_echo_ia_info
x If true, the DHCPv6 client will send Request messages to any server that has the
x same IA information (addresses and options) as presented in the previous
x Advertisement message.
x Valid for -version ixnetwork.
x -dhcp6_reb_max_rt
x The maximum rebind timeout value, in seconds. The default value is 600.
x Valid for -version ixnetwork.
x -dhcp6_reb_timeout
x The initial rebind timeout, in seconds. The default value is 10.
x Valid for -version ixnetwork.
x -dhcp6_rel_max_rc
x The number of release attempts. The default value is 5.
x Valid for -version ixnetwork.
x -dhcp6_rel_timeout
x The initial release timeout, in seconds. The default value is 1.
x Valid for -version ixnetwork.
x -dhcp6_ren_max_rt
x The maximum renew request timeout value, in seconds. The default value
x is 600.
x Valid for -version ixnetwork.
x -dhcp6_ren_timeout
x The initial renew timeout, in seconds. The default value is 10.
x Valid for -version ixnetwork.
x -dhcp6_req_max_rc
x The number of release attempts. The default value is 5.
x Valid for -version ixnetwork.
x -dhcp6_req_max_rt
x The maximum request timeout value, in seconds. The default value is 30.
x Valid for -version ixnetwork.
x -dhcp6_req_timeout
x The initial request timeout value, in seconds. The default value is 1.
x Valid for -version ixnetwork.
x -dhcp6_sol_max_rc
x The maximum solicit retry attempts. The default value is 3.
x Valid for -version ixnetwork.
x -dhcp6_sol_max_rt
x The maximum solicit timeout value, in seconds. The default value is 120.
x Valid for -version ixnetwork.
x -dhcp6_sol_timeout
x The Initial solicit timeout, in seconds. The default value is 1.
x Valid for -version ixnetwork.
x -dhcp6_info_req_timeout
x Initial information-request timeout value, in seconds.
x Valid for dhcpv6 client.
x -dhcp6_info_req_max_rt
x Max Information-request timeout value, in seconds.
x Valid for dhcpv6 client.
x -dhcp6_info_req_max_rc
x Info request attempts.
x Valid for dhcpv6 client.
x -msg_timeout_factor
x The value by which the timeout will be multiplied each time the response
x timeout has been reached.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_dhcp_config.py_part1
|
Valid for -version ixtclhal, ixnetwork.
-msg_timeout
Specifies the maximum time to wait in milliseconds for receipt of an
offer or ack message after the sending of a corresponding discover or
request message.
Valid for -version ixnetwork.
-outstanding_releases_count
The maximum number of release sessions opened at any time by the DHCPv6
network stack element. The default is 500.
Valid for -version ixnetwork.
-outstanding_session_count
Specifies the maximum number of outstanding sessions (unacknowledged
discover or request message) allowed to exist. In effect, this is a
rate limiting mechanism that stops dhcp servers from being
overwhelmed with reqests.
Valid for -version ixnetwork.
-port_handle
This parameter specifies the port upon which emulation is configured.
Mandatory for the modes -create and -reset.
Valid for -version ixtclhal, ixnetwork.
-release_rate
The number of addresses to release in the first second after stop command
is received. The default is 50.
Valid for -version ixnetwork.
n -release_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
-request_rate
Specifies the desired request rate in sessions per second.
Valid for -version ixnetwork.
n -request_rate_increment
n This argument defined by Cisco is not supported for NGPF implementation.
-retry_count
Limits the number of additional transmissions of either a discover or
request message when no acknowledgement is received.
Valid for -version ixnetwork.
-client_port
UDP port that the client listens on for DHCP responses.
Valid for dhcpv4 client.
-start_scale_mode
Indicates whether the control is specified per port or per device group.
This setting is global for all the dhcp client protocols configured in the ixncfg
and can be configured just when handle is /globals (when the user wants to configure just the global settings)
-stop_scale_mode
Indicates whether the control is specified per port or per device group.
This setting is global for all the dhcp client protocols configured in the ixncfg
and can be configured just when handle is /globals (when the user wants to configure just the global settings)
-sessionlifetime_scale_mode
Indicates whether the control is specified per port or per device group.
This setting is global for all the dhcp client protocols configured in the ixncfg
and can be configured just when handle is /globals (when the user wants to configure just the global settings)
-interval_stop
Time interval used to calculate the rate for triggering an action.
Valid for both dhcpv4 and dhcpv6 client.
-interval_start
Time interval used to calculate the rate for triggering an action.
Valid for both dhcpv4 and dhcpv6 client.
-min_lifetime
Minimum session lifetime (in seconds).
Valid for both dhcpv4 and dhcpv6 client.
-max_restarts
Maximum number of times each session is automatically restarted.
Valid for both dhcpv4 and dhcpv6 client.
-max_lifetime
Maximum session lifetime(in seconds).
Valid for both dhcpv4 and dhcpv6 client.
-enable_restart
Enable automatic session restart after stop at lifetime expiry.
Valid for both dhcpv4 and dhcpv6 client.
-enable_lifetime
Enable session lifetime.
Valid for both dhcpv4 and dhcpv6 client.
x -unlimited_restarts
x Allow each session to always be automatically restarted
x Valid for both dhcpv4 and dhcpv6 client.
-server_port
The UDP port to which the client addresses its server requests. The
default value port number is 67.
Valid for -version ixnetwork.
x -dhcp6_echo_ia_info
x If true, the DHCPv6 client will send Request messages to any server that has the
x same IA information (addresses and options) as presented in the previous
x Advertisement message.
x Valid for -version ixnetwork.
x -dhcp6_reb_max_rt
x The maximum rebind timeout value, in seconds. The default value is 600.
x Valid for -version ixnetwork.
x -dhcp6_reb_timeout
x The initial rebind timeout, in seconds. The default value is 10.
x Valid for -version ixnetwork.
x -dhcp6_rel_max_rc
x The number of release attempts. The default value is 5.
x Valid for -version ixnetwork.
x -dhcp6_rel_timeout
x The initial release timeout, in seconds. The default value is 1.
x Valid for -version ixnetwork.
x -dhcp6_ren_max_rt
x The maximum renew request timeout value, in seconds. The default value
x is 600.
x Valid for -version ixnetwork.
x -dhcp6_ren_timeout
x The initial renew timeout, in seconds. The default value is 10.
x Valid for -version ixnetwork.
x -dhcp6_req_max_rc
x The number of release attempts. The default value is 5.
x Valid for -version ixnetwork.
x -dhcp6_req_max_rt
x The maximum request timeout value, in seconds. The default value is 30.
x Valid for -version ixnetwork.
x -dhcp6_req_timeout
x The initial request timeout value, in seconds. The default value is 1.
x Valid for -version ixnetwork.
x -dhcp6_sol_max_rc
x The maximum solicit retry attempts. The default value is 3.
x Valid for -version ixnetwork.
x -dhcp6_sol_max_rt
x The maximum solicit timeout value, in seconds. The default value is 120.
x Valid for -version ixnetwork.
x -dhcp6_sol_timeout
x The Initial solicit timeout, in seconds. The default value is 1.
x Valid for -version ixnetwork.
x -dhcp6_info_req_timeout
x Initial information-request timeout value, in seconds.
x Valid for dhcpv6 client.
x -dhcp6_info_req_max_rt
x Max Information-request timeout value, in seconds.
x Valid for dhcpv6 client.
x -dhcp6_info_req_max_rc
x Info request attempts.
x Valid for dhcpv6 client.
x -msg_timeout_factor
x The value by which the timeout will be multiplied each time the response
x timeout has been reached.
x Valid for -version ixnetwork.
x -msg_max_timeout
x The max value, in seconds, that the discover timeout can reach though Discover Timeout Factor.
x -override_global_setup_rate
x If enabled, all the rate settings defined at the global level will be
x overridden by the rate settings defined on this port.
x Valid for -version ixnetwork.
x -override_global_teardown_rate
x If enabled, all the rate settings defined at the session level will be
x overridden by rate settings defined on this port.
x Valid for -version ixnetwork.
x -skip_release_on_stop
x If enabled, the client does not send a DHCP release packet when the stop command is given.
x Valid for both dhcpv4 and dhcpv6 client.
x -renew_on_link_up
x Indicate to renew the active DHCP sessions after link status goes down and up.
x Valid for both dhcpv4 and dhcpv6 client.
n -accept_partial_config
n This argument defined by Cisco is not supported for NGPF implementation.
n -lease_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -max_dhcp_msg_size
n This argument defined by Cisco is not supported for NGPF implementation.
n -wait_for_completion
n This argument defined by Cisco is not supported for NGPF implementation.
n -associates
n This argument defined by Cisco is not supported for NGPF implementation.
n -no_write
n This argument defined by Cisco is not supported for NGPF implementation.
n -release_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
n -request_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
n -reset
n This argument defined by Cisco is not supported for NGPF implementation.
n -version
n This argument defined by Cisco is not supported for NGPF implementation.
n -response_wait
n This argument defined by Cisco is not supported for NGPF implementation.
n -retry_timer
n This argument defined by Cisco is not supported for NGPF implementation.
x -ip_version
x DHCP Client type: IPv4 or IPv6.
x -dhcp4_arp_gw
x If enabled, DHCP clients ARP to find their Gateway MAC Addresses.
x -dhcp6_ns_gw
x If enabled, DHCP clients NS to find their Gateway MAC Addresses.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
Error message if command returns {status 0}
key:log value:Error message if command returns {status 0}
Port handle on which DHCP emulation was configured
key:handle value:Port handle on which DHCP emulation was configured
Examples:
Sample Input:
Sample Output:
Notes:
When -handle is provided with the /globals value the arguments that configure global protocol
setting accept both multivalue handles and simple values.
When -handle is provided with a a protocol stack handle or a protocol session handle, the arguments
that configure global settings will only accept simple values. In this situation, these arguments will
configure only the settings of the parent device group or the ports associated with the parent topology.
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_dhcp_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_dhcp_config.py_part2
|
x timeout has been reached.
x Valid for -version ixnetwork.
x -msg_max_timeout
x The max value, in seconds, that the discover timeout can reach though Discover Timeout Factor.
x -override_global_setup_rate
x If enabled, all the rate settings defined at the global level will be
x overridden by the rate settings defined on this port.
x Valid for -version ixnetwork.
x -override_global_teardown_rate
x If enabled, all the rate settings defined at the session level will be
x overridden by rate settings defined on this port.
x Valid for -version ixnetwork.
x -skip_release_on_stop
x If enabled, the client does not send a DHCP release packet when the stop command is given.
x Valid for both dhcpv4 and dhcpv6 client.
x -renew_on_link_up
x Indicate to renew the active DHCP sessions after link status goes down and up.
x Valid for both dhcpv4 and dhcpv6 client.
n -accept_partial_config
n This argument defined by Cisco is not supported for NGPF implementation.
n -lease_time
n This argument defined by Cisco is not supported for NGPF implementation.
n -max_dhcp_msg_size
n This argument defined by Cisco is not supported for NGPF implementation.
n -wait_for_completion
n This argument defined by Cisco is not supported for NGPF implementation.
n -associates
n This argument defined by Cisco is not supported for NGPF implementation.
n -no_write
n This argument defined by Cisco is not supported for NGPF implementation.
n -release_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
n -request_rate_max
n This argument defined by Cisco is not supported for NGPF implementation.
n -reset
n This argument defined by Cisco is not supported for NGPF implementation.
n -version
n This argument defined by Cisco is not supported for NGPF implementation.
n -response_wait
n This argument defined by Cisco is not supported for NGPF implementation.
n -retry_timer
n This argument defined by Cisco is not supported for NGPF implementation.
x -ip_version
x DHCP Client type: IPv4 or IPv6.
x -dhcp4_arp_gw
x If enabled, DHCP clients ARP to find their Gateway MAC Addresses.
x -dhcp6_ns_gw
x If enabled, DHCP clients NS to find their Gateway MAC Addresses.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
Error message if command returns {status 0}
key:log value:Error message if command returns {status 0}
Port handle on which DHCP emulation was configured
key:handle value:Port handle on which DHCP emulation was configured
Examples:
Sample Input:
Sample Output:
Notes:
When -handle is provided with the /globals value the arguments that configure global protocol
setting accept both multivalue handles and simple values.
When -handle is provided with a a protocol stack handle or a protocol session handle, the arguments
that configure global settings will only accept simple values. In this situation, these arguments will
configure only the settings of the parent device group or the ports associated with the parent topology.
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_dhcp_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_dhcp_config.py_part3
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_cfm_network_group_config(self, handle, mode, **kwargs):
r'''
#Procedure Header
Name:
emulation_cfm_network_group_config
Description:
This procedure will configure simulated MPs for CFM/Y.1731 protocol.
Synopsis:
emulation_cfm_network_group_config
-handle ANY
-mode CHOICES create modify delete
[-type CHOICES grid
CHOICES mesh
CHOICES custom
CHOICES ring
CHOICES hub-and-spoke
CHOICES tree
CHOICES ipv4-prefix
CHOICES ipv6-prefix
CHOICES fat-tree
CHOICES linear]
x [-protocol_name ALPHA]
x [-connected_to_handle ANY]
x [-return_detailed_handles CHOICES 0 1
x DEFAULT 0]
x [-enable_device_test CHOICES 0 1]
x [-hub_spoke_include_emulated_device CHOICES 0 1]
x [-hub_spoke_number_of_first_level NUMERIC]
x [-hub_spoke_number_of_second_level NUMERIC]
x [-hub_spoke_enable_level_2 CHOICES 0 1]
x [-hub_spoke_link_multiplier NUMERIC]
x [-tree_number_of_nodes NUMERIC]
x [-tree_include_emulated_device CHOICES 0 1]
x [-tree_use_tree_depth CHOICES 0 1]
x [-tree_depth NUMERIC]
x [-tree_max_children_per_node NUMERIC]
x [-tree_link_multiplier NUMERIC]
x [-linear_include_emulated_device CHOICES 0 1]
x [-linear_nodes NUMERIC]
x [-linear_link_multiplier NUMERIC]
x [-sim_topo_active CHOICES 0 1]
x [-from_Mac MAC]
x [-to_Mac MAC]
x [-system_MAC MAC]
x [-active CHOICES 0 1]
x [-links_active CHOICES 0 1]
x [-mp_type CHOICES mip mep]
x [-mep_id NUMERIC]
x [-md_mg_level NUMERIC]
x [-rd_i CHOICES rdtypeauto rdtypeon rdtypeoff]
x [-md_name_format CHOICES mdnameformatnomaintenancedomainname
x CHOICES mdnameformatdomainnamebasedstr
x CHOICES mdnameformatmacplustwooctetint
x CHOICES mdnameformatcharacterstr]
x [-md_name ALPHA]
x [-cci_interval CHOICES cciinterval333msec
x CHOICES cciinterval10msec
x CHOICES cciinterval100msec
x CHOICES cciinterval1sec
x CHOICES cciinterval10sec
x CHOICES cciinterval1min
x CHOICES cciinterval10min]
x [-short_ma_name_format CHOICES shortmanameformatprimaryvid
x CHOICES shortmanameformatcharstr
x CHOICES shortmanameformattwooctetint
x CHOICES shortmanameformatrfc2685vpnid]
x [-short_ma_name ALPHA]
x [-meg_id_format CHOICES megidformattypeiccbasedformat
x CHOICES megidformattypeprimaryvid
x CHOICES megidformattypecharstr
x CHOICES megidformattypetwooctetint
x CHOICES megidformattyperfc2685vpnid]
x [-meg_id ALPHA]
x [-dm_method CHOICES dmsupporttypetwoway
x CHOICES dmsupporttypeoneway]
x [-ais_mode CHOICES aismodeauto
x CHOICES aismodestart
x CHOICES aismodestop]
x [-ais_interval CHOICES aisinterval1sec
x CHOICES aisinterval1min]
x [-ais_enable_unicast_mac CHOICES 0 1]
x [-ais_unicast_mac MAC]
x [-enable_ais_rx CHOICES 0 1]
x [-lck_mode CHOICES lckmodeauto
x CHOICES lckmodestart
x CHOICES lckmodestop]
x [-lck_interval CHOICES lckinterval1sec
x CHOICES lckinterval1min]
x [-lck_support_ais_generation CHOICES 0 1]
x [-lck_enable_unicast_mac CHOICES 0 1]
x [-lck_unicast_mac MAC]
x [-enable_lck_rx CHOICES 0 1]
x [-tst_mode CHOICES tstmodeauto
x CHOICES tstmodestart
x CHOICES tstmodestop]
x [-tst_interval NUMERIC]
x [-tst_test_type CHOICES tsttesttypeinservice
x CHOICES tsttesttypeoutofservice]
x [-tst_enable_unicast_mac CHOICES 0 1]
x [-tst_unicast_mac MAC]
x [-tst_sequence_number NUMERIC]
x [-tst_overwrite_seq_number CHOICES 0 1]
x [-tst_pattern_type CHOICES knullsignalwocrc32
x CHOICES nullsignalwcrc32
x CHOICES prbswocrc32
x CHOICES prbswcrc32]
x [-tst_initial_pattern_value HEX]
x [-enable_tst_rx CHOICES 0 1]
x [-tst_packet_length NUMERIC]
x [-tst_increment_packet_length CHOICES 0 1]
x [-tst_increment_packet_length_step NUMERIC]
x [-enable_lm_counter_update CHOICES 0 1]
x [-lm_method_type CHOICES lmmethodtypedualended
x CHOICES lmmethodtypesingleended]
x [-ccm_lmm_txfcf NUMERIC]
x [-ccm_lmm_txFcf_step_per100mSec NUMERIC]
x [-ccm_rx_fcb NUMERIC]
x [-ccm_rx_fcb_step_per100mSec NUMERIC]
x [-lmr_tx_fcb NUMERIC]
x [-lmr_tx_fcb_step_per100mSec NUMERIC]
x [-lmr_rx_fcf NUMERIC]
x [-lmr_rx_fcf_step_per100mSec NUMERIC]
x [-inter_remote_mep_tx_increment_step NUMERIC]
x [-inter_remote_mep_rx_increment_step NUMERIC]
x [-number_of_slm NUMERIC]
x [-enable_slm_rx CHOICES 0 1]
x [-slm_simulated_loss_in_rx RANGE 0-100
x DEFAULT 0]
x [-slm_initial_txfcb NUMERIC]
x [-slm_txfcb_step NUMERIC]
x [-enable1sl_rx ANY]
x [-enable_vlan CHOICES 0 1]
x [-vlan_Stacking CHOICES vlanstackingtypesinglevlan
x CHOICES vlanstackingtypestackedvlan]
x [-vlan_id NUMERIC]
x [-vlan_priority NUMERIC]
x [-vlan_Tpid CHOICES vlantpid8100
x CHOICES vlantpid9100
x CHOICES vlantpid9200
x CHOICES vlantpid88a8]
x [-sVlan_id NUMERIC]
x [-sVlan_priority NUMERIC]
x [-sVlan_Tpid CHOICES vlantpid8100
x CHOICES vlantpid9100
x CHOICES vlantpid9200
x CHOICES vlantpid88a8]
x [-cVlan_id NUMERIC]
x [-cVlan_priority NUMERIC]
x [-cVlan_Tpid CHOICES vlantpid8100
x CHOICES vlantpid9100
x CHOICES vlantpid9200
x CHOICES vlantpid88a8]
x [-overrride_vlan_priority CHOICES 0 1]
x [-ccm_priority NUMERIC]
x [-ltm_priority NUMERIC]
x [-lbm_priority NUMERIC]
x [-dm_priority NUMERIC]
x [-ais_priority NUMERIC]
x [-lck_priority NUMERIC]
x [-tst_priority NUMERIC]
x [-lmm_priority NUMERIC]
x [-lmr_priority NUMERIC]
x [-enable_auto_lt CHOICES 0 1]
x [-auto_lt_timer_in_sec NUMERIC]
x [-auto_lt_iteration NUMERIC]
x [-auto_lt_timeout_in_sec NUMERIC]
x [-auto_lt_ttl NUMERIC]
x [-lt_all_remote_meps CHOICES 0 1]
x [-lt_destination_mac_address MAC]
x [-enable_auto_lb CHOICES 0 1]
x [-auto_lb_timer_in_sec NUMERIC]
x [-auto_lb_iteration NUMERIC]
x [-auto_lb_timeout_in_sec NUMERIC]
x [-lb_all_remote_meps CHOICES 0 1]
x [-lb_destination_mac_address MAC]
x [-enable_auto_dm CHOICES 0 1]
x [-auto_dm_timer_in_sec NUMERIC]
x [-auto_dm_iteration NUMERIC]
x [-auto_dm_timeout_in_sec NUMERIC]
x [-dm_all_remote_meps CHOICES 0 1]
x [-dm_destination_mac_address MAC]
x [-enable_auto_lm CHOICES 0 1]
x [-auto_lm_timer_in_sec NUMERIC]
x [-auto_lm_iteration NUMERIC]
x [-auto_lm_timeout_in_sec NUMERIC]
x [-lm_all_remote_meps CHOICES 0 1]
x [-lm_destination_mac_address MAC]
x [-enable_sender_id_tlv CHOICES 0 1]
x [-chassis_id_sub_type CHOICES chassisidsubtypechassiscomponent
x CHOICES chassisidsubtypeinterfacealias
x CHOICES chassisidsubtypeportcomponent
x CHOICES chassisidsubtypemacaddress
x CHOICES chassisidsubtypenetworkaddress
x CHOICES chassisidsubtypeinterfacename
x CHOICES chassisidsubtypelocallyassigned]
x [-chassis_id_length NUMERIC]
x [-chassis_id HEX]
x [-management_address_domain_length NUMERIC]
x [-management_address_domain HEX]
x [-management_address_length NUMERIC]
x [-management_address HEX]
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_cfm_network_group_config.py_part1
|
x CHOICES prbswcrc32]
x [-tst_initial_pattern_value HEX]
x [-enable_tst_rx CHOICES 0 1]
x [-tst_packet_length NUMERIC]
x [-tst_increment_packet_length CHOICES 0 1]
x [-tst_increment_packet_length_step NUMERIC]
x [-enable_lm_counter_update CHOICES 0 1]
x [-lm_method_type CHOICES lmmethodtypedualended
x CHOICES lmmethodtypesingleended]
x [-ccm_lmm_txfcf NUMERIC]
x [-ccm_lmm_txFcf_step_per100mSec NUMERIC]
x [-ccm_rx_fcb NUMERIC]
x [-ccm_rx_fcb_step_per100mSec NUMERIC]
x [-lmr_tx_fcb NUMERIC]
x [-lmr_tx_fcb_step_per100mSec NUMERIC]
x [-lmr_rx_fcf NUMERIC]
x [-lmr_rx_fcf_step_per100mSec NUMERIC]
x [-inter_remote_mep_tx_increment_step NUMERIC]
x [-inter_remote_mep_rx_increment_step NUMERIC]
x [-number_of_slm NUMERIC]
x [-enable_slm_rx CHOICES 0 1]
x [-slm_simulated_loss_in_rx RANGE 0-100
x DEFAULT 0]
x [-slm_initial_txfcb NUMERIC]
x [-slm_txfcb_step NUMERIC]
x [-enable1sl_rx ANY]
x [-enable_vlan CHOICES 0 1]
x [-vlan_Stacking CHOICES vlanstackingtypesinglevlan
x CHOICES vlanstackingtypestackedvlan]
x [-vlan_id NUMERIC]
x [-vlan_priority NUMERIC]
x [-vlan_Tpid CHOICES vlantpid8100
x CHOICES vlantpid9100
x CHOICES vlantpid9200
x CHOICES vlantpid88a8]
x [-sVlan_id NUMERIC]
x [-sVlan_priority NUMERIC]
x [-sVlan_Tpid CHOICES vlantpid8100
x CHOICES vlantpid9100
x CHOICES vlantpid9200
x CHOICES vlantpid88a8]
x [-cVlan_id NUMERIC]
x [-cVlan_priority NUMERIC]
x [-cVlan_Tpid CHOICES vlantpid8100
x CHOICES vlantpid9100
x CHOICES vlantpid9200
x CHOICES vlantpid88a8]
x [-overrride_vlan_priority CHOICES 0 1]
x [-ccm_priority NUMERIC]
x [-ltm_priority NUMERIC]
x [-lbm_priority NUMERIC]
x [-dm_priority NUMERIC]
x [-ais_priority NUMERIC]
x [-lck_priority NUMERIC]
x [-tst_priority NUMERIC]
x [-lmm_priority NUMERIC]
x [-lmr_priority NUMERIC]
x [-enable_auto_lt CHOICES 0 1]
x [-auto_lt_timer_in_sec NUMERIC]
x [-auto_lt_iteration NUMERIC]
x [-auto_lt_timeout_in_sec NUMERIC]
x [-auto_lt_ttl NUMERIC]
x [-lt_all_remote_meps CHOICES 0 1]
x [-lt_destination_mac_address MAC]
x [-enable_auto_lb CHOICES 0 1]
x [-auto_lb_timer_in_sec NUMERIC]
x [-auto_lb_iteration NUMERIC]
x [-auto_lb_timeout_in_sec NUMERIC]
x [-lb_all_remote_meps CHOICES 0 1]
x [-lb_destination_mac_address MAC]
x [-enable_auto_dm CHOICES 0 1]
x [-auto_dm_timer_in_sec NUMERIC]
x [-auto_dm_iteration NUMERIC]
x [-auto_dm_timeout_in_sec NUMERIC]
x [-dm_all_remote_meps CHOICES 0 1]
x [-dm_destination_mac_address MAC]
x [-enable_auto_lm CHOICES 0 1]
x [-auto_lm_timer_in_sec NUMERIC]
x [-auto_lm_iteration NUMERIC]
x [-auto_lm_timeout_in_sec NUMERIC]
x [-lm_all_remote_meps CHOICES 0 1]
x [-lm_destination_mac_address MAC]
x [-enable_sender_id_tlv CHOICES 0 1]
x [-chassis_id_sub_type CHOICES chassisidsubtypechassiscomponent
x CHOICES chassisidsubtypeinterfacealias
x CHOICES chassisidsubtypeportcomponent
x CHOICES chassisidsubtypemacaddress
x CHOICES chassisidsubtypenetworkaddress
x CHOICES chassisidsubtypeinterfacename
x CHOICES chassisidsubtypelocallyassigned]
x [-chassis_id_length NUMERIC]
x [-chassis_id HEX]
x [-management_address_domain_length NUMERIC]
x [-management_address_domain HEX]
x [-management_address_length NUMERIC]
x [-management_address HEX]
x [-enable_interface_status_tlv CHOICES 0 1]
x [-enable_port_status_tlv CHOICES 0 1]
x [-enable_data_tlv CHOICES 0 1]
x [-data_tlv_length NUMERIC]
x [-data_tlv_value HEX]
x [-enable_organization_specific_tlv CHOICES 0 1]
x [-organization_specific_tlv_length NUMERIC]
x [-organization_data_tlv_value HEX]
x [-number_of_custom_tlvs NUMERIC]
x [-tlv_type ANY]
x [-tlv_length ANY]
x [-value ANY]
x [-include_tlv_in_ccm CHOICES 0 1]
x [-include_tlv_in_ltm CHOICES 0 1]
x [-include_tlv_in_ltr CHOICES 0 1]
x [-include_tlv_in_lbm CHOICES 0 1]
x [-include_tlv_in_lbr CHOICES 0 1]
x [-include_tlv_in_lmm CHOICES 0 1]
x [-include_tlv_in_lmr CHOICES 0 1]
x [-slm_mode CHOICES slmmodesingleended
x CHOICES slmmodedualended]
x [-slm_proactive_start CHOICES 0 1]
x [-slm_frames_per_burst RANGE 1-1000
x DEFAULT 1]
x [-slm_burst_gap RANGE 1-100000
x DEFAULT 100]
x [-slm_continuous_burst CHOICES 0 1]
x [-slm_burst_count NUMERIC]
x [-slm_destination_type CHOICES slmdestinationmulticast
x CHOICES slmdestinationallrmep
x CHOICES slmdestinationunicast]
x [-slm_unicast_mac MAC]
x [-slm_auto_test_id CHOICES 0 1]
x [-slm_test_id NUMERIC]
x [-slm_initial_txfcf NUMERIC]
x [-slm_flags HEX]
x [-slm_override_priority CHOICES 0 1]
x [-slm_priority RANGE 0-7
x DEFAULT 0]
x [-slm_simulated_loss_in_tx RANGE 0-100
x DEFAULT 0]
x [-slm_frame_size RANGE 64-1500
x DEFAULT 64]
Arguments:
-handle
For create and modify -mode, handle should be its parent Ethernet node handle.
For delete -mode, -handle should be its own handle i.e CFM Bridge node handle.
Simulated Router Bridge
For create and modifiy -mode, hnadle should be its parent Bridge node handle.
For delete -mode, -handle should be its own handle i.e MP node handle.
-mode
This option defines the action to be taken on the CFM Bridge.
-type
The type of topology route to create.
x -protocol_name
x -connected_to_handle
x Scenario element this connector is connecting to
x -return_detailed_handles
x This argument determines if individual interface, session or router handles are returned by the current command.
x This applies only to the command on which it is specified.
x Setting this to 0 means that only NGPF-specific protocol stack handles will be returned. This will significantly
x decrease the size of command results and speed up script execution.
x The default is 0, meaning only protocol stack handles will be returned.
x -enable_device_test
x enables/disables device.
x -hub_spoke_include_emulated_device
x -hub_spoke_number_of_first_level
x -hub_spoke_number_of_second_level
x -hub_spoke_enable_level_2
x -hub_spoke_link_multiplier
x -tree_number_of_nodes
x -tree_include_emulated_device
x -tree_use_tree_depth
x -tree_depth
x -tree_max_children_per_node
x -tree_link_multiplier
x -linear_include_emulated_device
x -linear_nodes
x number of nodes
x -linear_link_multiplier
x number of links between two nodes
x -sim_topo_active
x Active Simulated Topology Config
x -from_Mac
x -to_Mac
x -system_MAC
x -active
x -links_active
x -mp_type
x -mep_id
x -md_mg_level
x -rd_i
x -md_name_format
x -md_name
x -cci_interval
x -short_ma_name_format
x -short_ma_name
x Short MA Name
x -meg_id_format
x -meg_id
x MEG ID
x -dm_method
x -ais_mode
x -ais_interval
x -ais_enable_unicast_mac
x -ais_unicast_mac
x -enable_ais_rx
x -lck_mode
x -lck_interval
x -lck_support_ais_generation
x -lck_enable_unicast_mac
x -lck_unicast_mac
x -enable_lck_rx
x -tst_mode
x -tst_interval
x -tst_test_type
x -tst_enable_unicast_mac
x -tst_unicast_mac
x -tst_sequence_number
x -tst_overwrite_seq_number
x -tst_pattern_type
x -tst_initial_pattern_value
x -enable_tst_rx
x -tst_packet_length
x -tst_increment_packet_length
x -tst_increment_packet_length_step
x -enable_lm_counter_update
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_cfm_network_group_config.py_part2
|
x [-enable_interface_status_tlv CHOICES 0 1]
x [-enable_port_status_tlv CHOICES 0 1]
x [-enable_data_tlv CHOICES 0 1]
x [-data_tlv_length NUMERIC]
x [-data_tlv_value HEX]
x [-enable_organization_specific_tlv CHOICES 0 1]
x [-organization_specific_tlv_length NUMERIC]
x [-organization_data_tlv_value HEX]
x [-number_of_custom_tlvs NUMERIC]
x [-tlv_type ANY]
x [-tlv_length ANY]
x [-value ANY]
x [-include_tlv_in_ccm CHOICES 0 1]
x [-include_tlv_in_ltm CHOICES 0 1]
x [-include_tlv_in_ltr CHOICES 0 1]
x [-include_tlv_in_lbm CHOICES 0 1]
x [-include_tlv_in_lbr CHOICES 0 1]
x [-include_tlv_in_lmm CHOICES 0 1]
x [-include_tlv_in_lmr CHOICES 0 1]
x [-slm_mode CHOICES slmmodesingleended
x CHOICES slmmodedualended]
x [-slm_proactive_start CHOICES 0 1]
x [-slm_frames_per_burst RANGE 1-1000
x DEFAULT 1]
x [-slm_burst_gap RANGE 1-100000
x DEFAULT 100]
x [-slm_continuous_burst CHOICES 0 1]
x [-slm_burst_count NUMERIC]
x [-slm_destination_type CHOICES slmdestinationmulticast
x CHOICES slmdestinationallrmep
x CHOICES slmdestinationunicast]
x [-slm_unicast_mac MAC]
x [-slm_auto_test_id CHOICES 0 1]
x [-slm_test_id NUMERIC]
x [-slm_initial_txfcf NUMERIC]
x [-slm_flags HEX]
x [-slm_override_priority CHOICES 0 1]
x [-slm_priority RANGE 0-7
x DEFAULT 0]
x [-slm_simulated_loss_in_tx RANGE 0-100
x DEFAULT 0]
x [-slm_frame_size RANGE 64-1500
x DEFAULT 64]
Arguments:
-handle
For create and modify -mode, handle should be its parent Ethernet node handle.
For delete -mode, -handle should be its own handle i.e CFM Bridge node handle.
Simulated Router Bridge
For create and modifiy -mode, hnadle should be its parent Bridge node handle.
For delete -mode, -handle should be its own handle i.e MP node handle.
-mode
This option defines the action to be taken on the CFM Bridge.
-type
The type of topology route to create.
x -protocol_name
x -connected_to_handle
x Scenario element this connector is connecting to
x -return_detailed_handles
x This argument determines if individual interface, session or router handles are returned by the current command.
x This applies only to the command on which it is specified.
x Setting this to 0 means that only NGPF-specific protocol stack handles will be returned. This will significantly
x decrease the size of command results and speed up script execution.
x The default is 0, meaning only protocol stack handles will be returned.
x -enable_device_test
x enables/disables device.
x -hub_spoke_include_emulated_device
x -hub_spoke_number_of_first_level
x -hub_spoke_number_of_second_level
x -hub_spoke_enable_level_2
x -hub_spoke_link_multiplier
x -tree_number_of_nodes
x -tree_include_emulated_device
x -tree_use_tree_depth
x -tree_depth
x -tree_max_children_per_node
x -tree_link_multiplier
x -linear_include_emulated_device
x -linear_nodes
x number of nodes
x -linear_link_multiplier
x number of links between two nodes
x -sim_topo_active
x Active Simulated Topology Config
x -from_Mac
x -to_Mac
x -system_MAC
x -active
x -links_active
x -mp_type
x -mep_id
x -md_mg_level
x -rd_i
x -md_name_format
x -md_name
x -cci_interval
x -short_ma_name_format
x -short_ma_name
x Short MA Name
x -meg_id_format
x -meg_id
x MEG ID
x -dm_method
x -ais_mode
x -ais_interval
x -ais_enable_unicast_mac
x -ais_unicast_mac
x -enable_ais_rx
x -lck_mode
x -lck_interval
x -lck_support_ais_generation
x -lck_enable_unicast_mac
x -lck_unicast_mac
x -enable_lck_rx
x -tst_mode
x -tst_interval
x -tst_test_type
x -tst_enable_unicast_mac
x -tst_unicast_mac
x -tst_sequence_number
x -tst_overwrite_seq_number
x -tst_pattern_type
x -tst_initial_pattern_value
x -enable_tst_rx
x -tst_packet_length
x -tst_increment_packet_length
x -tst_increment_packet_length_step
x -enable_lm_counter_update
x -lm_method_type
x -ccm_lmm_txfcf
x -ccm_lmm_txFcf_step_per100mSec
x -ccm_rx_fcb
x -ccm_rx_fcb_step_per100mSec
x -lmr_tx_fcb
x -lmr_tx_fcb_step_per100mSec
x -lmr_rx_fcf
x -lmr_rx_fcf_step_per100mSec
x -inter_remote_mep_tx_increment_step
x -inter_remote_mep_rx_increment_step
x -number_of_slm
x Number of SLM
x -enable_slm_rx
x Enable SLM Rx
x -slm_simulated_loss_in_rx
x Simulated Loss
x -slm_initial_txfcb
x Initial TxFCf
x -slm_txfcb_step
x TxFCf Step
x -enable1sl_rx
x Enable 1SL Rx
x -enable_vlan
x -vlan_Stacking
x -vlan_id
x -vlan_priority
x -vlan_Tpid
x -sVlan_id
x -sVlan_priority
x -sVlan_Tpid
x -cVlan_id
x -cVlan_priority
x -cVlan_Tpid
x -overrride_vlan_priority
x -ccm_priority
x -ltm_priority
x -lbm_priority
x -dm_priority
x -ais_priority
x -lck_priority
x -tst_priority
x -lmm_priority
x -lmr_priority
x -enable_auto_lt
x -auto_lt_timer_in_sec
x -auto_lt_iteration
x -auto_lt_timeout_in_sec
x -auto_lt_ttl
x -lt_all_remote_meps
x -lt_destination_mac_address
x -enable_auto_lb
x -auto_lb_timer_in_sec
x -auto_lb_iteration
x -auto_lb_timeout_in_sec
x -lb_all_remote_meps
x -lb_destination_mac_address
x -enable_auto_dm
x -auto_dm_timer_in_sec
x -auto_dm_iteration
x -auto_dm_timeout_in_sec
x -dm_all_remote_meps
x -dm_destination_mac_address
x -enable_auto_lm
x -auto_lm_timer_in_sec
x -auto_lm_iteration
x -auto_lm_timeout_in_sec
x -lm_all_remote_meps
x -lm_destination_mac_address
x -enable_sender_id_tlv
x -chassis_id_sub_type
x -chassis_id_length
x -chassis_id
x -management_address_domain_length
x -management_address_domain
x -management_address_length
x -management_address
x -enable_interface_status_tlv
x -enable_port_status_tlv
x -enable_data_tlv
x -data_tlv_length
x -data_tlv_value
x -enable_organization_specific_tlv
x -organization_specific_tlv_length
x -organization_data_tlv_value
x -number_of_custom_tlvs
x Number Of TLVs
x -tlv_type
x Type
x -tlv_length
x Length
x -value
x Value
x -include_tlv_in_ccm
x -include_tlv_in_ltm
x -include_tlv_in_ltr
x -include_tlv_in_lbm
x -include_tlv_in_lbr
x -include_tlv_in_lmm
x -include_tlv_in_lmr
x -slm_mode
x Mode
x -slm_proactive_start
x Proactive Start
x -slm_frames_per_burst
x Frames Per Burst
x -slm_burst_gap
x Burst Gap in milisec
x -slm_continuous_burst
x Continuous Burst.
x -slm_burst_count
x Burst Count.
x -slm_destination_type
x Destination
x -slm_unicast_mac
x Unicast MAC
x -slm_auto_test_id
x Auto Generate Test ID
x -slm_test_id
x Test ID
x -slm_initial_txfcf
x Initial TxFCf
x -slm_flags
x Flags
x -slm_override_priority
x Override Priority
x -slm_priority
x Priority
x -slm_simulated_loss_in_tx
x Simulated Loss
x -slm_frame_size
x Frame Size
Return Values:
A list containing the network group protocol stack handles that were added by the command (if any).
x key:network_group_handle value:A list containing the network group protocol stack handles that were added by the command (if any).
A list containing the simulated topology protocol stack handles that were added by the command (if any).
x key:simulated_topology_handle value:A list containing the simulated topology protocol stack handles that were added by the command (if any).
A list containing the simulated interface protocol stack handles that were added by the command (if any).
x key:simulated_interface_handle value:A list containing the simulated interface protocol stack handles that were added by the command (if any).
A list containing the simulated rbridge protocol stack handles that were added by the command (if any).
x key:simulated_rbridge_handle value:A list containing the simulated rbridge protocol stack handles that were added by the command (if any).
A list containing the cfm simulated mp protocol stack handles that were added by the command (if any).
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_cfm_network_group_config.py_part3
|
x -enable_lm_counter_update
x -lm_method_type
x -ccm_lmm_txfcf
x -ccm_lmm_txFcf_step_per100mSec
x -ccm_rx_fcb
x -ccm_rx_fcb_step_per100mSec
x -lmr_tx_fcb
x -lmr_tx_fcb_step_per100mSec
x -lmr_rx_fcf
x -lmr_rx_fcf_step_per100mSec
x -inter_remote_mep_tx_increment_step
x -inter_remote_mep_rx_increment_step
x -number_of_slm
x Number of SLM
x -enable_slm_rx
x Enable SLM Rx
x -slm_simulated_loss_in_rx
x Simulated Loss
x -slm_initial_txfcb
x Initial TxFCf
x -slm_txfcb_step
x TxFCf Step
x -enable1sl_rx
x Enable 1SL Rx
x -enable_vlan
x -vlan_Stacking
x -vlan_id
x -vlan_priority
x -vlan_Tpid
x -sVlan_id
x -sVlan_priority
x -sVlan_Tpid
x -cVlan_id
x -cVlan_priority
x -cVlan_Tpid
x -overrride_vlan_priority
x -ccm_priority
x -ltm_priority
x -lbm_priority
x -dm_priority
x -ais_priority
x -lck_priority
x -tst_priority
x -lmm_priority
x -lmr_priority
x -enable_auto_lt
x -auto_lt_timer_in_sec
x -auto_lt_iteration
x -auto_lt_timeout_in_sec
x -auto_lt_ttl
x -lt_all_remote_meps
x -lt_destination_mac_address
x -enable_auto_lb
x -auto_lb_timer_in_sec
x -auto_lb_iteration
x -auto_lb_timeout_in_sec
x -lb_all_remote_meps
x -lb_destination_mac_address
x -enable_auto_dm
x -auto_dm_timer_in_sec
x -auto_dm_iteration
x -auto_dm_timeout_in_sec
x -dm_all_remote_meps
x -dm_destination_mac_address
x -enable_auto_lm
x -auto_lm_timer_in_sec
x -auto_lm_iteration
x -auto_lm_timeout_in_sec
x -lm_all_remote_meps
x -lm_destination_mac_address
x -enable_sender_id_tlv
x -chassis_id_sub_type
x -chassis_id_length
x -chassis_id
x -management_address_domain_length
x -management_address_domain
x -management_address_length
x -management_address
x -enable_interface_status_tlv
x -enable_port_status_tlv
x -enable_data_tlv
x -data_tlv_length
x -data_tlv_value
x -enable_organization_specific_tlv
x -organization_specific_tlv_length
x -organization_data_tlv_value
x -number_of_custom_tlvs
x Number Of TLVs
x -tlv_type
x Type
x -tlv_length
x Length
x -value
x Value
x -include_tlv_in_ccm
x -include_tlv_in_ltm
x -include_tlv_in_ltr
x -include_tlv_in_lbm
x -include_tlv_in_lbr
x -include_tlv_in_lmm
x -include_tlv_in_lmr
x -slm_mode
x Mode
x -slm_proactive_start
x Proactive Start
x -slm_frames_per_burst
x Frames Per Burst
x -slm_burst_gap
x Burst Gap in milisec
x -slm_continuous_burst
x Continuous Burst.
x -slm_burst_count
x Burst Count.
x -slm_destination_type
x Destination
x -slm_unicast_mac
x Unicast MAC
x -slm_auto_test_id
x Auto Generate Test ID
x -slm_test_id
x Test ID
x -slm_initial_txfcf
x Initial TxFCf
x -slm_flags
x Flags
x -slm_override_priority
x Override Priority
x -slm_priority
x Priority
x -slm_simulated_loss_in_tx
x Simulated Loss
x -slm_frame_size
x Frame Size
Return Values:
A list containing the network group protocol stack handles that were added by the command (if any).
x key:network_group_handle value:A list containing the network group protocol stack handles that were added by the command (if any).
A list containing the simulated topology protocol stack handles that were added by the command (if any).
x key:simulated_topology_handle value:A list containing the simulated topology protocol stack handles that were added by the command (if any).
A list containing the simulated interface protocol stack handles that were added by the command (if any).
x key:simulated_interface_handle value:A list containing the simulated interface protocol stack handles that were added by the command (if any).
A list containing the simulated rbridge protocol stack handles that were added by the command (if any).
x key:simulated_rbridge_handle value:A list containing the simulated rbridge protocol stack handles that were added by the command (if any).
A list containing the cfm simulated mp protocol stack handles that were added by the command (if any).
x key:cfm_simulated_mp value:A list containing the cfm simulated mp protocol stack handles that were added by the command (if any).
A list containing the cfm simulated slm protocol stack handles that were added by the command (if any).
x key:cfm_simulated_slm value:A list containing the cfm simulated slm protocol stack handles that were added by the command (if any).
A list containing the pseudo node custom tlv protocol stack handles that were added by the command (if any).
x key:pseudo_node_custom_tlv_handle value:A list containing the pseudo node custom tlv protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:simulated_topology_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:simulated_interface_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:simulated_rbridge_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:pseudo_node_custom_tlv_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Examples:
Sample Input:
Sample Output:
Notes:
Coded versus functional specification.
1) You can configure multiple CFM on each Ixia interface.
2) You can configure multiple Y1731.
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: simulated_topology_handles, simulated_interface_handles, simulated_rbridge_handles, pseudo_node_custom_tlv_handles
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_cfm_network_group_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_cfm_network_group_config.py_part4
|
A list containing the cfm simulated mp protocol stack handles that were added by the command (if any).
x key:cfm_simulated_mp value:A list containing the cfm simulated mp protocol stack handles that were added by the command (if any).
A list containing the cfm simulated slm protocol stack handles that were added by the command (if any).
x key:cfm_simulated_slm value:A list containing the cfm simulated slm protocol stack handles that were added by the command (if any).
A list containing the pseudo node custom tlv protocol stack handles that were added by the command (if any).
x key:pseudo_node_custom_tlv_handle value:A list containing the pseudo node custom tlv protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:simulated_topology_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:simulated_interface_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:simulated_rbridge_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:pseudo_node_custom_tlv_handles value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
Examples:
Sample Input:
Sample Output:
Notes:
Coded versus functional specification.
1) You can configure multiple CFM on each Ixia interface.
2) You can configure multiple Y1731.
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: simulated_topology_handles, simulated_interface_handles, simulated_rbridge_handles, pseudo_node_custom_tlv_handles
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_cfm_network_group_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_cfm_network_group_config.py_part5
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_netconf_client_config(self, mode, **kwargs):
r'''
#Procedure Header
Name:
emulation_netconf_client_config
Description:
This procedure will add and configure Netconf Client to a particular Ixia Interface.
Synopsis:
emulation_netconf_client_config
-mode CHOICES create
CHOICES delete
CHOICES modify
CHOICES enable
CHOICES disable
[-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
[-handle ANY]
x [-netconf_client_active ANY]
x [-netconf_client_name ALPHA]
x [-multiplier NUMERIC]
x [-server_ipv4_address ANY]
x [-server_ipv4_address_step ANY]
x [-number_of_command_snippets_per_client NUMERIC]
x [-port_number ANY]
x [-fetch_schema_info ANY]
x [-schema_output_directory ALPHA]
x [-send_close_on_stop ANY]
x [-do_not_validate_server_response ANY]
x [-capabilities_base1_dot0 ANY]
x [-capabilities_base1_dot1 ANY]
x [-capabilities_writable_running ANY]
x [-capabilities_candidate ANY]
x [-capabilities_rollback_on_error ANY]
x [-capabilities_startup ANY]
x [-capabilities_url ANY]
x [-capabilities_xpath ANY]
x [-capabilities_confirmed_commit ANY]
x [-capabilities_validate ANY]
x [-capabilities_notification ANY]
x [-capabilities_interleave ANY]
x [-ssh_authentication_mechanism CHOICES noauthentication
x CHOICES usernamepassword
x CHOICES keybased]
x [-user_name ALPHA]
x [-password ALPHA]
x [-private_key_directory ALPHA]
x [-private_key_file_name ALPHA]
x [-enable_passphrase ANY]
x [-passphrase ALPHA]
x [-output_directory ALPHA]
x [-decrypted_capture ANY]
x [-save_reply_x_m_l ANY]
x [-log_clean_up_option CHOICES clean notClean]
x [-log_file_age NUMERIC]
x [-command_snippets_data_active ANY]
x [-command_snippet_directory ALPHA]
x [-command_snippet_file ALPHA]
x [-transmission_behaviour CHOICES dontsend
x CHOICES once
x CHOICES periodiccontinuous
x CHOICES periodicfixedcount]
x [-periodic_transmission_interval ANY]
x [-transmission_count ANY]
Arguments:
-mode
This option defines whether to Create/Modify/Delete/Enable/Disable Netconf Client.
-port_handle
Port handle.
-handle
Specifies the parent node handle ( For ex : IP stack output of interface_config) on which the Netconf cleint is configured.
The Netconf client handle(s) are returned by the procedure "emulation_netconf_client_config" when configuring Netconf client on the Ixia interface.
For modify -mode, -handle can be Netconf Client's or Command Snippets' node handle.
For delete -mode, -handle is Netconf Client's node handle.
For enable/disable -mode, -handle can be Netconf Client's or Command Snippets' node handle or session(item) handle of these nodes.
x -netconf_client_active
x Activate/Deactivate Netconf Client Configuration.
x -netconf_client_name
x Name of NGPF element, guaranteed to be unique in Scenario
x -multiplier
x Number of layer instances per parent instance (multiplier)
x -server_ipv4_address
x Specify the IPv4 address of the DUT to which the Netconf Server should connect.
x -server_ipv4_address_step
x Step argument of Source IPv4 address
x -number_of_command_snippets_per_client
x Number of Command Snippets per client.Maximum 100 are allowed per client.
x -port_number
x The TCP Port Number the Netconf Server is listening on to which to connect.
x -fetch_schema_info
x Whether a get-schema operation will be performed after capability exchange
x -schema_output_directory
x Location of Directory in Client where the retrieved modules will be stored.
x -send_close_on_stop
x This specifies whether a close-session message will be sent on stopping this client.
x -do_not_validate_server_response
x If this option is enabled, the Netconf client will not parse server responses. Use this option to optimize memory usage in the client.
x -capabilities_base1_dot0
x Whether base1.0 support should be advertised in Capabilities.
x -capabilities_base1_dot1
x Whether base1.1 support should be advertised in Capabilities.
x -capabilities_writable_running
x Whether supports capability writable-running to directly modify running config.
x -capabilities_candidate
x Whether supports capability candidate to make changes into an intermediate candidate database. Normally this is preferred over writable-running.
x -capabilities_rollback_on_error
x Whether supports capability rollback to rollback partial changes make changes on detection of error during validate or commit.
x -capabilities_startup
x Whether supports capability startup to make changes in config persistent on device restart.
x -capabilities_url
x Whether supports capability url to specify netconf commands using url.
x -capabilities_xpath
x Whether supports capability xpath to specify netconf commands and filters using xpath extensions.
x -capabilities_confirmed_commit
x Whether supports capability confirmed-commit to specify ability to commit a group of commands or none as a batch.
x -capabilities_validate
x Whether supports capability validate to specify ability to validate a netconf command prior to commit.
x -capabilities_notification
x Whether supports capability notification to aynchronously handle notifications from Netconf server device connected to.
x -capabilities_interleave
x Whether supports capability interleave to interleave notifications and responses.
x -ssh_authentication_mechanism
x The authentication mechanism for connecting to Netconf Server.
x -user_name
x Username for Username/Password mode and also used for Key-based Authentication as the username.
x -password
x Password for Username/Password mode.
x -private_key_directory
x File containing Private Key.(e.g. generated using ssh_keygen) . For multiple clients and assymetric key file names
x ( which cannot be expressed easily as a pattern) please explore "File" option in Master Row Pattern Editor by putting the file names
x in a .csv and pulling those values into the column cells.
x -private_key_file_name
x File containing Private Key.(e.g. generated using ssh_keygen) . For multiple clients and assymetric key file names
x ( which cannot be expressed easily as a pattern) please explore "File" option in Master Row Pattern Editor by putting the file names
x in a .csv and pulling those values into the column cells.
x -enable_passphrase
x If the Private Key was passphrase protected, this should be enabled to allow configuration of passphrase used.
x -passphrase
x The passphrase with which the Private Key was additionally protected during generation. For multiple clients and assymetric passphrases
x ( which cannot be expressed easily as a pattern) please explore "File" option in Master Row Pattern Editor by putting the file names
x in a .csv and pulling those values into the column cells.
x -output_directory
x Location of Directory in Client where the decrypted capture, if enabled, and server replies, if enabled,will be stored.
x -decrypted_capture
x Whether SSH packets for this session will be captured and stored on client in decrypted form.
x Note that this is not linked to IxNetwork control or data capture which will capture the packets in encrypted format only.
x Also note that this option should be avoided if Continuous Tranmission mode is enabled for any of the Command Snippets which can lead
x to huge capture files being generated which could in turn affect Stop time since during Stop, the captures are transferred to the client.
x The Decrypted Capture can be viewed by either doing right-click on a client where this option is enabled and doing "Get Decrypted Capture"
x ( allowed on 5 clients at a time ; each of the captures will be opened in a new Wireshark pop-up) OR by stopping the client and then directly
x opening it from the configured Output Directory from inside the current run folder/capture.
x This option can be enabled even when a session is already up in which case the capture will be started from that point of time.
x -save_reply_x_m_l
x If this is enabled, Hellos and replies to commands sent via Command Snippets or global command (such as 'get') by the Netconf Server will be stored in the Output Directory
x in current run folder/Replies. Any RPC errors recieved will be stored in a separate Error directory for convenience of debugging error scenarios.
x This option can be enabled even when a session is already up in which case the replies will be saved from that point of time.
x -log_clean_up_option
x Debug Log Clean Up
x -log_file_age
x This field determines how old logs to be deleted.
x -command_snippets_data_active
x Activate/Deactivate Command Snippets Data.
x -command_snippet_directory
x Directory containing XML based Netconf compliant command snippets.
x -command_snippet_file
x File containing XML based Netconf compliant command snippet. For multiple command snippets with assymetric file names
x ( which cannot be expressed easily as a pattern) please explore "File" option in Master Row Pattern Editor by putting the file names
x in a .csv and pulling those values into the column cells.
x -transmission_behaviour
x Transmission behaviour for command snippet.
x Don't Send : This means that command will not be automatically executed. This choice should be
x used if user wants to control the order or/and timing of sending the command snippet to the DUT
x using Test Composer or Automation Script.
x Once: The command will be sent only once to the DUT every time session comes up with the DUT.
x Periodic - Continuous: The command will be sent every Transmission Interval for the full lifetime of the session.Capture should be enabled with care if this option is selected.
x Periodic - Fixed Count: The command will be sent Transmission Count number of times, every Periodic Transmission Interval.
x -periodic_transmission_interval
x Minimum interval between scheduling of two transmits of the Command Snippet.
x -transmission_count
x Number of times to transmit the Command Snippet.
Return Values:
A list containing the ipv4 loopback protocol stack handles that were added by the command (if any).
x key:ipv4_loopback_handle value:A list containing the ipv4 loopback protocol stack handles that were added by the command (if any).
A list containing the ipv4 protocol stack handles that were added by the command (if any).
x key:ipv4_handle value:A list containing the ipv4 protocol stack handles that were added by the command (if any).
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
When status is $::FAILURE, log shows the detailed information of failure.
key:log value:When status is $::FAILURE, log shows the detailed information of failure.
Handle of Netconf Client configured
key:netconf_client_handle value:Handle of Netconf Client configured
Handle of Command Snippets Data configured
key:command_snippets_data_handle value:Handle of Command Snippets Data configured
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_netconf_client_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_netconf_client_config.py_part1
|
x Whether supports capability notification to aynchronously handle notifications from Netconf server device connected to.
x -capabilities_interleave
x Whether supports capability interleave to interleave notifications and responses.
x -ssh_authentication_mechanism
x The authentication mechanism for connecting to Netconf Server.
x -user_name
x Username for Username/Password mode and also used for Key-based Authentication as the username.
x -password
x Password for Username/Password mode.
x -private_key_directory
x File containing Private Key.(e.g. generated using ssh_keygen) . For multiple clients and assymetric key file names
x ( which cannot be expressed easily as a pattern) please explore "File" option in Master Row Pattern Editor by putting the file names
x in a .csv and pulling those values into the column cells.
x -private_key_file_name
x File containing Private Key.(e.g. generated using ssh_keygen) . For multiple clients and assymetric key file names
x ( which cannot be expressed easily as a pattern) please explore "File" option in Master Row Pattern Editor by putting the file names
x in a .csv and pulling those values into the column cells.
x -enable_passphrase
x If the Private Key was passphrase protected, this should be enabled to allow configuration of passphrase used.
x -passphrase
x The passphrase with which the Private Key was additionally protected during generation. For multiple clients and assymetric passphrases
x ( which cannot be expressed easily as a pattern) please explore "File" option in Master Row Pattern Editor by putting the file names
x in a .csv and pulling those values into the column cells.
x -output_directory
x Location of Directory in Client where the decrypted capture, if enabled, and server replies, if enabled,will be stored.
x -decrypted_capture
x Whether SSH packets for this session will be captured and stored on client in decrypted form.
x Note that this is not linked to IxNetwork control or data capture which will capture the packets in encrypted format only.
x Also note that this option should be avoided if Continuous Tranmission mode is enabled for any of the Command Snippets which can lead
x to huge capture files being generated which could in turn affect Stop time since during Stop, the captures are transferred to the client.
x The Decrypted Capture can be viewed by either doing right-click on a client where this option is enabled and doing "Get Decrypted Capture"
x ( allowed on 5 clients at a time ; each of the captures will be opened in a new Wireshark pop-up) OR by stopping the client and then directly
x opening it from the configured Output Directory from inside the current run folder/capture.
x This option can be enabled even when a session is already up in which case the capture will be started from that point of time.
x -save_reply_x_m_l
x If this is enabled, Hellos and replies to commands sent via Command Snippets or global command (such as 'get') by the Netconf Server will be stored in the Output Directory
x in current run folder/Replies. Any RPC errors recieved will be stored in a separate Error directory for convenience of debugging error scenarios.
x This option can be enabled even when a session is already up in which case the replies will be saved from that point of time.
x -log_clean_up_option
x Debug Log Clean Up
x -log_file_age
x This field determines how old logs to be deleted.
x -command_snippets_data_active
x Activate/Deactivate Command Snippets Data.
x -command_snippet_directory
x Directory containing XML based Netconf compliant command snippets.
x -command_snippet_file
x File containing XML based Netconf compliant command snippet. For multiple command snippets with assymetric file names
x ( which cannot be expressed easily as a pattern) please explore "File" option in Master Row Pattern Editor by putting the file names
x in a .csv and pulling those values into the column cells.
x -transmission_behaviour
x Transmission behaviour for command snippet.
x Don't Send : This means that command will not be automatically executed. This choice should be
x used if user wants to control the order or/and timing of sending the command snippet to the DUT
x using Test Composer or Automation Script.
x Once: The command will be sent only once to the DUT every time session comes up with the DUT.
x Periodic - Continuous: The command will be sent every Transmission Interval for the full lifetime of the session.Capture should be enabled with care if this option is selected.
x Periodic - Fixed Count: The command will be sent Transmission Count number of times, every Periodic Transmission Interval.
x -periodic_transmission_interval
x Minimum interval between scheduling of two transmits of the Command Snippet.
x -transmission_count
x Number of times to transmit the Command Snippet.
Return Values:
A list containing the ipv4 loopback protocol stack handles that were added by the command (if any).
x key:ipv4_loopback_handle value:A list containing the ipv4 loopback protocol stack handles that were added by the command (if any).
A list containing the ipv4 protocol stack handles that were added by the command (if any).
x key:ipv4_handle value:A list containing the ipv4 protocol stack handles that were added by the command (if any).
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
When status is $::FAILURE, log shows the detailed information of failure.
key:log value:When status is $::FAILURE, log shows the detailed information of failure.
Handle of Netconf Client configured
key:netconf_client_handle value:Handle of Netconf Client configured
Handle of Command Snippets Data configured
key:command_snippets_data_handle value:Handle of Command Snippets Data configured
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_netconf_client_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_netconf_client_config.py_part2
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def ptp_over_mac_config(self, mode, parent_handle, **kwargs):
r'''
#Procedure Header
Name:
ptp_over_mac_config
Description:
Performs ptp_over_mac configuration. Manages a device group of PTP clocks.
Synopsis:
ptp_over_mac_config
-mode CHOICES create add modify delete
-parent_handle ANY
[-handle ANY]
n [-style ANY]
x [-profile CHOICES ieee1588
x CHOICES g82651
x CHOICES g82751
x CHOICES ieee8021as
x CHOICES c37238]
[-announce_current_utc_offset_valid CHOICES 0 1]
[-current_utc_offset RANGE 0-32767
DEFAULT 0]
[-announce_drop_rate RANGE 0-100
DEFAULT 0]
[-announce_frequency_traceable CHOICES 0 1
DEFAULT 0]
[-announce_leap59 CHOICES 0 1
DEFAULT 0]
[-announce_leap61 CHOICES 0 1
DEFAULT 0]
[-announce_ptp_timescale CHOICES 0 1
DEFAULT 0]
[-announce_receipt_timeout RANGE 0-128
DEFAULT 3]
[-announce_time_traceable CHOICES 0 1
DEFAULT 0]
x [-sync_receipt_timeout_gptp RANGE 1-128
x DEFAULT 3]
x [-bmca CHOICES 0 1
x DEFAULT 1]
x [-reverse_sync CHOICES 0 1
x DEFAULT 0]
x [-reverse_sync_interval_percent RANGE 0-4294967295
x DEFAULT 96]
x [-cumulative_scaled_rate_offset ANY
x DEFAULT 0x0]
x [-gm_time_base_indicator RANGE 0-65535
x DEFAULT 0]
x [-last_gm_phase_change RANGE 0-9223372036854775807
x DEFAULT 0]
x [-scaled_last_gm_freq_change RANGE 0-4294967295
x DEFAULT 0]
x [-update_time CHOICES 0 1
x DEFAULT 1]
x [-nanoseconds_per_second RANGE 999023438-1000976562
x DEFAULT 1000000000]
[-slave_count RANGE 1-500
DEFAULT 1]
[-slave_ip_address ANY
DEFAULT 10.10.0.1]
[-slave_ip_increment_by ANY
DEFAULT 0.0.0.1]
[-slave_mac_address ANY
DEFAULT aa:bb:cd:00:00:00]
[-slave_mac_increment_by ANY
DEFAULT 00:00:00:00:00:01]
[-clock_accuracy CHOICES 32
CHOICES 33
CHOICES 34
CHOICES 35
CHOICES 36
CHOICES 37
CHOICES 38
CHOICES 39
CHOICES 40
CHOICES 41
CHOICES 42
CHOICES 43
CHOICES 44
CHOICES 45
CHOICES 46
CHOICES 47
CHOICES 48
CHOICES 49
DEFAULT 47]
[-clock_class RANGE 0-255
DEFAULT 6]
n [-clock_increment ANY]
[-communication_mode CHOICES multicast
CHOICES unicast
CHOICES mixedmode
CHOICES g8265
DEFAULT multicast]
[-delay_mechanism CHOICES E2E P2P 1WAY
DEFAULT E2E]
[-delay_resp_drop_rate RANGE 0-100
DEFAULT 0]
[-delay_resp_receipt_timeout RANGE 1-1000
DEFAULT 100]
[-delay_response_delay RANGE 0-1000000000
DEFAULT 0]
[-delay_response_delay_insertion_rate RANGE 0-100
DEFAULT 0]
[-domain RANGE 0-255
DEFAULT 0]
x [-drop_malformed CHOICES 0 1]
[-drop_signal_req_announce CHOICES 0 1]
[-drop_signal_req_delay_resp CHOICES 0 1]
[-drop_signal_req_sync CHOICES 0 1]
n [-enabled ANY]
[-first_clock ANY
DEFAULT 00:00:00:00:00:00:11:11]
[-follow_up_bad_crc_rate RANGE 0-100
DEFAULT 0]
[-follow_up_delay RANGE 0-1000000000
DEFAULT 0]
[-follow_up_delay_insertion_rate RANGE 0-100
DEFAULT 0]
[-follow_up_drop_rate RANGE 0-100
DEFAULT 0]
x [-delay_req_drop_rate RANGE 0-100
x DEFAULT 0]
x [-delay_req_offset RANGE 50-200
x DEFAULT 100]
x [-delay_req_spread RANGE 0-50
x DEFAULT 0]
[-grant_delay_resp_duration_interval RANGE 5-1200
DEFAULT 300]
[-grant_sync_duration_interval RANGE 5-1200
DEFAULT 300]
[-grant_unicast_duration_interval RANGE 5-1200
DEFAULT 300]
[-ip_tos RANGE 0-255
DEFAULT 0]
[-learn_port_id CHOICES 0 1]
[-log_announce_interval CHOICES 247
CHOICES 248
CHOICES 249
CHOICES 250
CHOICES 251
CHOICES 252
CHOICES 253
CHOICES 254
CHOICES 255
CHOICES 0
CHOICES 1
CHOICES 2
CHOICES 3
CHOICES 4
CHOICES 5
CHOICES 6
CHOICES 7
CHOICES 8
CHOICES 9
DEFAULT 0]
[-log_delay_req_interval CHOICES 247
CHOICES 248
CHOICES 249
CHOICES 250
CHOICES 251
CHOICES 252
CHOICES 253
CHOICES 254
CHOICES 255
CHOICES 0
CHOICES 1
CHOICES 2
CHOICES 3
CHOICES 4
CHOICES 5
CHOICES 6
CHOICES 7
CHOICES 8
CHOICES 9
DEFAULT 0]
[-log_sync_interval CHOICES 247
CHOICES 248
CHOICES 249
CHOICES 250
CHOICES 251
CHOICES 252
CHOICES 253
CHOICES 254
CHOICES 255
CHOICES 0
CHOICES 1
CHOICES 2
CHOICES 3
CHOICES 4
CHOICES 5
CHOICES 6
CHOICES 7
CHOICES 8
CHOICES 9
DEFAULT 0]
[-master_count RANGE 1-500
DEFAULT 1]
[-master_ip_address ANY
DEFAULT 10.10.0.1]
[-master_ip_increment_by ANY
DEFAULT 0.0.0.1]
n [-master_ip_increment_inter_entity ANY]
[-master_mac_address ANY
DEFAULT aa:bb:cd:00:00:00]
[-master_mac_increment_by ANY
DEFAULT 00:00:00:00:00:01]
n [-master_mac_increment_inter_entity ANY]
x [-multicastAddress CHOICES nonforwardable forwardable
x DEFAULT nonforwardable]
[-name ALPHA]
x [-not_slave CHOICES 0 1]
[-port_number RANGE 1-65535
DEFAULT 1]
n [-port_number_increment ANY]
[-priority1 RANGE 0-255
DEFAULT 128]
[-priority2 RANGE 0-255
DEFAULT 128]
[-renewal_invited CHOICES 0 1]
[-request_attempts RANGE 1-100
DEFAULT 3]
[-request_holddown RANGE 10-1000
DEFAULT 60]
[-request_interval RANGE 1-100
DEFAULT 1]
[-residence_time RANGE 0-1000000000
DEFAULT 0]
[-rx_calibration RANGE 0-10000
DEFAULT 0]
[-send_announce_multicast CHOICES 0 1]
[-send_announce_tlv CHOICES 0 1]
[-send_cancel_tlv CHOICES 0 1]
[-signal_interval RANGE 3-1200
DEFAULT 64]
[-signal_unicast_handling CHOICES individually
CHOICES allInOne
CHOICES doNotSend
DEFAULT individually]
[-step_mode CHOICES two-step single-step
DEFAULT two-step]
[-steps_removed RANGE 0-655535
DEFAULT 0]
[-strict_grant CHOICES 0 1]
x [-path_trace_tlv CHOICES 0 1]
[-sync_drop_rate RANGE 0-100
DEFAULT 0]
[-sync_receipt_timeout RANGE 1-1000
DEFAULT 100]
[-time_source CHOICES 0X10
CHOICES 0X20
CHOICES 0X30
CHOICES 0X40
CHOICES 0X50
CHOICES 0X60
CHOICES 0X90
CHOICES 0XA0
DEFAULT 0X20]
[-timestamp_offset RANGE 0-9223372036854775807
DEFAULT 0]
n [-timestamp_offset_variation ANY]
[-tx_calibration RANGE 0-1000000
DEFAULT 0]
x [-tx_two_step_calibration RANGE 0-1000000
x DEFAULT 0]
[-use_alternate_master_flag CHOICES 0 1]
[-use_clock_identity CHOICES 0 1]
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ptp_over_mac_config.py_part1
|
x DEFAULT 0]
[-grant_delay_resp_duration_interval RANGE 5-1200
DEFAULT 300]
[-grant_sync_duration_interval RANGE 5-1200
DEFAULT 300]
[-grant_unicast_duration_interval RANGE 5-1200
DEFAULT 300]
[-ip_tos RANGE 0-255
DEFAULT 0]
[-learn_port_id CHOICES 0 1]
[-log_announce_interval CHOICES 247
CHOICES 248
CHOICES 249
CHOICES 250
CHOICES 251
CHOICES 252
CHOICES 253
CHOICES 254
CHOICES 255
CHOICES 0
CHOICES 1
CHOICES 2
CHOICES 3
CHOICES 4
CHOICES 5
CHOICES 6
CHOICES 7
CHOICES 8
CHOICES 9
DEFAULT 0]
[-log_delay_req_interval CHOICES 247
CHOICES 248
CHOICES 249
CHOICES 250
CHOICES 251
CHOICES 252
CHOICES 253
CHOICES 254
CHOICES 255
CHOICES 0
CHOICES 1
CHOICES 2
CHOICES 3
CHOICES 4
CHOICES 5
CHOICES 6
CHOICES 7
CHOICES 8
CHOICES 9
DEFAULT 0]
[-log_sync_interval CHOICES 247
CHOICES 248
CHOICES 249
CHOICES 250
CHOICES 251
CHOICES 252
CHOICES 253
CHOICES 254
CHOICES 255
CHOICES 0
CHOICES 1
CHOICES 2
CHOICES 3
CHOICES 4
CHOICES 5
CHOICES 6
CHOICES 7
CHOICES 8
CHOICES 9
DEFAULT 0]
[-master_count RANGE 1-500
DEFAULT 1]
[-master_ip_address ANY
DEFAULT 10.10.0.1]
[-master_ip_increment_by ANY
DEFAULT 0.0.0.1]
n [-master_ip_increment_inter_entity ANY]
[-master_mac_address ANY
DEFAULT aa:bb:cd:00:00:00]
[-master_mac_increment_by ANY
DEFAULT 00:00:00:00:00:01]
n [-master_mac_increment_inter_entity ANY]
x [-multicastAddress CHOICES nonforwardable forwardable
x DEFAULT nonforwardable]
[-name ALPHA]
x [-not_slave CHOICES 0 1]
[-port_number RANGE 1-65535
DEFAULT 1]
n [-port_number_increment ANY]
[-priority1 RANGE 0-255
DEFAULT 128]
[-priority2 RANGE 0-255
DEFAULT 128]
[-renewal_invited CHOICES 0 1]
[-request_attempts RANGE 1-100
DEFAULT 3]
[-request_holddown RANGE 10-1000
DEFAULT 60]
[-request_interval RANGE 1-100
DEFAULT 1]
[-residence_time RANGE 0-1000000000
DEFAULT 0]
[-rx_calibration RANGE 0-10000
DEFAULT 0]
[-send_announce_multicast CHOICES 0 1]
[-send_announce_tlv CHOICES 0 1]
[-send_cancel_tlv CHOICES 0 1]
[-signal_interval RANGE 3-1200
DEFAULT 64]
[-signal_unicast_handling CHOICES individually
CHOICES allInOne
CHOICES doNotSend
DEFAULT individually]
[-step_mode CHOICES two-step single-step
DEFAULT two-step]
[-steps_removed RANGE 0-655535
DEFAULT 0]
[-strict_grant CHOICES 0 1]
x [-path_trace_tlv CHOICES 0 1]
[-sync_drop_rate RANGE 0-100
DEFAULT 0]
[-sync_receipt_timeout RANGE 1-1000
DEFAULT 100]
[-time_source CHOICES 0X10
CHOICES 0X20
CHOICES 0X30
CHOICES 0X40
CHOICES 0X50
CHOICES 0X60
CHOICES 0X90
CHOICES 0XA0
DEFAULT 0X20]
[-timestamp_offset RANGE 0-9223372036854775807
DEFAULT 0]
n [-timestamp_offset_variation ANY]
[-tx_calibration RANGE 0-1000000
DEFAULT 0]
x [-tx_two_step_calibration RANGE 0-1000000
x DEFAULT 0]
[-use_alternate_master_flag CHOICES 0 1]
[-use_clock_identity CHOICES 0 1]
x [-one_way CHOICES 0 1]
x [-simulate_boundary CHOICES 0 1
x DEFAULT 0]
x [-grandmaster_identity ANY
x DEFAULT 00:00:00:00:00:00:00:01]
x [-simulate_transparent CHOICES 0 1]
x [-sync_residence_time ANY]
x [-follow_up_residence_time ANY]
x [-delay_req_residence_time ANY]
x [-delay_resp_residence_time ANY]
x [-p_delay_follow_up_residence_time ANY]
x [-offset_scaled_log_variance ANY]
x [-role CHOICES slave master]
x [-master_ipv6_address ANY]
x [-master_ipv6_increment_by ANY]
x [-slave_ipv6_address ANY]
x [-slave_ipv6_increment_by ANY]
x [-grandmaster_id ANY]
x [-reserved ANY]
x [-total_time_inaccuracy ANY]
x [-enable_atoi_tlv CHOICES 0 1]
x [-atoi_tlv_count NUMERIC]
x [-mv_active ANY]
x [-key_field ANY]
x [-current_offset ANY]
x [-jump_seconds ANY]
x [-time_of_next_jump ANY]
x [-display_name ANY]
[-mtu RANGE 68-14000]
x [-mac_address_init MAC]
x [-mac_address_step MAC
x DEFAULT 0000.0000.0001]
x [-vlan CHOICES 0 1]
[-vlan_id_mode CHOICES fixed increment
DEFAULT increment]
[-vlan_id RANGE 0-4096]
[-vlan_id_step RANGE 0-4096
DEFAULT 1]
[-vlan_user_priority RANGE 0-7
DEFAULT 0]
x [-num_sessions RANGE 1-100000000
x DEFAULT 10]
Arguments:
-mode
create - creates and configures a new object
add - not supported in case of ::ixiangpf::ptp_over_mac_config.
modify - modified attributes on the given object by the -handle param
delete - deletes the object given by the -handle param
-parent_handle
The parent handle used for creating this object. It can be a topology, or a device group, or an ethernet.
-handle
A handle returned via a ::ixiangpf::ptp_over_mac_config command. This is used for mode modify.
n -style
n This argument defined by Cisco is not supported for NGPF implementation.
x -profile
x The profile used by this clock.
-announce_current_utc_offset_valid
Set Announce currentUtcOffsetValid bit.
-current_utc_offset
Set announced Current UTC Offset (seconds)
-announce_drop_rate
Percentage rate of the dropped Announce messages.
-announce_frequency_traceable
Set Announce frequency traceable bit.
-announce_leap59
Set Announce leap59 bit.
-announce_leap61
Set Announce leap61 bit.
-announce_ptp_timescale
Set Announce ptpTimescale bit.
-announce_receipt_timeout
The number of announceInterval that has to pass without receipt of an Announce message.
-announce_time_traceable
Set Announce time traceable bit.
x -sync_receipt_timeout_gptp
x The number of Sync Intervals that have to pass without receipt of an Sync message to trigger timeout.
x -bmca
x Run the Best Master Clock Algorithm for gPTP (if disabled can use a pre-defined Master or accept messages from any source)
x -reverse_sync
x As a slave, periodically send Reverse Sync messages with recovered clock.
x As a master, calculate the Offset of the Slave reported time to master time.
x -reverse_sync_interval_percent
x The percentage of incoming Sync interval to use for Reverse Sync interval.
x -cumulative_scaled_rate_offset
x Cumulative Scaled Rate Offset field set in the gPTP FollowUp TLV.
x -gm_time_base_indicator
x GM Time Base Indicator field set in the gPTP FollowUp TLV.
x -last_gm_phase_change
x Last GM Phase Change nanoseconds set in the gPTP FollowUp TLV.
x -scaled_last_gm_freq_change
x Scaled Last GM Freq Change field set in the gPTP FollowUp TLV.
x -update_time
x Clocks in Slave role will correct their time based on received Sync messages.
x -nanoseconds_per_second
x The number of nanoseconds the emulated clock should effectively count for one second of hardware ticks.
-slave_count
The total number of Unicast slaves to be used.
-slave_ip_address
Defines the base address to be used for enumerating all the addresses.
-slave_ip_increment_by
Defines the increment to be used for enumerating all the addresses.
-slave_mac_address
Defines the base address to be used for enumerating all the addresses.
-slave_mac_increment_by
Defines the increment to be used for enumerating all the addresses.
-clock_accuracy
Clock accuracy.
Valid choices are:
32 - {The time is accurate to within 25 ns}
33 - {The time is accurate to within 100 ns}
34 - {The time is accurate to within 250 ns}
35 - {The time is accurate to within 1 us}
36 - {The time is accurate to within 2.5 us}
37 - {The time is accurate to within 10 us}
38 - {The time is accurate to within 25 us}
39 - {The time is accurate to within 100 us}
40 - {The time is accurate to within 250 us}
41 - {The time is accurate to within 1 ms}
42 - {The time is accurate to within 2.5 ms}
43 - {The time is accurate to within 10 ms}
44 - {The time is accurate to within 25 ms}
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ptp_over_mac_config.py_part2
|
x [-one_way CHOICES 0 1]
x [-simulate_boundary CHOICES 0 1
x DEFAULT 0]
x [-grandmaster_identity ANY
x DEFAULT 00:00:00:00:00:00:00:01]
x [-simulate_transparent CHOICES 0 1]
x [-sync_residence_time ANY]
x [-follow_up_residence_time ANY]
x [-delay_req_residence_time ANY]
x [-delay_resp_residence_time ANY]
x [-p_delay_follow_up_residence_time ANY]
x [-offset_scaled_log_variance ANY]
x [-role CHOICES slave master]
x [-master_ipv6_address ANY]
x [-master_ipv6_increment_by ANY]
x [-slave_ipv6_address ANY]
x [-slave_ipv6_increment_by ANY]
x [-grandmaster_id ANY]
x [-reserved ANY]
x [-total_time_inaccuracy ANY]
x [-enable_atoi_tlv CHOICES 0 1]
x [-atoi_tlv_count NUMERIC]
x [-mv_active ANY]
x [-key_field ANY]
x [-current_offset ANY]
x [-jump_seconds ANY]
x [-time_of_next_jump ANY]
x [-display_name ANY]
[-mtu RANGE 68-14000]
x [-mac_address_init MAC]
x [-mac_address_step MAC
x DEFAULT 0000.0000.0001]
x [-vlan CHOICES 0 1]
[-vlan_id_mode CHOICES fixed increment
DEFAULT increment]
[-vlan_id RANGE 0-4096]
[-vlan_id_step RANGE 0-4096
DEFAULT 1]
[-vlan_user_priority RANGE 0-7
DEFAULT 0]
x [-num_sessions RANGE 1-100000000
x DEFAULT 10]
Arguments:
-mode
create - creates and configures a new object
add - not supported in case of ::ixiangpf::ptp_over_mac_config.
modify - modified attributes on the given object by the -handle param
delete - deletes the object given by the -handle param
-parent_handle
The parent handle used for creating this object. It can be a topology, or a device group, or an ethernet.
-handle
A handle returned via a ::ixiangpf::ptp_over_mac_config command. This is used for mode modify.
n -style
n This argument defined by Cisco is not supported for NGPF implementation.
x -profile
x The profile used by this clock.
-announce_current_utc_offset_valid
Set Announce currentUtcOffsetValid bit.
-current_utc_offset
Set announced Current UTC Offset (seconds)
-announce_drop_rate
Percentage rate of the dropped Announce messages.
-announce_frequency_traceable
Set Announce frequency traceable bit.
-announce_leap59
Set Announce leap59 bit.
-announce_leap61
Set Announce leap61 bit.
-announce_ptp_timescale
Set Announce ptpTimescale bit.
-announce_receipt_timeout
The number of announceInterval that has to pass without receipt of an Announce message.
-announce_time_traceable
Set Announce time traceable bit.
x -sync_receipt_timeout_gptp
x The number of Sync Intervals that have to pass without receipt of an Sync message to trigger timeout.
x -bmca
x Run the Best Master Clock Algorithm for gPTP (if disabled can use a pre-defined Master or accept messages from any source)
x -reverse_sync
x As a slave, periodically send Reverse Sync messages with recovered clock.
x As a master, calculate the Offset of the Slave reported time to master time.
x -reverse_sync_interval_percent
x The percentage of incoming Sync interval to use for Reverse Sync interval.
x -cumulative_scaled_rate_offset
x Cumulative Scaled Rate Offset field set in the gPTP FollowUp TLV.
x -gm_time_base_indicator
x GM Time Base Indicator field set in the gPTP FollowUp TLV.
x -last_gm_phase_change
x Last GM Phase Change nanoseconds set in the gPTP FollowUp TLV.
x -scaled_last_gm_freq_change
x Scaled Last GM Freq Change field set in the gPTP FollowUp TLV.
x -update_time
x Clocks in Slave role will correct their time based on received Sync messages.
x -nanoseconds_per_second
x The number of nanoseconds the emulated clock should effectively count for one second of hardware ticks.
-slave_count
The total number of Unicast slaves to be used.
-slave_ip_address
Defines the base address to be used for enumerating all the addresses.
-slave_ip_increment_by
Defines the increment to be used for enumerating all the addresses.
-slave_mac_address
Defines the base address to be used for enumerating all the addresses.
-slave_mac_increment_by
Defines the increment to be used for enumerating all the addresses.
-clock_accuracy
Clock accuracy.
Valid choices are:
32 - {The time is accurate to within 25 ns}
33 - {The time is accurate to within 100 ns}
34 - {The time is accurate to within 250 ns}
35 - {The time is accurate to within 1 us}
36 - {The time is accurate to within 2.5 us}
37 - {The time is accurate to within 10 us}
38 - {The time is accurate to within 25 us}
39 - {The time is accurate to within 100 us}
40 - {The time is accurate to within 250 us}
41 - {The time is accurate to within 1 ms}
42 - {The time is accurate to within 2.5 ms}
43 - {The time is accurate to within 10 ms}
44 - {The time is accurate to within 25 ms}
45 - {The time is accurate to within 100 ms}
46 - {The time is accurate to within 250 ms}
47 - {The time is accurate to within 1 s}
48 - {The time is accurate to within 10 s}
49 - {The time is accurate to greater than 10 s}
-clock_class
Traceability of the time or frequency distributed by the grandmaster clock.
n -clock_increment
n This argument defined by Cisco is not supported for NGPF implementation.
-communication_mode
Communication mode (unicast/multicast/mixedmode).
Valid choices are:
multicast - Multicast
unicast - Unicast
mixedmode - MixedMode
g8265 - deprecated for ixngpf command
-delay_mechanism
Clock delay mechanism.
Valid choices are:
E2E - RequestResponse
P2P - PeerDelay
1WAY - deprecated for ixngpf command
-delay_resp_drop_rate
Percentage rate of the dropped Delay_Resp messages.
-delay_resp_receipt_timeout
DelayResponse Receipt Timeout in seconds.
-delay_response_delay
Additional delay introduced in the Delay_Resp message timestamp (nanoseconds).
-delay_response_delay_insertion_rate
Percentage rate of the Delay_Resp messages in which the delay is introduced.
-domain
PTP Domain.
x -drop_malformed
x Drop packets that for which fields like Domain, message rates, Clock Class, Clock Accuracy
x and Offset Scaled Log Variance are not respecting strict G8275.1 imposed intervals.
-drop_signal_req_announce
Select this check box to drop any Signal Request that contains Announce TLV.
-drop_signal_req_delay_resp
Select this check box to drop any Signal Request that contains DelayResp TLV.
-drop_signal_req_sync
Select this check box to drop any Signal Request that contains Sync TLV.
n -enabled
n This argument defined by Cisco is not supported for NGPF implementation.
-first_clock
Defines the ClockIdentity to be used by this device.
-follow_up_bad_crc_rate
Percentage rate of the bad crc Follow_Up messages.
-follow_up_delay
Additional delay introduced in the Follow_Up message timestamp (nanoseconds).
-follow_up_delay_insertion_rate
Percentage rate of the Follow_Up messages in which the delay is introduced.
-follow_up_drop_rate
Percentage rate of the dropped Follow_Up messages.
x -delay_req_drop_rate
x Percentage rate of the dropped (P)DelayReq messages.
x -delay_req_offset
x Percentage of the agreed (P)DelayReq Inter-arrival time to schedule between two subsequent DelayReq messages.
x -delay_req_spread
x Distribute (P)DelayReq messages in an interval around the targeted Inter-arrival mean time (expressed as a % of targeted mean).
-grant_delay_resp_duration_interval
Value of DurationField in REQUEST_UNICAST_TRANSMISSION_TLV for DelayResp messages.
-grant_sync_duration_interval
Value of DurationField in REQUEST_UNICAST_TRANSMISSION_TLV for Sync messages.
-grant_unicast_duration_interval
Value of DurationField in REQUEST_UNICAST_TRANSMISSION_TLV.
-ip_tos
DEPRECATED - Use per port option for setting IP TOS or DS.
-learn_port_id
Slave learns Master Port ID.
-log_announce_interval
The log mean time interval between successive Announce messages.
Valid choices are:
minus 9 - {-9 (512 per second)}
minus 8 - {-8 (256 per second)}
minus 7 - {-7 (128 per second)}
minus 6 - {-6 (64 per second)}
minus 5 - {-5 (32 per second)}
minus 4 - {-4 (16 per second)}
minus 3 - {-3 (8 per second)}
minus 2 - {-2 (4 per second)}
minus 1 - {-1 (2 per second)}
0 - {0 (1 per second)}
1 - {1 (1 per 2 seconds)}
2 - {2 (1 per 4 seconds)}
3 - {3 (1 per 8 seconds)}
4 - {4 (1 per 16 seconds)}
5 - {5 (1 per 32 seconds)}
6 - {6 (1 per 64 seconds)}
7 - {7 (1 per 128 seconds)}
8 - {8 (1 per 256 seconds)}
9 - {9 (1 per 512 seconds)}
-log_delay_req_interval
The log mean time interval between successive (P)Delay_Req messages.
Valid choices are:
minus 9 - {-9 (512 per second)}
minus 8 - {-8 (256 per second)}
minus 7 - {-7 (128 per second)}
minus 6 - {-6 (64 per second)}
minus 5 - {-5 (32 per second)}
minus 4 - {-4 (16 per second)}
minus 3 - {-3 (8 per second)}
minus 2 - {-2 (4 per second)}
minus 1 - {-1 (2 per second)}
0 - {0 (1 per second)}
1 - {1 (1 per 2 seconds)}
2 - {2 (1 per 4 seconds)}
3 - {3 (1 per 8 seconds)}
4 - {4 (1 per 16 seconds)}
5 - {5 (1 per 32 seconds)}
6 - {6 (1 per 64 seconds)}
7 - {7 (1 per 128 seconds)}
8 - {8 (1 per 256 seconds)}
9 - {9 (1 per 512 seconds)}
-log_sync_interval
The log mean time interval between successive Sync messages.
Valid choices are:
minus 9 - {-9 (512 per second)}
minus 8 - {-8 (256 per second)}
minus 7 - {-7 (128 per second)}
minus 6 - {-6 (64 per second)}
minus 5 - {-5 (32 per second)}
minus 4 - {-4 (16 per second)}
minus 3 - {-3 (8 per second)}
minus 2 - {-2 (4 per second)}
minus 1 - {-1 (2 per second)}
0 - {0 (1 per second)}
1 - {1 (1 per 2 seconds)}
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ptp_over_mac_config.py_part3
|
45 - {The time is accurate to within 100 ms}
46 - {The time is accurate to within 250 ms}
47 - {The time is accurate to within 1 s}
48 - {The time is accurate to within 10 s}
49 - {The time is accurate to greater than 10 s}
-clock_class
Traceability of the time or frequency distributed by the grandmaster clock.
n -clock_increment
n This argument defined by Cisco is not supported for NGPF implementation.
-communication_mode
Communication mode (unicast/multicast/mixedmode).
Valid choices are:
multicast - Multicast
unicast - Unicast
mixedmode - MixedMode
g8265 - deprecated for ixngpf command
-delay_mechanism
Clock delay mechanism.
Valid choices are:
E2E - RequestResponse
P2P - PeerDelay
1WAY - deprecated for ixngpf command
-delay_resp_drop_rate
Percentage rate of the dropped Delay_Resp messages.
-delay_resp_receipt_timeout
DelayResponse Receipt Timeout in seconds.
-delay_response_delay
Additional delay introduced in the Delay_Resp message timestamp (nanoseconds).
-delay_response_delay_insertion_rate
Percentage rate of the Delay_Resp messages in which the delay is introduced.
-domain
PTP Domain.
x -drop_malformed
x Drop packets that for which fields like Domain, message rates, Clock Class, Clock Accuracy
x and Offset Scaled Log Variance are not respecting strict G8275.1 imposed intervals.
-drop_signal_req_announce
Select this check box to drop any Signal Request that contains Announce TLV.
-drop_signal_req_delay_resp
Select this check box to drop any Signal Request that contains DelayResp TLV.
-drop_signal_req_sync
Select this check box to drop any Signal Request that contains Sync TLV.
n -enabled
n This argument defined by Cisco is not supported for NGPF implementation.
-first_clock
Defines the ClockIdentity to be used by this device.
-follow_up_bad_crc_rate
Percentage rate of the bad crc Follow_Up messages.
-follow_up_delay
Additional delay introduced in the Follow_Up message timestamp (nanoseconds).
-follow_up_delay_insertion_rate
Percentage rate of the Follow_Up messages in which the delay is introduced.
-follow_up_drop_rate
Percentage rate of the dropped Follow_Up messages.
x -delay_req_drop_rate
x Percentage rate of the dropped (P)DelayReq messages.
x -delay_req_offset
x Percentage of the agreed (P)DelayReq Inter-arrival time to schedule between two subsequent DelayReq messages.
x -delay_req_spread
x Distribute (P)DelayReq messages in an interval around the targeted Inter-arrival mean time (expressed as a % of targeted mean).
-grant_delay_resp_duration_interval
Value of DurationField in REQUEST_UNICAST_TRANSMISSION_TLV for DelayResp messages.
-grant_sync_duration_interval
Value of DurationField in REQUEST_UNICAST_TRANSMISSION_TLV for Sync messages.
-grant_unicast_duration_interval
Value of DurationField in REQUEST_UNICAST_TRANSMISSION_TLV.
-ip_tos
DEPRECATED - Use per port option for setting IP TOS or DS.
-learn_port_id
Slave learns Master Port ID.
-log_announce_interval
The log mean time interval between successive Announce messages.
Valid choices are:
minus 9 - {-9 (512 per second)}
minus 8 - {-8 (256 per second)}
minus 7 - {-7 (128 per second)}
minus 6 - {-6 (64 per second)}
minus 5 - {-5 (32 per second)}
minus 4 - {-4 (16 per second)}
minus 3 - {-3 (8 per second)}
minus 2 - {-2 (4 per second)}
minus 1 - {-1 (2 per second)}
0 - {0 (1 per second)}
1 - {1 (1 per 2 seconds)}
2 - {2 (1 per 4 seconds)}
3 - {3 (1 per 8 seconds)}
4 - {4 (1 per 16 seconds)}
5 - {5 (1 per 32 seconds)}
6 - {6 (1 per 64 seconds)}
7 - {7 (1 per 128 seconds)}
8 - {8 (1 per 256 seconds)}
9 - {9 (1 per 512 seconds)}
-log_delay_req_interval
The log mean time interval between successive (P)Delay_Req messages.
Valid choices are:
minus 9 - {-9 (512 per second)}
minus 8 - {-8 (256 per second)}
minus 7 - {-7 (128 per second)}
minus 6 - {-6 (64 per second)}
minus 5 - {-5 (32 per second)}
minus 4 - {-4 (16 per second)}
minus 3 - {-3 (8 per second)}
minus 2 - {-2 (4 per second)}
minus 1 - {-1 (2 per second)}
0 - {0 (1 per second)}
1 - {1 (1 per 2 seconds)}
2 - {2 (1 per 4 seconds)}
3 - {3 (1 per 8 seconds)}
4 - {4 (1 per 16 seconds)}
5 - {5 (1 per 32 seconds)}
6 - {6 (1 per 64 seconds)}
7 - {7 (1 per 128 seconds)}
8 - {8 (1 per 256 seconds)}
9 - {9 (1 per 512 seconds)}
-log_sync_interval
The log mean time interval between successive Sync messages.
Valid choices are:
minus 9 - {-9 (512 per second)}
minus 8 - {-8 (256 per second)}
minus 7 - {-7 (128 per second)}
minus 6 - {-6 (64 per second)}
minus 5 - {-5 (32 per second)}
minus 4 - {-4 (16 per second)}
minus 3 - {-3 (8 per second)}
minus 2 - {-2 (4 per second)}
minus 1 - {-1 (2 per second)}
0 - {0 (1 per second)}
1 - {1 (1 per 2 seconds)}
2 - {2 (1 per 4 seconds)}
3 - {3 (1 per 8 seconds)}
4 - {4 (1 per 16 seconds)}
5 - {5 (1 per 32 seconds)}
6 - {6 (1 per 64 seconds)}
7 - {7 (1 per 128 seconds)}
8 - {8 (1 per 256 seconds)}
9 - {9 (1 per 512 seconds)}
-master_count
The total number of Unicast masters to be used.
-master_ip_address
Defines the base address to be used for enumerating all the addresses.
-master_ip_increment_by
Defines the increment to be used for enumerating all the addresses.
n -master_ip_increment_inter_entity
n This argument defined by Cisco is not supported for NGPF implementation.
-master_mac_address
Defines the base address to be used for enumerating all the addresses.
-master_mac_increment_by
Defines the increment to be used for enumerating all the addresses.
n -master_mac_increment_inter_entity
n This argument defined by Cisco is not supported for NGPF implementation.
x -multicastAddress
x The destination multicast address for G8275.1:
x non-forwardable - 01:80:C2:00:00:0E (recommended)
x forwardable - 01:1B:19:00:00:00
-name
Name of protocol.
x -not_slave
x When enabled for Master clocks it prevents a G8275.1 port from going into Slave state, by ignoring Announce messages.
-port_number
Port number.
n -port_number_increment
n This argument defined by Cisco is not supported for NGPF implementation.
-priority1
PTP priority1.
-priority2
PTP priority2.
-renewal_invited
Set the Renewal Invited flag in Grant Unicast Transmission TLV.
-request_attempts
How many succesive requests a slave can request before entering into holddown.
-request_holddown
Time between succesive requests if denied/timeout for Signal Request.
-request_interval
Time between succesive requests if denied/timeout for Signal Request.
-residence_time
DEPRECATED - use per message setting of Residence Time.
-rx_calibration
The amount of time (in ns) that the Receive side timestamp needs to be offset to allow for error.
-send_announce_multicast
Send multicast Announce messages.
-send_announce_tlv
Send and respond to Announce TLV unicast requests in signal messages.
-send_cancel_tlv
Send and respond to Cancel TLV unicast requests in signal messages.
-signal_interval
Time between Signal Request messages, in seconds.
-signal_unicast_handling
Valid choices are:
individually - {Send Individually}
allInOne - {Send In One Message}
doNotSend - {Do Not Send}
-step_mode
Clock step mode.
Valid choices are:
two-step - TwoStep
single-step - SingleStep
-steps_removed
The number of hops between the Grandmaster Clock and the emulated clock. Valid values: 0 to 65,535.
-strict_grant
If selected, server will not grant values that are above maximum offered values.
x -path_trace_tlv
x If selected, the master will append a Path Trace TLV to Announce messages.
-sync_drop_rate
Percentage rate of the dropped Sync messages.
-sync_receipt_timeout
Sync Receipt Timeout in seconds.
-time_source
Time source for the PTP device.
Valid choices are:
0X10 - AtomicClock
0X20 - GPS
0X30 - TerrestrialRadio
0X40 - PTP
0X50 - NTP
0X60 - HandSet
0X90 - Other
0XA0 - InternalOscilator
-timestamp_offset
Timestamp offset.
n -timestamp_offset_variation
n This argument defined by Cisco is not supported for NGPF implementation.
-tx_calibration
The amount of time (in ns) that the transmit timestamp of one step messages (Sync, PDelayResp) needs to be adjusted for error.
x -tx_two_step_calibration
x The amount of time (in ns) that the read transmit timestamp of sent messages (two-step Sync, DelayReq, PDelayReq, two-step PDelayResp) needs to be adjusted for error.
-use_alternate_master_flag
Select this check box to set the Alternate Master flag in all Announce and Sync messages.
-use_clock_identity
Use the ClockIdentity configured in the next column instead of MAC based generated one.
x -one_way
x Do not send Delay Requests.
x -simulate_boundary
x Simulate a transparent clock in front of this master clock.
x -grandmaster_identity
x Defines the ClockIdentity of the Grandmaster behind this device.
x -simulate_transparent
x Simulate a transparent clock in front of this master clock.
x -sync_residence_time
x Master to slave residence time of Sync messages through an associated one-step
x transparent clock inserted in the correction field of Sync messages sent by this clock.
x -follow_up_residence_time
x Master to slave residence of Sync messages through an associated two-step transparent clock
x inserted in the correction field of FollowUp messages sent by this clock.
x -delay_req_residence_time
x Residence time of (P)DelayReq messages through an associated one-step end-to-end
x transparent clock inserted in the correction field of (P)DelayReq messages sent by this clock.
x -delay_resp_residence_time
x Residence time of DelayReq messages through an associated two-step end-to-end transparent clock inserted
x in the correction field of DelayResp messages sent by this clock, or the residence time of PdelayResp messages
x through an associated one-step end-to-end transparent clock inserted in the correction field
x of PdelayResp messages sent by this clock.
x -p_delay_follow_up_residence_time
x Total residence time of PdelayReq and PdelayResp messagews through an associated two-step end-to-end
x transparent clock inserted in the correction field of PdelayRespFollowUp messages sent by this clock
x -offset_scaled_log_variance
x Static Offset Scaled Log Variance of this clock.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ptp_over_mac_config.py_part4
|
1 - {1 (1 per 2 seconds)}
2 - {2 (1 per 4 seconds)}
3 - {3 (1 per 8 seconds)}
4 - {4 (1 per 16 seconds)}
5 - {5 (1 per 32 seconds)}
6 - {6 (1 per 64 seconds)}
7 - {7 (1 per 128 seconds)}
8 - {8 (1 per 256 seconds)}
9 - {9 (1 per 512 seconds)}
-master_count
The total number of Unicast masters to be used.
-master_ip_address
Defines the base address to be used for enumerating all the addresses.
-master_ip_increment_by
Defines the increment to be used for enumerating all the addresses.
n -master_ip_increment_inter_entity
n This argument defined by Cisco is not supported for NGPF implementation.
-master_mac_address
Defines the base address to be used for enumerating all the addresses.
-master_mac_increment_by
Defines the increment to be used for enumerating all the addresses.
n -master_mac_increment_inter_entity
n This argument defined by Cisco is not supported for NGPF implementation.
x -multicastAddress
x The destination multicast address for G8275.1:
x non-forwardable - 01:80:C2:00:00:0E (recommended)
x forwardable - 01:1B:19:00:00:00
-name
Name of protocol.
x -not_slave
x When enabled for Master clocks it prevents a G8275.1 port from going into Slave state, by ignoring Announce messages.
-port_number
Port number.
n -port_number_increment
n This argument defined by Cisco is not supported for NGPF implementation.
-priority1
PTP priority1.
-priority2
PTP priority2.
-renewal_invited
Set the Renewal Invited flag in Grant Unicast Transmission TLV.
-request_attempts
How many succesive requests a slave can request before entering into holddown.
-request_holddown
Time between succesive requests if denied/timeout for Signal Request.
-request_interval
Time between succesive requests if denied/timeout for Signal Request.
-residence_time
DEPRECATED - use per message setting of Residence Time.
-rx_calibration
The amount of time (in ns) that the Receive side timestamp needs to be offset to allow for error.
-send_announce_multicast
Send multicast Announce messages.
-send_announce_tlv
Send and respond to Announce TLV unicast requests in signal messages.
-send_cancel_tlv
Send and respond to Cancel TLV unicast requests in signal messages.
-signal_interval
Time between Signal Request messages, in seconds.
-signal_unicast_handling
Valid choices are:
individually - {Send Individually}
allInOne - {Send In One Message}
doNotSend - {Do Not Send}
-step_mode
Clock step mode.
Valid choices are:
two-step - TwoStep
single-step - SingleStep
-steps_removed
The number of hops between the Grandmaster Clock and the emulated clock. Valid values: 0 to 65,535.
-strict_grant
If selected, server will not grant values that are above maximum offered values.
x -path_trace_tlv
x If selected, the master will append a Path Trace TLV to Announce messages.
-sync_drop_rate
Percentage rate of the dropped Sync messages.
-sync_receipt_timeout
Sync Receipt Timeout in seconds.
-time_source
Time source for the PTP device.
Valid choices are:
0X10 - AtomicClock
0X20 - GPS
0X30 - TerrestrialRadio
0X40 - PTP
0X50 - NTP
0X60 - HandSet
0X90 - Other
0XA0 - InternalOscilator
-timestamp_offset
Timestamp offset.
n -timestamp_offset_variation
n This argument defined by Cisco is not supported for NGPF implementation.
-tx_calibration
The amount of time (in ns) that the transmit timestamp of one step messages (Sync, PDelayResp) needs to be adjusted for error.
x -tx_two_step_calibration
x The amount of time (in ns) that the read transmit timestamp of sent messages (two-step Sync, DelayReq, PDelayReq, two-step PDelayResp) needs to be adjusted for error.
-use_alternate_master_flag
Select this check box to set the Alternate Master flag in all Announce and Sync messages.
-use_clock_identity
Use the ClockIdentity configured in the next column instead of MAC based generated one.
x -one_way
x Do not send Delay Requests.
x -simulate_boundary
x Simulate a transparent clock in front of this master clock.
x -grandmaster_identity
x Defines the ClockIdentity of the Grandmaster behind this device.
x -simulate_transparent
x Simulate a transparent clock in front of this master clock.
x -sync_residence_time
x Master to slave residence time of Sync messages through an associated one-step
x transparent clock inserted in the correction field of Sync messages sent by this clock.
x -follow_up_residence_time
x Master to slave residence of Sync messages through an associated two-step transparent clock
x inserted in the correction field of FollowUp messages sent by this clock.
x -delay_req_residence_time
x Residence time of (P)DelayReq messages through an associated one-step end-to-end
x transparent clock inserted in the correction field of (P)DelayReq messages sent by this clock.
x -delay_resp_residence_time
x Residence time of DelayReq messages through an associated two-step end-to-end transparent clock inserted
x in the correction field of DelayResp messages sent by this clock, or the residence time of PdelayResp messages
x through an associated one-step end-to-end transparent clock inserted in the correction field
x of PdelayResp messages sent by this clock.
x -p_delay_follow_up_residence_time
x Total residence time of PdelayReq and PdelayResp messagews through an associated two-step end-to-end
x transparent clock inserted in the correction field of PdelayRespFollowUp messages sent by this clock
x -offset_scaled_log_variance
x Static Offset Scaled Log Variance of this clock.
x -role
x The desired role of this clock.
x -master_ipv6_address
x Defines the base address to be used for enumerating all the addresses.
x -master_ipv6_increment_by
x Defines the increment to be used for enumerating all the addresses.
x -slave_ipv6_address
x Defines the base address to be used for enumerating all the addresses.
x -slave_ipv6_increment_by
x Defines the increment to be used for enumerating all the addresses.
x -grandmaster_id
x Grand Master ID
x -reserved
x Reserved
x -total_time_inaccuracy
x Total Time Inaccuracy
x -enable_atoi_tlv
x Enable ATOI Tlv
x -atoi_tlv_count
x Atoi Tlv Count
x -mv_active
x Active
x -key_field
x Key Field
x -current_offset
x Current Offset
x -jump_seconds
x Jump Seconds
x -time_of_next_jump
x Time Of Next Jump
x -display_name
x Display Name
-mtu
The advertised MTU value in database entries sent to other routers create on the Ixia interface. RANGE 68-14000.
x -mac_address_init
x This option defines the MAC address that will be configured on
x the Ixia interface. This parameter is not valid on mode modify when
x IxTclProtocol is used.
x -mac_address_step
x This option defines the incrementing step for the MAC address that
x will be configured on the Ixia interface.
x -vlan
x Enables vlan.
-vlan_id_mode
If the user configures more than one interface on the Ixia with
VLAN, he can choose to automatically increment the VLAN tag or
leave it idle for each interface. CHOICES fixed increment.
This parameter is not valid on mode modify when IxTclProtocol is used.
-vlan_id
If VLAN is enable on the Ixia interface, this option will configure the VLAN number.
-vlan_id_step
If the -vlan_id_mode is increment, this will be the step value by
which the VLAN tags are incremented. RANGE 0-4095
When vlan_id_step causes the vlan_id value to exceed it's maximum value the
increment will be done modulo <number of possible vlan ids>.
Examples: vlan_id = 4094; vlan_id_step = 2-> new vlan_id value = 0
vlan_id = 4095; vlan_id_step = 11 -> new vlan_id value = 10
-vlan_user_priority
x -num_sessions
x The number of PTP sessions to configure.
Return Values:
A list containing the ptp protocol stack handles that were added by the command (if any).
x key:ptp_handle value:A list containing the ptp protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:handle value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
ptp_over_mac handles
key:handles value:ptp_over_mac handles
When status is failure, contains more information
key:log value:When status is failure, contains more information
Examples:
Sample Input:
Sample Output:
Notes:
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: handle
See Also:
External documentation on Tclx keyed lists
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'ptp_over_mac_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ptp_over_mac_config.py_part5
|
x Static Offset Scaled Log Variance of this clock.
x -role
x The desired role of this clock.
x -master_ipv6_address
x Defines the base address to be used for enumerating all the addresses.
x -master_ipv6_increment_by
x Defines the increment to be used for enumerating all the addresses.
x -slave_ipv6_address
x Defines the base address to be used for enumerating all the addresses.
x -slave_ipv6_increment_by
x Defines the increment to be used for enumerating all the addresses.
x -grandmaster_id
x Grand Master ID
x -reserved
x Reserved
x -total_time_inaccuracy
x Total Time Inaccuracy
x -enable_atoi_tlv
x Enable ATOI Tlv
x -atoi_tlv_count
x Atoi Tlv Count
x -mv_active
x Active
x -key_field
x Key Field
x -current_offset
x Current Offset
x -jump_seconds
x Jump Seconds
x -time_of_next_jump
x Time Of Next Jump
x -display_name
x Display Name
-mtu
The advertised MTU value in database entries sent to other routers create on the Ixia interface. RANGE 68-14000.
x -mac_address_init
x This option defines the MAC address that will be configured on
x the Ixia interface. This parameter is not valid on mode modify when
x IxTclProtocol is used.
x -mac_address_step
x This option defines the incrementing step for the MAC address that
x will be configured on the Ixia interface.
x -vlan
x Enables vlan.
-vlan_id_mode
If the user configures more than one interface on the Ixia with
VLAN, he can choose to automatically increment the VLAN tag or
leave it idle for each interface. CHOICES fixed increment.
This parameter is not valid on mode modify when IxTclProtocol is used.
-vlan_id
If VLAN is enable on the Ixia interface, this option will configure the VLAN number.
-vlan_id_step
If the -vlan_id_mode is increment, this will be the step value by
which the VLAN tags are incremented. RANGE 0-4095
When vlan_id_step causes the vlan_id value to exceed it's maximum value the
increment will be done modulo <number of possible vlan ids>.
Examples: vlan_id = 4094; vlan_id_step = 2-> new vlan_id value = 0
vlan_id = 4095; vlan_id_step = 11 -> new vlan_id value = 10
-vlan_user_priority
x -num_sessions
x The number of PTP sessions to configure.
Return Values:
A list containing the ptp protocol stack handles that were added by the command (if any).
x key:ptp_handle value:A list containing the ptp protocol stack handles that were added by the command (if any).
A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
x key:handle value:A list containing individual interface, session and/or router handles that were added by the command (if any). Please note that this key will be omitted if the current session or command were run with -return_detailed_handles 0.
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
ptp_over_mac handles
key:handles value:ptp_over_mac handles
When status is failure, contains more information
key:log value:When status is failure, contains more information
Examples:
Sample Input:
Sample Output:
Notes:
If the current session or command was run with -return_detailed_handles 0 the following keys will be omitted from the command response: handle
See Also:
External documentation on Tclx keyed lists
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'ptp_over_mac_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ptp_over_mac_config.py_part6
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def multivalue_config(self, **kwargs):
r'''
#Procedure Header
Name:
multivalue_config
Description:
This procedure is used to create and modify multivalue operations. Multivalue is a very powerful represetation in NGPF. This is useful to generate various patterns like increment, decrement, custom pattern from file, repeatable random, overlay and etc. This command returns a handle for the configured multivalue. This handle can be used in interface and protocol configuration command to set patterns/multivalue against various fields.
Synopsis:
multivalue_config
x [-mode CHOICES create modify destroy]
x [-multivalue_handle ANY]
x [-custom_handle ANY]
x [-increment_handle ANY]
x [-pattern CHOICES none
x CHOICES single_value
x CHOICES counter
x CHOICES custom
x CHOICES repeatable_random
x CHOICES random
x CHOICES repeatable_random_range
x CHOICES custom_distributed
x CHOICES distributed
x CHOICES string
x CHOICES alternate
x CHOICES value_list
x CHOICES subset]
x [-single_value ALPHA]
x [-counter_start ANY]
x [-counter_step ANY]
x [-counter_direction CHOICES increment decrement]
x [-nest_step ALPHA]
x [-nest_owner ALPHA]
x [-nest_enabled CHOICES 0 1]
x [-disable_all_nests CHOICES 0 1
x DEFAULT 1]
x [-overlay_value ALPHA]
x [-overlay_value_step ALPHA]
x [-overlay_index NUMERIC]
x [-overlay_index_step NUMERIC]
x [-overlay_count NUMERIC]
x [-clear_existing_overlays CHOICES 0 1
x DEFAULT 1]
x [-custom_start ANY]
x [-custom_step ANY]
x [-custom_increment_value ANY]
x [-custom_increment_count NUMERIC]
x [-repeatable_random_seed NUMERIC]
x [-repeatable_random_count NUMERIC]
x [-repeatable_random_fixed ANY]
x [-repeatable_random_mask ANY]
x [-repeatable_random_range_min ANY]
x [-repeatable_random_range_max ANY]
x [-repeatable_random_range_step ANY]
x [-repeatable_random_range_seed NUMERIC]
x [-custom_distribution_values ALPHA]
x [-custom_distribution_percentages ALPHA]
x [-custom_distribution_weights ALPHA]
x [-custom_distribution_algorithm CHOICES auto_even
x CHOICES auto_geometric
x CHOICES percentage
x CHOICES weighted
x DEFAULT percentage]
x [-custom_distribution_mode CHOICES topology device port
x DEFAULT topology]
x [-distributed_value NUMERIC]
x [-string_pattern ALPHA]
x [-alternate_value CHOICES 0 1]
x [-values_list ALPHA]
x [-values_file ANY]
x [-values_file_type CHOICES cisco csv juniper unsupported
x DEFAULT csv]
x [-values_file_column_index NUMERIC
x DEFAULT 0]
x [-subset_source ANY]
x [-subset_source_attribute ANY]
x [-subset_round_robin_mode CHOICES none port device manual
x DEFAULT port]
Arguments:
x -mode
x The mode parameter is only needed when specifying values for
x custom_handle or increment_handle.
x When a custom_handle is specified the only valid mode values are
x - create
x - modify
x When a increment_handle is specified all choices are valid.
x -multivalue_handle
x The handle of a multivalue that was generated by a previous
x multivalue_config command.
x -custom_handle
x The handle of a custom pattern that was generated by a previous
x multivalue_config command.
x -increment_handle
x The handle of a custom increment that was generated by a previous
x multivalue_config command.
x -pattern
x The pattern that we want the multivalue to have.
x -single_value
x The value that will be used when the pattern is single_value.
x This argument is valid only if the configured pattern is single_value.
x -counter_start
x The start value that will be used when the pattern is a counter.
x This argument is valid only if the configured pattern is counter.
x -counter_step
x The step value that will be used when the pattern is a counter.
x This argument is valid only if the configured pattern is counter.
x -counter_direction
x The type of counter pattern that we want to configure.
x This argument is valid only if the configured pattern is counter.
x -nest_step
x The step of the configured nest(s) for the current multivalue.
x If multiple nests are configured the value of this argument must
x be a comma separated list of step values which correspond to the
x specified nest owners.
x -nest_owner
x The owner of the configured nest(s) for the current multivalue.
x If multiple nests are configured the value of this argument must
x be a comma separated list of owner handles.
x -nest_enabled
x This argument can be used to selectively enable/disable the nests configured
x in a multivalue.
x If multiple nests are configured the value of this argument must
x be a comma separated list of step values which correspond to the
x specified nest owners.
x -disable_all_nests
x This flag can be used to disable all nests in a multivalue.
x -overlay_value
x The value of an overlay.
x This argument can be a comma separated list of values if we want to
x configure multiple overlays with a single command.
x -overlay_value_step
x The step used by an overlay.
x This argument should only be used if you want to create overlay patterns.
x This argument can be a comma separated list of values if we want to
x configure multiple overlays with a single command.
x -overlay_index
x The index at which the overlay will be created.
x This argument can be a comma separated list of values if we want to
x configure multiple overlays with a single command.
x -overlay_index_step
x The index step controls the inteval at which successive overlays will be created.
x This argument should only be used if you want to create overlay patterns.
x This argument can be a comma separated list of values if we want to
x configure multiple overlays with a single command.
x -overlay_count
x The number of overlays which will be generated by the corresponding overlay pattern.
x This argument should only be used if you want to create overlay patterns.
x This argument can be a comma separated list of values if we want to
x configure multiple overlays with a single command.
x -clear_existing_overlays
x This flag can be used to remove all overlays from a multivalue.
x -custom_start
x The start value for the custom pattern.
x This argument is valid only if the configured pattern is custom.
x -custom_step
x The step value for the custom pattern.
x This argument is valid only if the configured pattern is custom.
x -custom_increment_value
x The value of the custom increment being configured by the current command.
x This argument is valid only if the configured pattern is custom.
x -custom_increment_count
x The count of the custom increment being configured by the current command.
x This argument is valid only if the configured pattern is custom.
x -repeatable_random_seed
x The seed that will be used by the repeatable random pattern configured by the current command.
x This argument is valid only if the configured pattern is repeatable_random.
x -repeatable_random_count
x The number of random values that will be generated by the repeatable random
x pattern configured by the current command.
x This argument is valid only if the configured pattern is repeatable_random.
x -repeatable_random_fixed
x A template that can be used to configure a static part of the values
x that will be generated.
x This argument is valid only if the configured pattern is repeatable_random.
x -repeatable_random_mask
x A mask that can be used to select which parts of the fixed value will
x not be changed when a new value is generated.
x This argument is valid only if the configured pattern is repeatable_random.
x -repeatable_random_range_min
x This is the minimum value of the range generated by the repeatable random range
x This argument is valid only if the configured pattern is repeatable_random_range.
x -repeatable_random_range_max
x This is the maximum value of the range generated by the repeatable random range
x This argument is valid only if the configured pattern is repeatable_random_range.
x -repeatable_random_range_step
x This is the minimum difference between generated value by the repeatable random range
x This argument is valid only if the configured pattern is repeatable_random_range.
x -repeatable_random_range_seed
x The seed that will be used by the repeatable random range pattern configured by the current command.
x This argument is valid only if the configured pattern is repeatable_random_range.
x -custom_distribution_values
x The values that will be used by the custom distributed multivalue configured by this command.
x This argument is valid only if the configured pattern is custom_distributed.
x -custom_distribution_percentages
x The distribution percentages that will be used.
x This argument is valid only if the configured pattern is custom_distributed.
x -custom_distribution_weights
x The distribution weights that will be used.
x This argument is valid only if the configured pattern is custom_distributed.
x -custom_distribution_algorithm
x The algorithm that will be used to distribute the values specified in custom_distribution_values.
x -custom_distribution_mode
x The mode in which the distribution algorithm specified by custom_distribution_algorithm will be applied.
x -distributed_value
x The value that will be distributed among the individual items configured with
x the current multivalue.
x This argument is valid only if the configured pattern is distributed.
x -string_pattern
x The string pattern that will be used by the multivalue configured by the current command.
x This argument is valid only if the configured pattern is string.
x -alternate_value
x The start value for the alternate pattern.
x -values_list
x A list of values that will be used to populate the corresponding attribute.
x If not enough values are supplied, the existing values will be reused as many times as necessary.
x -values_file
x The full path of a local file that will be used to import the list of values for the value_list pattern.
x The file should be in either CSV, CISCO or Juniper format. This argument's value will be used only if th values_list argument was not manually specified.
x -values_file_type
x The type of file that will be used to import the list of values for the value_list pattern.
x This argument is used only when values_file is specified and used as well and it has a default value of csv.
x -values_file_column_index
x The0-based index of the column that will be used to import the values.
x This argument is used only when values_file is specified and used as well and it has a default value of 0.
x -subset_source
x The handle of the protocol stack that will be used as a source of values for the corresponding attribute.
x -subset_source_attribute
x The name of the attribute that will be used as a source of values.
x The value of this argument will be ignored if no value was specified for subset_source.
x This argument can be omitted if the destination protocol stack is of the same type as the source protocol stack. In this case the name of the destination attribute will be used as the name of the source attribute.
x -subset_round_robin_mode
x The type of round robin distribution tat will be used to populate the values of the target attribute using the source values.
Return Values:
A list containing the multivalue protocol stack handles that were added by the command (if any).
x key:multivalue_handle value:A list containing the multivalue protocol stack handles that were added by the command (if any).
A list containing the custom protocol stack handles that were added by the command (if any).
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/multivalue_config.py_part1
|
x This argument can be a comma separated list of values if we want to
x configure multiple overlays with a single command.
x -overlay_value_step
x The step used by an overlay.
x This argument should only be used if you want to create overlay patterns.
x This argument can be a comma separated list of values if we want to
x configure multiple overlays with a single command.
x -overlay_index
x The index at which the overlay will be created.
x This argument can be a comma separated list of values if we want to
x configure multiple overlays with a single command.
x -overlay_index_step
x The index step controls the inteval at which successive overlays will be created.
x This argument should only be used if you want to create overlay patterns.
x This argument can be a comma separated list of values if we want to
x configure multiple overlays with a single command.
x -overlay_count
x The number of overlays which will be generated by the corresponding overlay pattern.
x This argument should only be used if you want to create overlay patterns.
x This argument can be a comma separated list of values if we want to
x configure multiple overlays with a single command.
x -clear_existing_overlays
x This flag can be used to remove all overlays from a multivalue.
x -custom_start
x The start value for the custom pattern.
x This argument is valid only if the configured pattern is custom.
x -custom_step
x The step value for the custom pattern.
x This argument is valid only if the configured pattern is custom.
x -custom_increment_value
x The value of the custom increment being configured by the current command.
x This argument is valid only if the configured pattern is custom.
x -custom_increment_count
x The count of the custom increment being configured by the current command.
x This argument is valid only if the configured pattern is custom.
x -repeatable_random_seed
x The seed that will be used by the repeatable random pattern configured by the current command.
x This argument is valid only if the configured pattern is repeatable_random.
x -repeatable_random_count
x The number of random values that will be generated by the repeatable random
x pattern configured by the current command.
x This argument is valid only if the configured pattern is repeatable_random.
x -repeatable_random_fixed
x A template that can be used to configure a static part of the values
x that will be generated.
x This argument is valid only if the configured pattern is repeatable_random.
x -repeatable_random_mask
x A mask that can be used to select which parts of the fixed value will
x not be changed when a new value is generated.
x This argument is valid only if the configured pattern is repeatable_random.
x -repeatable_random_range_min
x This is the minimum value of the range generated by the repeatable random range
x This argument is valid only if the configured pattern is repeatable_random_range.
x -repeatable_random_range_max
x This is the maximum value of the range generated by the repeatable random range
x This argument is valid only if the configured pattern is repeatable_random_range.
x -repeatable_random_range_step
x This is the minimum difference between generated value by the repeatable random range
x This argument is valid only if the configured pattern is repeatable_random_range.
x -repeatable_random_range_seed
x The seed that will be used by the repeatable random range pattern configured by the current command.
x This argument is valid only if the configured pattern is repeatable_random_range.
x -custom_distribution_values
x The values that will be used by the custom distributed multivalue configured by this command.
x This argument is valid only if the configured pattern is custom_distributed.
x -custom_distribution_percentages
x The distribution percentages that will be used.
x This argument is valid only if the configured pattern is custom_distributed.
x -custom_distribution_weights
x The distribution weights that will be used.
x This argument is valid only if the configured pattern is custom_distributed.
x -custom_distribution_algorithm
x The algorithm that will be used to distribute the values specified in custom_distribution_values.
x -custom_distribution_mode
x The mode in which the distribution algorithm specified by custom_distribution_algorithm will be applied.
x -distributed_value
x The value that will be distributed among the individual items configured with
x the current multivalue.
x This argument is valid only if the configured pattern is distributed.
x -string_pattern
x The string pattern that will be used by the multivalue configured by the current command.
x This argument is valid only if the configured pattern is string.
x -alternate_value
x The start value for the alternate pattern.
x -values_list
x A list of values that will be used to populate the corresponding attribute.
x If not enough values are supplied, the existing values will be reused as many times as necessary.
x -values_file
x The full path of a local file that will be used to import the list of values for the value_list pattern.
x The file should be in either CSV, CISCO or Juniper format. This argument's value will be used only if th values_list argument was not manually specified.
x -values_file_type
x The type of file that will be used to import the list of values for the value_list pattern.
x This argument is used only when values_file is specified and used as well and it has a default value of csv.
x -values_file_column_index
x The0-based index of the column that will be used to import the values.
x This argument is used only when values_file is specified and used as well and it has a default value of 0.
x -subset_source
x The handle of the protocol stack that will be used as a source of values for the corresponding attribute.
x -subset_source_attribute
x The name of the attribute that will be used as a source of values.
x The value of this argument will be ignored if no value was specified for subset_source.
x This argument can be omitted if the destination protocol stack is of the same type as the source protocol stack. In this case the name of the destination attribute will be used as the name of the source attribute.
x -subset_round_robin_mode
x The type of round robin distribution tat will be used to populate the values of the target attribute using the source values.
Return Values:
A list containing the multivalue protocol stack handles that were added by the command (if any).
x key:multivalue_handle value:A list containing the multivalue protocol stack handles that were added by the command (if any).
A list containing the custom protocol stack handles that were added by the command (if any).
x key:custom_handle value:A list containing the custom protocol stack handles that were added by the command (if any).
A list containing the increment protocol stack handles that were added by the command (if any).
x key:increment_handle value:A list containing the increment protocol stack handles that were added by the command (if any).
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = ['values_file']
try:
return self.__execute_command(
'multivalue_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/multivalue_config.py_part2
|
x key:custom_handle value:A list containing the custom protocol stack handles that were added by the command (if any).
A list containing the increment protocol stack handles that were added by the command (if any).
x key:increment_handle value:A list containing the increment protocol stack handles that were added by the command (if any).
Examples:
Sample Input:
Sample Output:
Notes:
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = ['values_file']
try:
return self.__execute_command(
'multivalue_config',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/multivalue_config.py_part3
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def ixnetwork_traffic_control(self, action, **kwargs):
r'''
#Procedure Header
Name:
ixnetwork_traffic_control
Description:
This command starts or stops traffic on a given port list.
Synopsis:
ixnetwork_traffic_control
-action CHOICES sync_run
CHOICES run
CHOICES manual_trigger
CHOICES stop
CHOICES poll
CHOICES reset
CHOICES destroy
CHOICES clear_stats
CHOICES apply
CHOICES regenerate
[-latency_bins RANGE 2-16]
[-latency_values ANY]
x [-latency_enable CHOICES 0 1]
[-port_handle REGEXP ^[0-9]+/[0-9]+/[0-9]+$]
x [-cpdp_convergence_enable CHOICES 0 1]
x [-cpdp_ctrl_plane_events_enable CHOICES 0 1]
x [-cpdp_data_plane_events_rate_monitor_enable CHOICES 0 1]
x [-cpdp_data_plane_threshold NUMERIC]
x [-cpdp_data_plane_jitter ANY]
x [-delay_variation_enable CHOICES 0 1]
x [-disable_latency_bins FLAG]
x [-disable_jitter_bins FLAG]
x [-duration NUMERIC]
x [-handle ANY]
x [-instantaneous_stats_enable CHOICES 0 1]
x [-jitter_bins RANGE 2-16]
x [-jitter_values ANY]
x [-l1_rate_stats_enable CHOICES 0 1]
x [-misdirected_per_flow CHOICES 0 1]
x [-large_seq_number_err_threshold NUMERIC]
x [-latency_control CHOICES cut_through
x CHOICES store_and_forward
x CHOICES store_and_forward_preamble
x CHOICES mef_frame_delay
x CHOICES forwarding_delay]
x [-max_wait_timer NUMERIC
x DEFAULT 0]
x [-packet_loss_duration_enable CHOICES 0 1]
x [-stats_mode CHOICES rx_delay_variation_avg
x CHOICES rx_delay_variation_err_and_rate
x CHOICES rx_delay_variation_min_max_and_rate]
x [-type CHOICES l23 l47
x DEFAULT l23]
x [-traffic_generator CHOICES ixos ixnetwork ixnetwork_540
x DEFAULT ixos]
Arguments:
-action
Action to take. Valid choices are:
-latency_bins
The number of latency bins.
Valid for traffic_generator ixos/ixnetwork_540.
Otherwise, it will be ignored. When -traffic_generator is ixnetwork_540
this option will configure latency bins for all traffic items that have -port_handle
as a receiving port. If port_handle is not specified, it will configure latency
on all traffic items. If latency was previously configured on a traffic item
with ::ixia::traffic_config procedure, then latency bins will not be reconfigured.
With traffic_generator ixnetwork_540 this option along with latency_values
parameter triggers enable of global latency bins statistics.
For ixnetwork_540 there is special value "enabled" which specifies that
latency bins statistics will be enabled using the latency values and bins
curently configured for each traffic item (no need to specify the latency_values).
Latency cannot be enabled in the following conditions:
1. delay_variation_enable is 1.
2. jitter_bins and jitter_values are specified.
3. cpdp_convergence_enable is 1 and cpdp_data_plane_events_rate_monitor_enable is 1.
-latency_values
The splitting values for the bins.0 and Max will be the absolute end
points. A list of {1.5 3 6.8} would create these four bins {0 - 1.5}
{1.5 3} {3 6.8} {6.8 MAX}. It is always greater than the lower value
and equal to or less than the upper value.
This option is supported only if -traffic_generator is set to ixos/ixnetwork_540.
Otherwise, it will be ignored. When -traffic_generator is ixnetwork_540
this option will configure latency bins for all traffic items that have -port_handle
as a receiving port. If port_handle is not specified, it will configure latency
on all traffic items. If latency was previously configured on a traffic item
with ::ixia::traffic_config procedure, then latency bins will not be reconfigured.
With traffic_generator ixnetwork_540 this option along with latency_bins
parameter triggers enable of global latency bins statistics. Latency cannot be enabled
in the following conditions:
1. delay_variation_enable is 1.
2. jitter_bins and jitter_values are specified.
3. cpdp_convergence_enable is 1 and cpdp_data_plane_events_rate_monitor_enable is 1.
Valid for traffic_generator ixos/ixnetwork/ixnetwork_540.
x -latency_enable
x If true, latency statistics is enabled and if false, latency statistics is disabled
-port_handle
List ports where action is to be taken.
Mandatory if -traffic_generator is set to ixos.
If -traffic_generator is set to ixnetwork the actions that will be
provided using -action parameter, will be applied to all ports added
in the configuration or to all traffic items, depending on the action.
Valid for traffic_generator ixos/ixnetwork/ixnetwork_540.
x -cpdp_convergence_enable
x Valid only for traffic_generator ixnetwork_540. This option enables/disables
x global control plane and data plane integrated time stamping for calculating
x convergence measurements. Valid choices are:
x 0 - disable
x 1 - enable
x -cpdp_ctrl_plane_events_enable
x Valid only for traffic_generator ixnetwork_540 when cpdp_convergence_enable is 1.
x Enable/Disable control Plane (Protocol) state change or event timestamps used for
x convergence measurement. Valid choices are:
x 0 - disable
x 1 - enable
x -cpdp_data_plane_events_rate_monitor_enable
x Valid only for traffic_generator ixnetwork_540 when cpdp_convergence_enable is 1.
x Enable/Disable receive ports rate monitoring to detect convergence event
x and capture timestamp. Data Plane events cannot be enabled in the following conditions:
x 1. Sequence checking is enabled (sequence checking is configure with procedure
x traffic_config, parameter -frame_sequencing).
x 2. delay_variation_enable is 1.
x 3. latency_bins and latency_values parameters are used.
x Valid choices are:
x 0 - disable
x 1 - enable
x -cpdp_data_plane_threshold
x Valid only for traffic_generator ixnetwork_540 when cpdp_convergence_enable is 1.
x Configure Rx Rate threshold which is a percent of tx rate used to calculate the
x data plane convergence (value used to capture timestamps for both the Below Tx
x Rate threshold and Above threshold).
x -cpdp_data_plane_jitter
x Valid only for traffic_generator ixnetwork_540 when cpdp_convergence_enable is 1.
x Configure DataPlane jitter window. (TBD)
x -delay_variation_enable
x Valid only for traffic_generator ixnetwork_540. This option enables/disables
x global one-way per packet delay measurement from output port to input port. Valid
x choices are:
x 0 - disable
x 1 - enable
x -disable_latency_bins
x Valid only for traffic_generator ixnetwork_540. This options disables global
x latency bins statistic measurements.
x -disable_jitter_bins
x Valid only for traffic_generator ixnetwork_540. This options disables global
x jitter bins statistic measurements.
x -duration
x Duration in seconds of traffic to run.
x To set the duration of the traffic use the procedure
x ::ixia::traffic_config with the parameter -duration set to a value
x in seconds to run frame size or mix of frame sizes.
x Valid only for traffic_generator ixos/ixnetwork_540.
x -handle
x The handle that is used to identify an individual traffic item. It can be a list
x of traffic item names, traffic item handles, or items that have as ancestor a traffic item.
x Valid only for traffic_generator ixnetwork_540.
x -instantaneous_stats_enable
x Enables/disables instantaneous mode for statistics retrieval.
x When this is set with a different value that is currently in IxNetwork,
x all the traffic items will be stopped and regenerated.
x If -action is not run or sync_run the caller must issue an
x ::ixia::traffic_control -action run to start/resume traffic.
x Valid only for traffic_generator ixnetwork_540.
x -jitter_bins
x The number of jitter bins.
x Valid only for traffic_generator ixnetwork_540.
x Otherwise, it will be ignored. When -traffic_generator is ixnetwork_540
x this option will configure jitter bins for all traffic items that have -port_handle
x as a receiving port. If port_handle is not specified, it will configure jitter
x on all traffic items. If jitter was previously configured on a traffic item
x with ::ixia::traffic_config procedure, then jitter bins will not be reconfigured.
x With traffic_generator ixnetwork_540 this option along with jitter_values
x parameter triggers enable of global jitter bins statistics.
x For ixnetwork_540 there is special value "enabled" which specifies that
x latency bins statistics will be enabled using the latency values and bins
x curently configured for each traffic item (no need to specify the latency_values).
x Jitter bins cannot be enabled in the following conditions:
x 1. latency_bins and latency_values parameters are used.
x 2. delay_variation_enable is 1.
x 3. Sequence checking is enabled (sequence checking is configure with procedure
x traffic_config, parameter -frame_sequencing).
x -jitter_values
x Same as latency bins but, if jitter bins are provided then
x jitter measurements will be retrieved with ::ixia::traffic_stats.
x Valid only for traffic_generator ixos/ixnetwork_540.
x Otherwise, it will be ignored. When -traffic_generator is ixnetwork_540
x this option will configure jitter bins for all traffic items that have -port_handle
x as a receiving port. If port_handle is not specified, it will configure jitter
x on all traffic items. If jitter was previously configured on a traffic item
x with ::ixia::traffic_config procedure, then jitter bins will not be reconfigured.
x With traffic_generator ixnetwork_540 this option along with jitter_bins
x parameter triggers enable of global jitter bins statistics. Jitter bins
x cannot be enabled in the following conditions:
x 1. latency_bins and latency_values parameters are used.
x 2. delay_variation_enable is 1.
x 3. Sequence checking is enabled (sequence checking is configure with procedure
x traffic_config, parameter -frame_sequencing).
x -l1_rate_stats_enable
x When this option is enabled the Layer 1 Rate Statistics will be returned when
x using ::ixia::traffic_stats with mode aggregate or all. Not specifying this
x parameter will cause the Layer 1 Rate Statistics to be returned only if the
x "Enable L1 Rate Statistics" option was enabled "Traffic Options" in the GUI.
x Setting this parameters from HLT API will also be reflected in IxNetwork GUI.
x This parameter is valid only when action is one of the following: run, sync_run,
x stop and reset. This parameter applies globally, not per traffic item.
x Valid choices are:
x 0 - disable
x 1 - enable
x Valid only for traffic_generator ixnetwork_540.
x -misdirected_per_flow
x When this option is enabled the Misdirected Per Flow Statistics will be returned when
x using ::ixia::traffic_stats with mode aggregate or all. Not specifying this
x parameter will cause the Layer 1 Rate Statistics to be returned only if the
x "Misdirected Per Flow Statistics" option was enabled "Traffic Options" in the GUI.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ixnetwork_traffic_control.py_part1
|
x Valid only for traffic_generator ixnetwork_540 when cpdp_convergence_enable is 1.
x Enable/Disable control Plane (Protocol) state change or event timestamps used for
x convergence measurement. Valid choices are:
x 0 - disable
x 1 - enable
x -cpdp_data_plane_events_rate_monitor_enable
x Valid only for traffic_generator ixnetwork_540 when cpdp_convergence_enable is 1.
x Enable/Disable receive ports rate monitoring to detect convergence event
x and capture timestamp. Data Plane events cannot be enabled in the following conditions:
x 1. Sequence checking is enabled (sequence checking is configure with procedure
x traffic_config, parameter -frame_sequencing).
x 2. delay_variation_enable is 1.
x 3. latency_bins and latency_values parameters are used.
x Valid choices are:
x 0 - disable
x 1 - enable
x -cpdp_data_plane_threshold
x Valid only for traffic_generator ixnetwork_540 when cpdp_convergence_enable is 1.
x Configure Rx Rate threshold which is a percent of tx rate used to calculate the
x data plane convergence (value used to capture timestamps for both the Below Tx
x Rate threshold and Above threshold).
x -cpdp_data_plane_jitter
x Valid only for traffic_generator ixnetwork_540 when cpdp_convergence_enable is 1.
x Configure DataPlane jitter window. (TBD)
x -delay_variation_enable
x Valid only for traffic_generator ixnetwork_540. This option enables/disables
x global one-way per packet delay measurement from output port to input port. Valid
x choices are:
x 0 - disable
x 1 - enable
x -disable_latency_bins
x Valid only for traffic_generator ixnetwork_540. This options disables global
x latency bins statistic measurements.
x -disable_jitter_bins
x Valid only for traffic_generator ixnetwork_540. This options disables global
x jitter bins statistic measurements.
x -duration
x Duration in seconds of traffic to run.
x To set the duration of the traffic use the procedure
x ::ixia::traffic_config with the parameter -duration set to a value
x in seconds to run frame size or mix of frame sizes.
x Valid only for traffic_generator ixos/ixnetwork_540.
x -handle
x The handle that is used to identify an individual traffic item. It can be a list
x of traffic item names, traffic item handles, or items that have as ancestor a traffic item.
x Valid only for traffic_generator ixnetwork_540.
x -instantaneous_stats_enable
x Enables/disables instantaneous mode for statistics retrieval.
x When this is set with a different value that is currently in IxNetwork,
x all the traffic items will be stopped and regenerated.
x If -action is not run or sync_run the caller must issue an
x ::ixia::traffic_control -action run to start/resume traffic.
x Valid only for traffic_generator ixnetwork_540.
x -jitter_bins
x The number of jitter bins.
x Valid only for traffic_generator ixnetwork_540.
x Otherwise, it will be ignored. When -traffic_generator is ixnetwork_540
x this option will configure jitter bins for all traffic items that have -port_handle
x as a receiving port. If port_handle is not specified, it will configure jitter
x on all traffic items. If jitter was previously configured on a traffic item
x with ::ixia::traffic_config procedure, then jitter bins will not be reconfigured.
x With traffic_generator ixnetwork_540 this option along with jitter_values
x parameter triggers enable of global jitter bins statistics.
x For ixnetwork_540 there is special value "enabled" which specifies that
x latency bins statistics will be enabled using the latency values and bins
x curently configured for each traffic item (no need to specify the latency_values).
x Jitter bins cannot be enabled in the following conditions:
x 1. latency_bins and latency_values parameters are used.
x 2. delay_variation_enable is 1.
x 3. Sequence checking is enabled (sequence checking is configure with procedure
x traffic_config, parameter -frame_sequencing).
x -jitter_values
x Same as latency bins but, if jitter bins are provided then
x jitter measurements will be retrieved with ::ixia::traffic_stats.
x Valid only for traffic_generator ixos/ixnetwork_540.
x Otherwise, it will be ignored. When -traffic_generator is ixnetwork_540
x this option will configure jitter bins for all traffic items that have -port_handle
x as a receiving port. If port_handle is not specified, it will configure jitter
x on all traffic items. If jitter was previously configured on a traffic item
x with ::ixia::traffic_config procedure, then jitter bins will not be reconfigured.
x With traffic_generator ixnetwork_540 this option along with jitter_bins
x parameter triggers enable of global jitter bins statistics. Jitter bins
x cannot be enabled in the following conditions:
x 1. latency_bins and latency_values parameters are used.
x 2. delay_variation_enable is 1.
x 3. Sequence checking is enabled (sequence checking is configure with procedure
x traffic_config, parameter -frame_sequencing).
x -l1_rate_stats_enable
x When this option is enabled the Layer 1 Rate Statistics will be returned when
x using ::ixia::traffic_stats with mode aggregate or all. Not specifying this
x parameter will cause the Layer 1 Rate Statistics to be returned only if the
x "Enable L1 Rate Statistics" option was enabled "Traffic Options" in the GUI.
x Setting this parameters from HLT API will also be reflected in IxNetwork GUI.
x This parameter is valid only when action is one of the following: run, sync_run,
x stop and reset. This parameter applies globally, not per traffic item.
x Valid choices are:
x 0 - disable
x 1 - enable
x Valid only for traffic_generator ixnetwork_540.
x -misdirected_per_flow
x When this option is enabled the Misdirected Per Flow Statistics will be returned when
x using ::ixia::traffic_stats with mode aggregate or all. Not specifying this
x parameter will cause the Layer 1 Rate Statistics to be returned only if the
x "Misdirected Per Flow Statistics" option was enabled "Traffic Options" in the GUI.
x Setting this parameters from HLT API will also be reflected in IxNetwork GUI.
x This parameter is valid only when action is one of the following: run, sync_run,
x stop and reset. This parameter applies globally, not per traffic item.
x Valid choices are:
x 0 - disable
x 1 - enable
x Valid only for traffic_generator ixnetwork_540.
x -large_seq_number_err_threshold
x Valid only for traffic_generator ixnetwork_540 and delay_variation_enable 1.
x This option configures the threshold value used to determine error levels
x for out-of-sequence, received packets.
x -latency_control
x Valid only for traffic_generator ixos/ixnetwork_540
x and delay_variation_enable is '1' or latency_bins and latency_values parameters
x are present and disable_latency_bins is not present.
x Otherwise, it will be ignored. Not all options are supported on all ports. Check
x the reference guide for compatibility chart. Valid choices are:
x cut_through - the time interval between the first data bit out of the
x Ixia transmit port and the first data bit received by
x the Ixia receive port is measured.
x store_and_forward - the time interval between the last data bit out
x of the Ixia transmit port and the first data bit
x received by the Ixia receive port is measured.
x store_and_forward_preamble - (for Ethernet modules only with traffic_generator ixos) As with
x store and forward, but measured with respect to the
x preamble to the Ethernet frame. In this case, the time
x interval between the last data bit out of the Ixia
x transmit port and the first preamble data bit received
x by the Ixia receive port is measured.
x mef_frame_delay - valid only for traffic_generator ixnetwork_540. Standard
x MEF 10.1 and RFC 3393. The time interval starting when the First
x bit of the input frame reaches the input port and ending when
x the last bit of the output frame is seen on the output port (FILO)
x forwarding_delay - valid only for traffic_generator ixnetwork_540. Standard
x RFC 4689. The time interval starting when the last
x bit of the input frame reaches the input port and ending when
x the last bit of the output frame is seen on the output port (LILO)
x -max_wait_timer
x The maximum amount of time (in seconds) that HLT waits for the traffic command
x to take effect. For example after starting traffic HLT will wait for the traffic
x to actually start but no more than <max_wait_timer> seconds. When using many ports
x this parameter has to be higher.
x Default value is 0 (don't wait).
x Valid only for traffic_generator ixnetwork.
x -packet_loss_duration_enable
x Valid only for traffic_generator ixnetwork_540.
x Estimated time without received packets, calculated by frames delta at the
x expected rx rate. Valid choices are:
x 0 - disable
x 1 - enable
x -stats_mode
x Valid only for traffic_generator ixnetwork_540 when delay_variation is '1'.
x -type
x The type of the configured traffic that should be applied on the
x chassis. Valid for traffic_generator ixnetwork.
x Otherwise, it will be ignored.
x -traffic_generator
x The Ixia product that was used for configuring traffic.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
On status of failure, gives detailed information.
key:log value:On status of failure, gives detailed information.
0 if traffic is running, or 1 if traffic is stopped. This key is returned when option -action is set on run, sync_run or stop.
key:stopped value:0 if traffic is running, or 1 if traffic is stopped. This key is returned when option -action is set on run, sync_run or stop.
key:-ipv6_hop_by_hop_options follow value:
<CHOICES pad1 padn jumbo router_alert binding_update binding_ack binding_req user_define mipv6_unique_id_sub mipv6_alternative_coa_sub user_defined> This is a mandatory key. The type of IPv6 Hop by Hop option that needs to be added. According to RFC 2711, there should only be one router_alert option per hop by hop extension. Configuring against the RFC the results may not be the expected ones. Valid only for traffic_generator ixos/ixnetwork_540. With ixnetwork_540 the supported types are pad1 padn and user_defined.
key:type value:<CHOICES pad1 padn jumbo router_alert binding_update binding_ack binding_req user_define mipv6_unique_id_sub mipv6_alternative_coa_sub user_defined> This is a mandatory key. The type of IPv6 Hop by Hop option that needs to be added. According to RFC 2711, there should only be one router_alert option per hop by hop extension. Configuring against the RFC the results may not be the expected ones. Valid only for traffic_generator ixos/ixnetwork_540. With ixnetwork_540 the supported types are pad1 padn and user_defined.
<RANGE 0-255> This applies to all key types except pad1. The length value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos/ixnetwork_540.
key:length value:<RANGE 0-255> This applies to all key types except pad1. The length value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos/ixnetwork_540.
<HEX BYTES separated by : or . > This applies to padn, user_define types. The value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos/ixnetwork_540.
key:value value:<HEX BYTES separated by : or . > This applies to padn, user_define types. The value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos/ixnetwork_540.
<RANGE 0-4294967295> This applies to jumbo type. The payload for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos.
key:payload value:<RANGE 0-4294967295> This applies to jumbo type. The payload for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos.
<RANGE 0-65535> This applies to mipv6_unique_id_sub type. A unique ID for the binding request. Valid only for traffic_generator ixos.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ixnetwork_traffic_control.py_part2
|
x "Misdirected Per Flow Statistics" option was enabled "Traffic Options" in the GUI.
x Setting this parameters from HLT API will also be reflected in IxNetwork GUI.
x This parameter is valid only when action is one of the following: run, sync_run,
x stop and reset. This parameter applies globally, not per traffic item.
x Valid choices are:
x 0 - disable
x 1 - enable
x Valid only for traffic_generator ixnetwork_540.
x -large_seq_number_err_threshold
x Valid only for traffic_generator ixnetwork_540 and delay_variation_enable 1.
x This option configures the threshold value used to determine error levels
x for out-of-sequence, received packets.
x -latency_control
x Valid only for traffic_generator ixos/ixnetwork_540
x and delay_variation_enable is '1' or latency_bins and latency_values parameters
x are present and disable_latency_bins is not present.
x Otherwise, it will be ignored. Not all options are supported on all ports. Check
x the reference guide for compatibility chart. Valid choices are:
x cut_through - the time interval between the first data bit out of the
x Ixia transmit port and the first data bit received by
x the Ixia receive port is measured.
x store_and_forward - the time interval between the last data bit out
x of the Ixia transmit port and the first data bit
x received by the Ixia receive port is measured.
x store_and_forward_preamble - (for Ethernet modules only with traffic_generator ixos) As with
x store and forward, but measured with respect to the
x preamble to the Ethernet frame. In this case, the time
x interval between the last data bit out of the Ixia
x transmit port and the first preamble data bit received
x by the Ixia receive port is measured.
x mef_frame_delay - valid only for traffic_generator ixnetwork_540. Standard
x MEF 10.1 and RFC 3393. The time interval starting when the First
x bit of the input frame reaches the input port and ending when
x the last bit of the output frame is seen on the output port (FILO)
x forwarding_delay - valid only for traffic_generator ixnetwork_540. Standard
x RFC 4689. The time interval starting when the last
x bit of the input frame reaches the input port and ending when
x the last bit of the output frame is seen on the output port (LILO)
x -max_wait_timer
x The maximum amount of time (in seconds) that HLT waits for the traffic command
x to take effect. For example after starting traffic HLT will wait for the traffic
x to actually start but no more than <max_wait_timer> seconds. When using many ports
x this parameter has to be higher.
x Default value is 0 (don't wait).
x Valid only for traffic_generator ixnetwork.
x -packet_loss_duration_enable
x Valid only for traffic_generator ixnetwork_540.
x Estimated time without received packets, calculated by frames delta at the
x expected rx rate. Valid choices are:
x 0 - disable
x 1 - enable
x -stats_mode
x Valid only for traffic_generator ixnetwork_540 when delay_variation is '1'.
x -type
x The type of the configured traffic that should be applied on the
x chassis. Valid for traffic_generator ixnetwork.
x Otherwise, it will be ignored.
x -traffic_generator
x The Ixia product that was used for configuring traffic.
Return Values:
$::SUCCESS | $::FAILURE
key:status value:$::SUCCESS | $::FAILURE
On status of failure, gives detailed information.
key:log value:On status of failure, gives detailed information.
0 if traffic is running, or 1 if traffic is stopped. This key is returned when option -action is set on run, sync_run or stop.
key:stopped value:0 if traffic is running, or 1 if traffic is stopped. This key is returned when option -action is set on run, sync_run or stop.
key:-ipv6_hop_by_hop_options follow value:
<CHOICES pad1 padn jumbo router_alert binding_update binding_ack binding_req user_define mipv6_unique_id_sub mipv6_alternative_coa_sub user_defined> This is a mandatory key. The type of IPv6 Hop by Hop option that needs to be added. According to RFC 2711, there should only be one router_alert option per hop by hop extension. Configuring against the RFC the results may not be the expected ones. Valid only for traffic_generator ixos/ixnetwork_540. With ixnetwork_540 the supported types are pad1 padn and user_defined.
key:type value:<CHOICES pad1 padn jumbo router_alert binding_update binding_ack binding_req user_define mipv6_unique_id_sub mipv6_alternative_coa_sub user_defined> This is a mandatory key. The type of IPv6 Hop by Hop option that needs to be added. According to RFC 2711, there should only be one router_alert option per hop by hop extension. Configuring against the RFC the results may not be the expected ones. Valid only for traffic_generator ixos/ixnetwork_540. With ixnetwork_540 the supported types are pad1 padn and user_defined.
<RANGE 0-255> This applies to all key types except pad1. The length value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos/ixnetwork_540.
key:length value:<RANGE 0-255> This applies to all key types except pad1. The length value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos/ixnetwork_540.
<HEX BYTES separated by : or . > This applies to padn, user_define types. The value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos/ixnetwork_540.
key:value value:<HEX BYTES separated by : or . > This applies to padn, user_define types. The value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos/ixnetwork_540.
<RANGE 0-4294967295> This applies to jumbo type. The payload for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos.
key:payload value:<RANGE 0-4294967295> This applies to jumbo type. The payload for the IPv6 Hop by Hop option. Valid only for traffic_generator ixos.
<RANGE 0-65535> This applies to mipv6_unique_id_sub type. A unique ID for the binding request. Valid only for traffic_generator ixos.
key:sub_unique value:<RANGE 0-65535> This applies to mipv6_unique_id_sub type. A unique ID for the binding request. Valid only for traffic_generator ixos.
<CHOICES mld rsvp active_net> This applies to router_alert type. Specifies the type of router alert to include with the packet. Valid only for traffic_generator ixos.
key:alert_type value:<CHOICES mld rsvp active_net> This applies to router_alert type. Specifies the type of router alert to include with the packet. Valid only for traffic_generator ixos.
<CHOICES 0 1> This applies to binding_update type. This flag sets the Acknowledge (A) bit to indicate that the sending mobile node is requesting that a Binding Acknowledgement be sent by the receiving node when it gets the Binding Update. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:ack value:<CHOICES 0 1> This applies to binding_update type. This flag sets the Acknowledge (A) bit to indicate that the sending mobile node is requesting that a Binding Acknowledgement be sent by the receiving node when it gets the Binding Update. Valid only for traffic_generator ixos. (DEFAULT = 0)
<CHOICES 0 1> This applies to binding_update type. Enables the bicasting flag for the Binding Update header. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:bicast value:<CHOICES 0 1> This applies to binding_update type. Enables the bicasting flag for the Binding Update header. Valid only for traffic_generator ixos. (DEFAULT = 0)
<CHOICES 0 1> This applies to binding_update type. This flag sets the Duplicate Address Detection (D) bit, to indicate that the sending node wants the receiving node to perform Duplicate Address Detection for the mobile node s home address in this binding. The H and A bits MUST also be set for this action to be performed. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:duplicate value:<CHOICES 0 1> This applies to binding_update type. This flag sets the Duplicate Address Detection (D) bit, to indicate that the sending node wants the receiving node to perform Duplicate Address Detection for the mobile node s home address in this binding. The H and A bits MUST also be set for this action to be performed. Valid only for traffic_generator ixos. (DEFAULT = 0)
<CHOICES 0 1> This applies to binding_update type. This flag sets the Home Registration (H) bit to indicate that the sending node wants the receiving node to act as its home agent. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:home value:<CHOICES 0 1> This applies to binding_update type. This flag sets the Home Registration (H) bit to indicate that the sending node wants the receiving node to act as its home agent. Valid only for traffic_generator ixos. (DEFAULT = 0)
<CHOICES 0 1> This applies to binding_update type. Enables the map flag for the Binding Update header. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:map value:<CHOICES 0 1> This applies to binding_update type. Enables the map flag for the Binding Update header. Valid only for traffic_generator ixos. (DEFAULT = 0)
<CHOICES 0 1> This applies to binding_update type. This flag indicates if the binding cache entry is for a mobile node advertised as a router by this node, on the behalf of the mobile node, in proxy Neighbor Advertisements. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:router value:<CHOICES 0 1> This applies to binding_update type. This flag indicates if the binding cache entry is for a mobile node advertised as a router by this node, on the behalf of the mobile node, in proxy Neighbor Advertisements. Valid only for traffic_generator ixos. (DEFAULT = 0)
<RANGE 0-255> This applies to binding_update type. If the H-bit is set, this is the length of the routing prefix for the home address. Valid only for traffic_generator ixos.
key:prefix_len value:<RANGE 0-255> This applies to binding_update type. If the H-bit is set, this is the length of the routing prefix for the home address. Valid only for traffic_generator ixos.
<RANGE 0-4294967295> This applies to binding_update, binding_ack types. (32-bit integer) The number of seconds remaining for the Binding Cache entry. When the value reaches zero, the binding MUST be considered expired and the Binding Cache entry MUST be deleted for the mobile node. Valid only for traffic_generator ixos.
key:life_time value:<RANGE 0-4294967295> This applies to binding_update, binding_ack types. (32-bit integer) The number of seconds remaining for the Binding Cache entry. When the value reaches zero, the binding MUST be considered expired and the Binding Cache entry MUST be deleted for the mobile node. Valid only for traffic_generator ixos.
<RANGE 0-65535> This applies to binding_update, binding_ack types. For type binding_update: The mobile node uses this number in the Binding Update. The receiving node uses the same number in its Binding Acknowledgement, for matching. The Sequence number in each Binding Update to one destination address must be greater than the last. For type binding_ack: This integer is copied from the received Binding Update into the corresponding Binding ACK message. Valid only for traffic_generator ixos.
key:seq_num value:<RANGE 0-65535> This applies to binding_update, binding_ack types. For type binding_update: The mobile node uses this number in the Binding Update. The receiving node uses the same number in its Binding Acknowledgement, for matching. The Sequence number in each Binding Update to one destination address must be greater than the last. For type binding_ack: This integer is copied from the received Binding Update into the corresponding Binding ACK message. Valid only for traffic_generator ixos.
<RANGE 0-255> This applies to binding_ack type. This value indicates the disposition of the Binding Update: 0-127= Binding Update was accepted. >/= 128 = Binding Update was rejected. Valid only for traffic_generator ixos.
key:status value:<RANGE 0-255> This applies to binding_ack type. This value indicates the disposition of the Binding Update: 0-127= Binding Update was accepted. >/= 128 = Binding Update was rejected. Valid only for traffic_generator ixos.
<RANGE 0-4294967295> This applies to binding_ack type. The mobile node SHOULD send a new Binding Update at this recommended interval, to refresh the binding. The receiving node (the node which sends the Binding ACK) determines the refresh interval (in seconds). Valid only for traffic_generator ixos.
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ixnetwork_traffic_control.py_part3
|
<RANGE 0-65535> This applies to mipv6_unique_id_sub type. A unique ID for the binding request. Valid only for traffic_generator ixos.
key:sub_unique value:<RANGE 0-65535> This applies to mipv6_unique_id_sub type. A unique ID for the binding request. Valid only for traffic_generator ixos.
<CHOICES mld rsvp active_net> This applies to router_alert type. Specifies the type of router alert to include with the packet. Valid only for traffic_generator ixos.
key:alert_type value:<CHOICES mld rsvp active_net> This applies to router_alert type. Specifies the type of router alert to include with the packet. Valid only for traffic_generator ixos.
<CHOICES 0 1> This applies to binding_update type. This flag sets the Acknowledge (A) bit to indicate that the sending mobile node is requesting that a Binding Acknowledgement be sent by the receiving node when it gets the Binding Update. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:ack value:<CHOICES 0 1> This applies to binding_update type. This flag sets the Acknowledge (A) bit to indicate that the sending mobile node is requesting that a Binding Acknowledgement be sent by the receiving node when it gets the Binding Update. Valid only for traffic_generator ixos. (DEFAULT = 0)
<CHOICES 0 1> This applies to binding_update type. Enables the bicasting flag for the Binding Update header. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:bicast value:<CHOICES 0 1> This applies to binding_update type. Enables the bicasting flag for the Binding Update header. Valid only for traffic_generator ixos. (DEFAULT = 0)
<CHOICES 0 1> This applies to binding_update type. This flag sets the Duplicate Address Detection (D) bit, to indicate that the sending node wants the receiving node to perform Duplicate Address Detection for the mobile node s home address in this binding. The H and A bits MUST also be set for this action to be performed. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:duplicate value:<CHOICES 0 1> This applies to binding_update type. This flag sets the Duplicate Address Detection (D) bit, to indicate that the sending node wants the receiving node to perform Duplicate Address Detection for the mobile node s home address in this binding. The H and A bits MUST also be set for this action to be performed. Valid only for traffic_generator ixos. (DEFAULT = 0)
<CHOICES 0 1> This applies to binding_update type. This flag sets the Home Registration (H) bit to indicate that the sending node wants the receiving node to act as its home agent. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:home value:<CHOICES 0 1> This applies to binding_update type. This flag sets the Home Registration (H) bit to indicate that the sending node wants the receiving node to act as its home agent. Valid only for traffic_generator ixos. (DEFAULT = 0)
<CHOICES 0 1> This applies to binding_update type. Enables the map flag for the Binding Update header. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:map value:<CHOICES 0 1> This applies to binding_update type. Enables the map flag for the Binding Update header. Valid only for traffic_generator ixos. (DEFAULT = 0)
<CHOICES 0 1> This applies to binding_update type. This flag indicates if the binding cache entry is for a mobile node advertised as a router by this node, on the behalf of the mobile node, in proxy Neighbor Advertisements. Valid only for traffic_generator ixos. (DEFAULT = 0)
key:router value:<CHOICES 0 1> This applies to binding_update type. This flag indicates if the binding cache entry is for a mobile node advertised as a router by this node, on the behalf of the mobile node, in proxy Neighbor Advertisements. Valid only for traffic_generator ixos. (DEFAULT = 0)
<RANGE 0-255> This applies to binding_update type. If the H-bit is set, this is the length of the routing prefix for the home address. Valid only for traffic_generator ixos.
key:prefix_len value:<RANGE 0-255> This applies to binding_update type. If the H-bit is set, this is the length of the routing prefix for the home address. Valid only for traffic_generator ixos.
<RANGE 0-4294967295> This applies to binding_update, binding_ack types. (32-bit integer) The number of seconds remaining for the Binding Cache entry. When the value reaches zero, the binding MUST be considered expired and the Binding Cache entry MUST be deleted for the mobile node. Valid only for traffic_generator ixos.
key:life_time value:<RANGE 0-4294967295> This applies to binding_update, binding_ack types. (32-bit integer) The number of seconds remaining for the Binding Cache entry. When the value reaches zero, the binding MUST be considered expired and the Binding Cache entry MUST be deleted for the mobile node. Valid only for traffic_generator ixos.
<RANGE 0-65535> This applies to binding_update, binding_ack types. For type binding_update: The mobile node uses this number in the Binding Update. The receiving node uses the same number in its Binding Acknowledgement, for matching. The Sequence number in each Binding Update to one destination address must be greater than the last. For type binding_ack: This integer is copied from the received Binding Update into the corresponding Binding ACK message. Valid only for traffic_generator ixos.
key:seq_num value:<RANGE 0-65535> This applies to binding_update, binding_ack types. For type binding_update: The mobile node uses this number in the Binding Update. The receiving node uses the same number in its Binding Acknowledgement, for matching. The Sequence number in each Binding Update to one destination address must be greater than the last. For type binding_ack: This integer is copied from the received Binding Update into the corresponding Binding ACK message. Valid only for traffic_generator ixos.
<RANGE 0-255> This applies to binding_ack type. This value indicates the disposition of the Binding Update: 0-127= Binding Update was accepted. >/= 128 = Binding Update was rejected. Valid only for traffic_generator ixos.
key:status value:<RANGE 0-255> This applies to binding_ack type. This value indicates the disposition of the Binding Update: 0-127= Binding Update was accepted. >/= 128 = Binding Update was rejected. Valid only for traffic_generator ixos.
<RANGE 0-4294967295> This applies to binding_ack type. The mobile node SHOULD send a new Binding Update at this recommended interval, to refresh the binding. The receiving node (the node which sends the Binding ACK) determines the refresh interval (in seconds). Valid only for traffic_generator ixos.
key:refresh value:<RANGE 0-4294967295> This applies to binding_ack type. The mobile node SHOULD send a new Binding Update at this recommended interval, to refresh the binding. The receiving node (the node which sends the Binding ACK) determines the refresh interval (in seconds). Valid only for traffic_generator ixos.
<IPV6> The IPv6 address for mipv6_alternative_coa_sub type. Valid only for traffic_generator ixos.
key:address value:<IPV6> The IPv6 address for mipv6_alternative_coa_sub type. Valid only for traffic_generator ixos.
<CHOICES skip discard discard_icmp discard_icmp_if_not_multicast>. Behavior if option unrecognized. Valid only for traffic_generator ixnetwork_540.
key:unrecognized_type value:<CHOICES skip discard discard_icmp discard_icmp_if_not_multicast>. Behavior if option unrecognized. Valid only for traffic_generator ixnetwork_540.
<CHOICES 0 1>. Allow packet change. Valid only for traffic_generator ixnetwork_540.
key:allow_packet_change value:<CHOICES 0 1>. Allow packet change. Valid only for traffic_generator ixnetwork_540.
<RANGE 0-31>. User defined option type. Valid only for traffic_generator ixnetwork_540.
key:user_defined_type value:<RANGE 0-31>. User defined option type. Valid only for traffic_generator ixnetwork_540.
<HEX BYTES separated by : or . > This applies to user_defined, user_define types. The value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixnetwork_540.
key:data value:<HEX BYTES separated by : or . > This applies to user_defined, user_define types. The value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixnetwork_540.
Examples:
See files starting with Streams_ in the Samples subdirectory. Also see some of the other sample files in Appendix A, "Example APIs."
Sample Input:
Sample Output:
Notes:
1) Coded versus functional specification.
2) When using traffic_stats -mode stream or -packet_group_id options,
then traffic_control with -action clear_stats or -action sync_run
should be called first.
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'ixnetwork_traffic_control',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ixnetwork_traffic_control.py_part4
|
key:refresh value:<RANGE 0-4294967295> This applies to binding_ack type. The mobile node SHOULD send a new Binding Update at this recommended interval, to refresh the binding. The receiving node (the node which sends the Binding ACK) determines the refresh interval (in seconds). Valid only for traffic_generator ixos.
<IPV6> The IPv6 address for mipv6_alternative_coa_sub type. Valid only for traffic_generator ixos.
key:address value:<IPV6> The IPv6 address for mipv6_alternative_coa_sub type. Valid only for traffic_generator ixos.
<CHOICES skip discard discard_icmp discard_icmp_if_not_multicast>. Behavior if option unrecognized. Valid only for traffic_generator ixnetwork_540.
key:unrecognized_type value:<CHOICES skip discard discard_icmp discard_icmp_if_not_multicast>. Behavior if option unrecognized. Valid only for traffic_generator ixnetwork_540.
<CHOICES 0 1>. Allow packet change. Valid only for traffic_generator ixnetwork_540.
key:allow_packet_change value:<CHOICES 0 1>. Allow packet change. Valid only for traffic_generator ixnetwork_540.
<RANGE 0-31>. User defined option type. Valid only for traffic_generator ixnetwork_540.
key:user_defined_type value:<RANGE 0-31>. User defined option type. Valid only for traffic_generator ixnetwork_540.
<HEX BYTES separated by : or . > This applies to user_defined, user_define types. The value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixnetwork_540.
key:data value:<HEX BYTES separated by : or . > This applies to user_defined, user_define types. The value for the IPv6 Hop by Hop option. Valid only for traffic_generator ixnetwork_540.
Examples:
See files starting with Streams_ in the Samples subdirectory. Also see some of the other sample files in Appendix A, "Example APIs."
Sample Input:
Sample Output:
Notes:
1) Coded versus functional specification.
2) When using traffic_stats -mode stream or -packet_group_id options,
then traffic_control with -action clear_stats or -action sync_run
should be called first.
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'ixnetwork_traffic_control',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/ixnetwork_traffic_control.py_part5
|
# -*- coding: utf-8 -*-
import sys
from ixiaerror import IxiaError
from ixiangpf import IxiaNgpf
from ixiautil import PartialClass, make_hltapi_fail
class IxiaNgpf(PartialClass, IxiaNgpf):
def emulation_dhcp_server_stats(self, action, **kwargs):
r'''
#Procedure Header
Name:
emulation_dhcp_server_stats
Description:
This procedure retrieves DHCP Server statistics for the specified Ixia port.
Synopsis:
emulation_dhcp_server_stats
[-dhcp_handle ANY]
[-handle ANY]
[-port_handle ANY]
[-ip_version CHOICES 4 6
DEFAULT 4]
-action CHOICES clear collect
x [-execution_timeout NUMERIC
x DEFAULT 1800]
Arguments:
-dhcp_handle
DHCP Server range to perform action for. This parameter is supported using
the following APIs: IxTclNetwork. The DHCP Server stats per handle are not supported.
The aggregated ones will be returned instead, for the port_handle on which the DHCP Server handle belongs.
This parameter acts in the same way as handle. It is implemented for backwards compatibility.
-handle
DHCP Server range to perform action for. This parameter is supported using
the following APIs: IxTclNetwork. The DHCP Server stats per handle are not supported.
The aggregated ones will be returned instead, for the port_handle on which the DHCP Server handle belongs.
-port_handle
The port handle to perform action for. This parameter is supported using
the following APIs: IxTclNetwork.
-ip_version
DHCP Server IP type. This parameter is supported using
the following APIs: IxTclNetwork. The DHCP Server stats per handle are not supported.
The aggregated ones will be returned instead, for the port_handle on which the DHCP Server handle belogs.
-action
This is a mandatory argument. Used to select the task to perform.
This parameter is supported using the following APIs: IxTclNetwork.Valid choices are: clear collect.
x -execution_timeout
x This is the timeout for the function.
x The setting is in seconds.
x Setting this setting to 60 it will mean that the command must complete in under 60 seconds.
x If the command will last more than 60 seconds the command will be terminated by force.
x This flag can be used to prevent dead locks occuring in IxNetwork.
Return Values:
$::SUCCESS | $::FAILURE Status of procedure call.
key:status value:$::SUCCESS | $::FAILURE Status of procedure call.
When status is failure, contains more information.
key:log value:When status is failure, contains more information.
Valid for ip_version 4
x key:aggregate.<port_handle>.tx.advertisement value:Valid for ip_version 4
Valid for ip_version 6
x key:aggregate.<port_handle>.rx.confirm value:Valid for ip_version 6
Valid for ip_version 4,6
key:aggregate.<port_handle>.rx.decline value:Valid for ip_version 4,6
Valid for ip_version 4
key:aggregate.<port_handle>.rx.discover value:Valid for ip_version 4
Valid for ip_version 4,6
key:aggregate.<port_handle>.rx.inform value:Valid for ip_version 4,6
n key:aggregate.<port_handle>.rx.offer value:
Valid for ip_version 6
x key:aggregate.<port_handle>.rx.rebind value:Valid for ip_version 6
Valid for ip_version 6
x key:aggregate.<port_handle>.rx.relay_forward value:Valid for ip_version 6
Valid for ip_version 6
x key:aggregate.<port_handle>.rx.relay_reply value:Valid for ip_version 6
Valid for ip_version 6
x key:aggregate.<port_handle>.reconfigure_tx value:Valid for ip_version 6
Valid for ip_version 6
x key:aggregate.<port_handle>.nak_sent value:Valid for ip_version 6
Valid for ip_version 6
x key:aggregate.<port_handle>.solicits_ignored value:Valid for ip_version 6
Valid for ip_version 4,6
key:aggregate.<port_handle>.rx.release value:Valid for ip_version 4,6
Valid for ip_version 6
x key:aggregate.<port_handle>.rx.renew value:Valid for ip_version 6
Valid for ip_version 4,6
key:aggregate.<port_handle>.rx.request value:Valid for ip_version 4,6
Valid for ip_version 6
key:aggregate.<port_handle>.rx.solicit value:Valid for ip_version 6
n key:aggregate.<port_handle>.rx.ack value:
n key:aggregate.<port_handle>.rx.nak value:
n key:aggregate.<port_handle>.rx.force_renew value:
n key:aggregate.<port_handle>.rx.relay_agent value:
n key:aggregate.<port_handle>.tx.discover value:
Valid for ip_version 4
key:aggregate.<port_handle>.tx.offer value:Valid for ip_version 4
n key:aggregate.<port_handle>.tx.request value:
Valid for ip_version 4
x key:aggregate.<port_handle>.tx.reply value:Valid for ip_version 4
n key:aggregate.<port_handle>.tx.decline value:
Valid for ip_version 4
key:aggregate.<port_handle>.tx.ack value:Valid for ip_version 4
Valid for ip_version 4
key:aggregate.<port_handle>.tx.nak value:Valid for ip_version 4
n key:aggregate.<port_handle>.tx.release value:
n key:aggregate.<port_handle>.tx.inform value:
key:aggregate.<port_handle>.tx.force_renew value:
n key:aggregate.<port_handle>.allocated.ip value:
n key:aggregate.<port_handle>.port_name value:
x key:aggregate.<port_handle>.total_leases_allocated value:
x key:aggregate.<port_handle>.total_leases_renewed value:
x key:aggregate.<port_handle>.current_leases_allocated value:
Valid for ip_version 6
x key:aggregate.<port_handle>.total_addresses_allocated value:Valid for ip_version 6
Valid for ip_version 6
x key:aggregate.<port_handle>.total_addresses_renewed value:Valid for ip_version 6
Valid for ip_version 6
x key:aggregate.<port_handle>.current_addresses_allocated value:Valid for ip_version 6
Valid for ip_version 6
x key:aggregate.<port_handle>.total_prefixes_allocated value:Valid for ip_version 6
Valid for ip_version 6
x key:aggregate.<port_handle>.total_prefixes_renewed value:Valid for ip_version 6
Valid for ip_version 6
x key:aggregate.<port_handle>.current_prefixes_allocated value:Valid for ip_version 6
key:<device_group>.aggregate.force_renew_count value:
Valid for ip_version 6
key:<device_group>.aggregate.reconfigure_count value:Valid for ip_version 6
Valid for ip_version 6
key:<device_group>.aggregate.nak_sent value:Valid for ip_version 6
Valid for ip_version 6
key:<device_group>.aggregate.solicits_ignored value:Valid for ip_version 6
n key:dhcp_handle.<dhcp_handle>.rx.discover value:
n key:dhcp_handle.<dhcp_handle>.rx.offer value:
n key:dhcp_handle.<dhcp_handle>.rx.request value:
n key:dhcp_handle.<dhcp_handle>.rx.decline value:
n key:dhcp_handle.<dhcp_handle>.rx.ack value:
n key:dhcp_handle.<dhcp_handle>.rx.nak value:
n key:dhcp_handle.<dhcp_handle>.rx.release value:
n key:dhcp_handle.<dhcp_handle>.rx.inform value:
n key:dhcp_handle.<dhcp_handle>.rx.force_renew value:
n key:dhcp_handle.<dhcp_handle>.rx.relay_agent value:
Valid for ip_version 6
n key:aggregate.<port_handle>.tx.discover value:Valid for ip_version 6
Valid for ip_version 6
n key:aggregate.<port_handle>.tx.offer value:Valid for ip_version 6
n key:dhcp_handle.<dhcp_handle>.tx.request value:
n key:dhcp_handle.<dhcp_handle>.tx.decline value:
n key:dhcp_handle.<dhcp_handle>.tx.ack value:
n key:dhcp_handle.<dhcp_handle>.tx.nak value:
n key:dhcp_handle.<dhcp_handle>.tx.release value:
n key:dhcp_handle.<dhcp_handle>.tx.inform value:
n key:dhcp_handle.<dhcp_handle>.tx.force_renew value:
n key:dhcp_handle.<dhcp_handle>.allocated.ipn value:
Examples:
Sample Input:
Sample Output:
Notes:
1) The not supported parameters or options of the parameters will be
silently ignored.
See Also:
'''
hlpy_args = locals().copy()
hlpy_args.update(kwargs)
del hlpy_args['self']
del hlpy_args['kwargs']
not_implemented_params = []
mandatory_params = []
file_params = []
try:
return self.__execute_command(
'emulation_dhcp_server_stats',
not_implemented_params, mandatory_params, file_params,
hlpy_args
)
except (IxiaError, ):
e = sys.exc_info()[1]
return make_hltapi_fail(e.message)
|
KeysightData/IxNetworkAPI9.30.2212.7PI/ixia/hlapi/9.30.2212.6/library/common/ixiangpf/python/ixiangpf_commands/emulation_dhcp_server_stats.py_part1
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.