Table Of Contents

1  Preface

1.1  Legal Statements

1.2  Additional Resources

1.2.1  WEB Sites

1.2.2  Mailing Lists

1.3  Conventions Used in this Document

2  ypclient-pro User Guide

2.1  Introduction

2.1.1  Features

2.1.2  Files Required to Build Applications

2.1.3  Example Code Preparation

2.1.4  Example Code: Minimal Example - sget-system.cpp

2.1.5  Example Code: Minimal Example using TLS - sget-system-tls.cpp

2.1.6  Example Code: Toaster Application - toaster.cpp

2.1.7  NotificationStack class to receive session notifications

2.1.8  Convenience function: sendCommand

2.1.9  Convenience function: fetchPassword

2.1.10  Useful Server Information and Configuration

3  Factory classes: Session, Device, and User

3.1.1  Session Factories

3.1.2  Device Factories

3.1.3  User Factory

4  ypclient-pro C++ Header Files

4.1  /usr/include/yumapro/mgr

4.1.1  api-devices.hpp

4.1.2  api-exceptions.hpp

4.1.3  api-filesystem.hpp

4.1.4  api-session.hpp

4.1.5  api-token.hpp

4.1.6  api-users.hpp

4.1.7  api-xstring.hpp

4.2  /usr/include/yumapro/ycli

4.2.1  api-grouping.hpp

4.2.2  api-library.hpp

4.2.3  api-module.hpp

4.2.4  api-object.hpp

4.2.5  api-typedef.hpp

4.2.6  api-yangapi.hpp

5  ypclient-pro C Header Files

5.1  /usr/include/yumapro/mgr

5.1.1  c-api-devices.h

5.1.2  c-api-session.h

5.1.3  c-api-users.h

5.2  /usr/include/yumapro/ycli

5.2.1  c-api-error.h

5.2.2  c-api-grouping.h

5.2.3  c-api-library.h

5.2.4  c-api-module.h

5.2.5  c-api-object.h

5.2.6  c-api-typedef.h

5.2.7  c-api-yangapi.h