# generator-citrix-netscaler > .NET Core sample projects that interacts with the Citrix Netscaler appliance via the Citrix NITRO APIs. This can use the Netscaler CPX docker container. Latest version **1.3.0** (published 2017-05-16) · unlicense license · 0 weekly downloads ## Install ```sh npm install generator-citrix-netscaler pnpm add generator-citrix-netscaler yarn add generator-citrix-netscaler bun add generator-citrix-netscaler ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.3.0 | | Published | 2017-05-16 | | First published | 2017-01-05 | | Weekly downloads | 0 | | License | unlicense | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 3 | | Known vulnerabilities | 0 | | Install scripts | no | | Author | John McBride | | Maintainers | citrixdeveloper | | Keywords | Citrix, Netscaler, Docker, yeoman-generator, asp.net | ## Links - npm: https://www.npmjs.com/package/generator-citrix-netscaler - Repository: https://github.com/citrix/generator-citrix-netscaler - Homepage: http://developer.citrix.com - Issues: https://github.com/citrix/generator-citrix-netscaler/issues - npm.io page: https://npm.io/package/generator-citrix-netscaler ## Dependencies (3) - [chalk](https://npm.io/package/chalk.md) ^1.0.0 - [yosay](https://npm.io/package/yosay.md) ^1.0.0 - [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^0.23.0 ## Recent versions - 1.3.0 (latest) — 2017-05-16 - 1.2.0 — 2017-05-12 - 1.1.0 — 2017-05-11 - 1.0.0 — 2017-05-10 - 0.3.0 — 2017-01-11 - 0.2.0 — 2017-01-06 - 0.1.0 — 2017-01-05 ## README # generator-citrix-netscaler [![NPM version][npm-image]][npm-url] > A Yeoman generator that scaffolds a .NET Core sample project that show how to interact with the Citrix Netscaler CPX docker container via the NITRO REST API. It will also ask if you would to enable Netscaler CPX support and then download, configure and run the netscaler CPX express container. ## Required Software This generator works with the Citrix Netscaler product but the quickest way to get started with Citrix Netscaler is to download the **free** Netscaler CPX Express docker image from [here](http://www.microloadbalancer.com). This generator builds a .NET Core application, so you will also need the .NET Core SDK and runtime from Microsoft. You can find the the .NET Core download [here](https://www.microsoft.com/net/download/core) for the different platforms. While not required for these samples, it is always good to have a source code editor.[Visual Studio Code](https://code.visualstudio.com/) is a good one since it knows how to handle .NET core projects but feel free to an editor that makes you happy. [Sublime Text](https://www.sublimetext.com/) or [Brackets](http://brackets.io/) are also good editors. ### Getting started with Netscaler CPX and Docker videos
## Installation First, install [Yeoman](http://yeoman.io) and generator-citrix-netscaler using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)). ```bash sudo npm install -g yo sudo npm install -g generator-citrix-netscaler ``` Then generate your new project: ```bash yo citrix-netscaler ``` This will prompt you for you Netscaler information and generate a starter project that shows how to authenticate to the Citrix Netscaler CPX container ## Sub-Generators There are also several sub generators that will add additional functionality to the sample app based on what NITRO API you would like to interact with. * [citrix-netscaler:features](#features) * [citrix-netscaler:ip](#ip) * [citrix-netscaler:hostname](#hostname) * [citrix-netscaler:listvservers](#listvservers) * [citrix-netscaler:cpxsupport](#cpxsupport) ### Features Generates a partial class that contains the API calls to list features on the Netscaler CPX container. Example: ```bash yo citrix-netscaler:features ``` Produces NSListFeatures.cs in the project directory. In order to use the new methods you should add the following method call to your main calling method. ```csharp await ListFeatures(); ``` ### IP Generates a partial class that contains the API calls to list IP addresses used on the Netscaler CPX container. Example: ```bash yo citrix-netscaler:ip ``` Produces NSIP.cs in the project directory. In order to use the new methods you should add the following method call to your main calling method. ```csharp await Listips(); ``` ### HOSTNAME Generates a partial class that contains the API calls to get and set the hostname of the Netscaler CPX. ### CPXSUPPORT #### Summary the CPXSUPPORT sub-generator will enable the Citrix Netscaler CPX Express container in the current project. This will pull the docker container from the docker store and start it up automatically. A requirement for this is to have docker installed on the device where you creating your project. Example: ```bash yo citrix-netscaler:cpxsupport $ Would you like to add Netscaler CPX to y (Y/n) $ Please enter the local HTTP port to map to the http port in the docker container (32777) $ Please enter the local HTTPS port to map to the https port in the docker container (32778) $ Please enter the local SSH port to map to the SSH port in the docker container (32779) $ Please enter the local SNMP port to map to the SNMP port in the docker container (32780) ``` Example: ```bash yo citrix-netscaler:hostname ``` Produces NSHostname.cs in the project directory. In order to use the new methods you should add the following method call to your main calling method. ```csharp //List hostname await ListHostname(); //set the hostname await SetHostname("MyNewHostname"); ``` ### listvservers Generates a partial class that contains the API calls to list all of the VServers configured on the the Netscaler CPX. Example: ```bash yo citrix-netscaler:listvservers ``` Produces NSListServers.cs in the project directory. In order to use the new methods you should add the following method call to your main calling method. ```csharp await ListVirtualServers(); ``` ## Contribution We love open source and contributors! Get started by cloning This repo and start building additional features. Whether it source code, documentation, issue or wiki entries. We love any kinda of contribution! > *At Citrix, we’re committed to building a world-class ecosystem through open platforms. Our offerings power mission-critical business operations for users, IT and partners, and we provide a number of APIs, SDKs and tools to help you extend and integrate with our services. We’re excited to work with you to make Citrix your platform of choice.* [npm-image]: https://badge.fury.io/js/generator-citrix-netscaler.svg [npm-url]: https://npmjs.org/package/generator-citrix-netscaler --- _Source: https://npm.io/package/generator-citrix-netscaler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._