This is the README for the F5 Application Services Templates(FAST), "vscode-f5-fast".
This extension is intented to help interface with the FAST service to manage templates and deploy applications.
While the ultimate goal of this tool is integrate with FAST and assist in template authoring, deployment and testing, it also integrates with other F5 ILX extensibility like AS3/DO/TS.
This extension typically works with any F5 product running tmos and/or any of the primary ILX extensions(AS3/DO/TS), including BIG-IQ.
https://marketplace.visualstudio.com/items?itemName=DumpySquare.vscode-f5-fast
*** please see release tab to download the latest release for other install methods ***
Future extension features and enhancements have been moved to the repo issues(enhancements) for better tracking
Extension commands are access through the command palette by pressing F1 or cntrl+shift+p
This extension provides the following commands and are active on workspace load (if extension is installed and enabled).
-
F5: Connect to Device: Used to select a device from list to connect to -
F5: Disconnect: Disconnect from current device -
F5: Disconnect and Clear All Passwords: Disconnect from current device and clear ALL cached passwords -
F5: Show Device Info: Displays json output of F5 Host information, including platform/licensing/software/macAddresses/vlans -
F5: Add Host: Prompts to add a new host to the configured list -
F5: Remote Command Execute: Prompts for command to execute on device via BASH API (account must have advanced shell enabled) -
F5: Settings: Opens VS Code settings window focused on F5-Fast settings (currently only device list) -
F5-Fast: Show Info: Displays json output of F5-Fast service info -
F5-AS3: Post Declaration: Post entire active editor contents as AS3 declaration to selected device (can also select/highlight text) -
F5-DO: Inspect: Displays json output of the DO 'inspect' endpoint -
F5-DO: Get Current Declaration: Displays json output of the current declaration, if there is one -
F5-DO: Get Tasks: Displays json output of the task history -
F5-DO: Post Declaration: Post entire active editor contents as DO declaration to selected device (can also select/highlight text to be sent) -
F5-TS: Show Info: Displays json output of TS service info -
F5-TS: Get Current Declaration: Displays json output of the current declaration, if there is one -
F5-TS: Post Declaration: Post entire active editor contents as TS declaration to selected device (can also select/highlight text to be send) -
ChuckJoke: When you need some inspiration...
-
To add a device
- Add under the vscode extension settings
- Press
F1, typef5, select "F5: Settings", click add item button -- or --
- Press
- Add device from the F5 HOSTS view
- Click
F5: Add HOSTbutton in top right of the extension view for "F5 HOSTS"
- Click
- Add under the vscode extension settings
-
To Modify a device:
- Modify under the vscode extension settings
- Press
F1, typef5, select "F5: Settings", click pencil icon next to item to modify -- or --
- Press
- Modify device from the F5 HOSTS view
- Click the pencil icon on the right of the host entry in the "F5 HOSTS" view
- Modify under the vscode extension settings
-
To Delete a device:
- Delete under the vscode extension settings
- Press
F1, typef5, select "F5: Settings", click "X" icon next to item to delete -- or --
- Press
- Delete device from the F5 HOSTS view
- 'Right-Click`, select "DELETE" from the menu that appears next to the host entry in the "F5 HOSTS" view
- Delete under the vscode extension settings
Connect means to select a device to work with. When connected, commands/api calls will be executed on that device.
Passwords are cached automatically. They can be cleared with the "F5: Disconnect and Clear ALL Passwords"
No need to disconnect when switching devices
If authentication to a device ever failes (401 response), password cache for that device will be cleared and prompt for a new one
*** passwords are cached using system encryption with KeyTar ***
-
To connect to a device:
- Select the device in the 'F5 Hosts' view on the left
- -- or --
- Press
F1, typef5, select "F5: Connect to Device", select device from prompt
- Select the device in the 'F5 Hosts' view on the left
-
To Disconnect from a device:
- Click on the user@device object in the status bar at the bottom
- -- or --
- Press
F1, typef5, select "F5: Disconnect from Device"
- Click on the user@device object in the status bar at the bottom
Once a device is connected, and the extension detects that AS3 is installed, a status bar will show up on the bottom indicating the running AS3 service verson.
The AS3 Tenant TreeView on the left shows AS3 tenants and apps for each tenant. Select a tenant to see all the app configuration details for that tenant. You cannot select individual apps from the tree, they are just there for visibility
The AS3 Tasks TreeVew on the left is just to provide some visibility into the tasks/jobs that the AS3 service has run.
To post an AS3 declaration, select the command from the palette by pressing F1. You may need to search for 'as3' or 'f5'.
Select the declaration text to send or it will capture the entire editor window
To delete a tenant, right click the tenant in the AS3 Tenant TreeView on the left and select "Delete"
If the extension detects the DO is running, a status bar will show up on the bottom showing the running service software version
Select the status bar item to see the current DO declaration
Select the command from the palette drop down to post a declaration
If the extension detects the TS is running, a status bar will show up on the bottom showing the running service software version
Select the status bar item to see the current TS declaration
Select the command from the palette drop down to post a declaration
Command to issue on the remote device. Good for quickly getting information while building declarations!
This extension contributes the following settings:
f5.hosts: a list of f5 devices to connect to
HTTP/422 responses - Can happen for a handful of reasons:
- Getting DO declaration when device has settings DO can configure but device was not deployed with DO (it can't manage the settings that are already there)
- Improperly formatted/wrong declaration
- Sometimes this is from the '$schema' reference in the declaration
- Sometimes you can fix a DO HTTP/400 response by overwriting with a clean/updated declaration
You cannot select a tenant application in the tree view. It is only for visibility. Select the tenant for configuration
VScode has a built in debugger very much like Chrome. This can be used to gain insight to what is happening when things don't respond as expected.
If you are having issues, it may be best to start here and capture the output as described below:
- In the main VSCode window, along the top, select Help, then Toggle Developer Tools, select the Console tab.
- Then, explore the requests and responses to see if there are any areas of concern
- Expand some of the objects by clicking the little triangle next to the obejct under a request or response to inspect
- Then, explore the requests and responses to see if there are any areas of concern
If needed, right-click on an entry, then select save-as to save the log including expanded objects to a file. This can be used for troubleshooting
The recommended way to get this extension is to install from the Microsoft VScode extension marketplace or from within VSCode directly, under the extensions activity bar view on the left.
If you still need to install from vsix, they can be downloaded under the 'release' tab above: https://github.com/DumpySquare/vscode-f5-fast/releases
Different ways to install vsix:
- https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix
- https://github.com/eamodio/vscode-gitlens/wiki/Installing-Prereleases-(vsix)
- Clone and install dependencies:
git clone https://github.com/DumpySquare/vscode-f5-fast.git cd cd vscode-f5-fast/ npm install code .
- Start Debugging environment: Keystroke
F5 - Navigate to view container by clicking on the f5 icon in the Activity bar (typically on the left)
- Update device list in tree view on the left with a device in your environment
- ADD in the F5 Hosts view
- or
clickthe pencil icon on an item and modify the item
- Connect to device
- (
clickdevice in host tree orCntrl+shift+PorF1)
- (