HP UX IPQos Software manual Return Codes

Page 19

Overview

HP-UX IPQoS API Overview

IpqosAPI (3c): Provides an overview of the HP-UX IPQoS API. It describes the types of tasks programmers can perform with the API. It explains how sessions are used and introduces the HP-UX IPQoS API object classes (IpqosFilter, IpqosPolicy,

IpqosAdapter).

IpqosSession (3c): Provides information on functions related to HP-UX IPQoS session

management. This includes details on: initiating sessions, committing sessions and aborting sessions. It also discusses the three session types available.

IpqosAdapter (3c): Provides information on functions related to HP-UX IPQOS adapters,

including: obtaining information about adapters, traversing the list of HP-UX IPQoS adapters, and traversing the list of policies associated with adapters. It also includes relevant session-related information.

IpqosPolicy (3c): Provides information on functions related to HP-UX IPQoS policies,

including: creating policies, assigning and accessing values of policy attributes, associating policies with adapters, and traversing the filter lists of the polices. It also includes relevant session-related information.

IpqosFilter (3c): Provides information on functions related to HP-UX IPQoS filters,

including: creating filters, assigning and accessing values of filter attributes, and associating filters with policies. It also includes relevant session-related information.

IpqosOverlapFilter (3c): Provides information on functions related to checking HP-UX IPQoS filters for overlap conditions.

IpqosStats (3c): Provides information on functions related to obtaining (and resetting) statistics on the filters and policies of the HP-UX IPQoS configuration.

Return Codes

Most functions in the HP-UX IPQoS API return a uint32_t value that represents the return code of the function call. When successful, the return code will be the symbolic constant

IPQOS_S_SUCCESS.

In some cases, other values will be returned, which may or may not indicate a failure. For example, the list traversal routines may return the value IPQOS_S_LIST_EMPTY. You may receive this value if you are trying to set the traversal to the head of the list, and the list is empty. Or, you may receive this value if you are trying to traverse to the next item in the list and there are no more items in the list.

In general, for “get” functions: A return of IPQOS_E_ATTRIBUTE_NOT_SET signifies that the attribute is not set for the object. A return of IPQOS_S_SUCCESS signifies the attribute is set. Any other return code is an error.

In general, for “set” functions: A return of any value other than IPQOS_S_SUCCESS signifies an error.

Chapter 1

19

Image 19
Contents Manufacturing Part Number October HP-UX IPQoS A.01.00 Programmer’s GuideTrademark Notices WarrantyGovernment License Copyright NoticeContents Return Codes New and Changed Documentation in This Edition Intended AudiencePublishing History What Is in This DocumentTypographic Conventions HP-UX Release Name and Release Identifier Related DocumentsBold Related RFCs HP Product DocumentationManpages RFCs Description Relevant RFCsHP Welcomes Your Comments Overview Introduction to HP-UX IPQoS Background Information IntroductionArchitectural Overview HP-UX IPQoS ArchitectureIntroducing the HP-UX IPQoS API Introduction HP-UX IPQoS API Overview Structural Overview How to Use the HP-UX IPQoS APIProgrammatic Requirements HP-UX IPQoS API Overview Manpages Return Codes Sample Program Restoring Configurations to the Kernel after RebootUsing the HP-UX IPQoS API Starting a Session Using SessionsSession Types Object Status Terminating a SessionUsing Sessions Creating, Copying and Destroying Objects Using ObjectsObject Attributes Lists Using ListsTraversing Lists Attaching Objects to ListsRestrictions Do something with the policy list here Code Example Traversing An Adapter ListDeleting Policies and Filters Detaching From a List Object Type Attributes Filter ObjectsFilter Overlap Attributes Associated with Filter ObjectsFilter Objects Attributes Associated with Policy Objects Policy ObjectsAttributes Associated with Adapter Objects Adapter ObjectsCounters Kept for Statistics StatisticsObject Type Counters Troubleshooting General Tips Reporting Problems to HP Reporting Problems to HP Chapter Function Calls Table A-1 Session-Related Functions Description Session-Related Function CallsTable A-2 Adapter-Related Functions Description Adapter-Related Function CallsTable A-3 Policy-Related Functions Description Policy-Related Function CallsSet Vlan priority Table A-4 Filter-Related Functions Description Filter-Related Function CallsGet priority of filter Table A-5 Filter Overlap-Related Functions Description Filter Overlap-Related Function CallsFilter2 Filter1 overlaps thatTable A-6 Statistics-Related Functions Description Statistics-Related Function CallsReturn Codes Table B-1 Return Codes with Mnemonics and Message Strings Return Codes, Mnemonics and Message StringsObject name is not set Return Codes, Mnemonics and Message Strings Appendix B Code Example Exit Else Return Main Configuration Code ExampleIpqosvaluemoderelative Configuration Code Example Appendix C Index Index Index
Related manuals
Manual 7 pages 919 b Manual 135 pages 55.88 Kb

UX IPQos Software specifications

HP-UX IPQoS is a sophisticated software solution designed to enhance the network performance of HP's Unix-based operating system, HP-UX. This software focuses on Quality of Service (QoS) mechanisms that ensure efficient bandwidth utilization and prioritize network traffic to meet the demands of various applications.

One of the main features of HP-UX IPQoS is its ability to define traffic priorities. Administrators can classify traffic into different priority levels, allowing critical applications to receive the bandwidth they need while less important traffic can be deprioritized. This feature is essential in environments where bandwidth is a limited resource, ensuring that business-critical processes maintain their performance even during peak usage times.

The software employs advanced traffic shaping techniques that allow the management of data flow in the network. By controlling the rate of traffic and smoothing out bursts, IPQoS helps prevent network congestion, leading to a consistently reliable user experience. In addition, it can manage both inbound and outbound traffic, ensuring optimal performance in various network scenarios.

Another significant characteristic of HP-UX IPQoS is its integration with other network management tools. It operates seamlessly with HP’s Network Management Suite, providing a holistic view of network performance. This integration facilitates easier troubleshooting and monitoring, as administrators can correlate data from different sources for comprehensive insights.

Moreover, HP-UX IPQoS supports various protocols, including DiffServ and MPLS. By adhering to these standards, it positions itself as a versatile tool that can operate in diverse network environments, providing flexibility and ease of deployment. Additionally, the software supports policy-based management, enabling organizations to implement specific rules tailored to their network requirements.

Security is also a critical focus of HP-UX IPQoS. The software provides mechanisms to enforce traffic policies while safeguarding against potential threats. By ensuring that only authorized traffic flows through the network, it minimizes the risk of attacks and data breaches, contributing to a more secure IT environment.

The user interface of HP-UX IPQoS is designed for ease of use, allowing network administrators to configure settings, monitor performance, and generate reports without extensive training. This user-friendliness accelerates the deployment process and enhances the overall management of network resources.

In summary, HP-UX IPQoS is a robust and versatile network management solution that brings substantial benefits to organizations looking to optimize their network performance. With its traffic prioritization features, integration capabilities, support for industry standards, and focus on security, it stands out as an essential tool for maintaining effective and secure network operations in a dynamically changing IT landscape.