Welcome to SysOpsWork’s documentation!

SysOpsWork is an Automation program for Windows, macOS, and Ubuntu Linux. The name SysOpsWork is derived from the implementation work done by SysOps team (also known as infrastructure administrators).

It automates implementation of native configuration lines and RESTful calls to IT infrastructure components, such as: Compute, Network, Security, Storage, whether On Prem or On Cloud, in a physical, virtualized, or containerized space. But not limited to that.

SysOpsWork has the objective to make IT infrastructure automation simple.

This documentation presents all capabilities of sysopswork CLI program at its current version: 0.1.1

SysOpsWork is free to download and use, but not to commercialize. sysopswork CLI program is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. More information can be found at https://creativecommons.org/licenses/by-nc-nd/4.0/

Contents

• Installation
  • Microsoft Windows Installation
  • Apple macOS Installation
  • Linux Installation
• First Automation
  • Preparation
  • Running the First Automation
  • Post Automation
• Objects
  • Name and Technology
  • Address
  • Access Method
    • SSH
    • PowerShell Remoting
  • Login Mode
    • SSH Login Modes
    • PowerShell Remoting Login Modes
  • Object Prompt (Optional)
  • Network Port (Optional)
  • Registering An Object
    • Command Line Registration
    • Registering with Script Instruction ADDOBJ:
    • Registration by Adjusting objects.csv File
    • Updating or Deleting an Object Registration
  • Master Key & Credentials
    • Creating Master Key
    • Changing Master Key
    • Persisting Credentials
    • Updating Credentials
  • Testing Connectivity
• Cloud Providers
  • Amazon Web Services
  • Microsoft Azure
  • Google Cloud Platform
  • Other Cloud Providers
• Automation Script
  • Basic Scripts
  • REST(ful) Automation
  • Elaborated Scripts
    • Pre-Implementation Test Instructions
    • Implementation Instructions
    • Post-Implementation Test Instructions
    • Back-Out Instructions
    • Final-Test Instructions
    • REST Implementation Life Cycle Instructions
  • Additional Instructions
    • OBJECT:
    • ADDOBJ:
    • TEXT
    • QUESTION: & ANSWER:
    • PROMPT:
    • # COMMENT
    • EXIT:
    • WAIT:
    • PRINT:
• Implementation Life Cycle
  • ILC Script
  • Analyzing Results
    • WORD
    • REGULAR EXPRESSION (REGEX)
    • PRECISION-SYNTAX
  • Implementation Failure
  • Forcing Back-Out
  • Checking Logs
• Variables
  • Static Variables
  • Reference Number
  • Dynamic Variables
• Control Flow
  • Conditional
  • Loop
  • Altering Loop Behavior
• Troubleshooting
  • sysopswork automation stops or freezes when connecting to an object
  • sysopswork automation pauses before completing all the steps
  • SSH key exchange algorithm mismatch
  • JSON or XML not extracted from native commands
  • Error Codes
• Environment Variables
  • Master Key
  • Amazon Web Services
  • Microsoft Azure
  • Google Cloud Platform
  • Objects
• Command Reference
  • Master Key Commands
    • Master Key Creation
    • Master Key Change
  • Object Commands
    • Registering an Object
    • Persisting Credentials of an Object
  • Implementation Commands
    • Running an Implementation Script
    • Running Back-out Instructions
  • Additional Commands
    • Checking sysopswork Version
• Instruction Reference
  • Comments
  • CLI Automation Instructions
    • Pre-Implementation Test Instructions
    • Implementation Instructions
    • Post-Implementation Test Instructions
    • Back-out Instructions
    • Final-Test Instructions
  • REST Automation Instructions
    • Implementation Life Cycle Step
    • HTTP Method
    • HTTP URL
    • HTTP Headers
    • HTTP Request Enclosed-Body Data Single-Line
    • HTTP Request Enclosed-Body Data Multi-Line
    • HTTP Response Enclosed-Body Data Verification
    • HTTP Response Header Verification
  • Additional Instructions
    • ADDOBJ:
    • TEXT
    • QUESTION: & ANSWER:
    • PROMPT:
    • # COMMENT
    • EXIT:
    • WAIT:
    • PRINT:
  • Variables
    • Static String
    • Static List
    • Dynamic Variable
  • Control Flow
    • Conditional Iteration
    • While Loop
    • For Each Loop
    • Altering Loop Flow