nisystemlink.clients.systems

pydantic model nisystemlink.clients.systems.models.CreateVirtualSystemRequest[source]

Model for create virtual system response containing the minion ID of the system which is created.

Show JSON schema

{
   "title": "CreateVirtualSystemRequest",
   "description": "Model for create virtual system response containing the minion ID of the system which is created.",
   "type": "object",
   "properties": {
      "alias": {
         "title": "Alias",
         "type": "string"
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      }
   },
   "required": [
      "alias",
      "workspace"
   ]
}

Fields

alias
workspace

field alias: str [Required]: Alias of the virtual system.

field workspace: str [Required]: Workspace to create the virtual system in.

pydantic model nisystemlink.clients.systems.models.CreateVirtualSystemResponse[source]

Model for create virtual system response containing the minion ID of the system which is created.

Show JSON schema

{
   "title": "CreateVirtualSystemResponse",
   "description": "Model for create virtual system response containing the minion ID of the system which is created.",
   "type": "object",
   "properties": {
      "minionId": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Minionid"
      }
   }
}

Fields

minionId

field minionId: Optional[str] = None: The minion ID of the created virtual system.

pydantic model nisystemlink.clients.systems.models.QuerySystemsRequest[source]

Model for query systems request.

Show JSON schema

{
   "title": "QuerySystemsRequest",
   "description": "Model for query systems request.",
   "type": "object",
   "properties": {
      "skip": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Skip"
      },
      "take": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Take"
      },
      "filter": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Filter"
      },
      "projection": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Projection"
      },
      "orderBy": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Orderby"
      }
   }
}

Fields

filter
order_by
projection
skip
take

field filter: Optional[str] = None

The systems query filter is dynamic LINQ format.

id : String representing the ID of the system. createdTimestamp: ISO-8601 formatted timestamp string specifying the date when the system was registered. lastUpdatedTimestamp: ISO-8601 formatted timestamp string specifying the last date the system was updated. alias: String representing the alias of the system. activation.lastUpdatedTimestamp: ISO-8601 formatted timestamp string specifying the last date the system activation was updated. activation.data.activated: Boolean representing whether the system is activated or not. activation.data.licenseName: String representing the name of the license. activation.data.licenseVersion: String representing the license version. connected.lastUpdatedTimestamp: ISO-8601 formatted timestamp string specifying the last date the system connection was updated. connected.data.state: String representing the state of the system. grains.lastUpdatedTimestamp: ISO-8601 formatted timestamp string specifying the last date the system grains were updated. grains.data: Dictionary of string to object representing general information about the system. Example: grains.data.os == “Windows” packages.lastUpdatedTimestamp: ISO-8601 formatted timestamp string specifying the last date the system installed packages were updated. packages.data: Dictionary representing software packages installed on the system. Example: packages.data.ni-package-manager-upgrader.version: String representing the installed version of ni-package-manager-upgrader package. feeds.lastUpdatedTimestamp: ISO-8601 formatted timestamp string specifying the last date the system configured feeds were updated. feeds.data: Dictionary representing the feeds configured on the system. keywords.lastUpdatedTimestamp: ISO-8601 formatted timestamp string specifying the last date the system keywords were updated. keywords.data: Array of strings representing the keywords of the system. Example: keywords.data.Contains(“test”) properties.lastUpdatedTimestamp: ISO-8601 formatted timestamp string specifying the last date the system properties were updated. properties.data: Dictionary of string to string representing metadata information about a system. Example: properties.data.owner == “admin” status.data.http_connected: Boolean representing the status of the http connection to the master.

See [Dynamic Linq](https://github.com/ni/systemlink-OpenAPI-documents/wiki/Dynamic-Linq-Query-Language) documentation for more details.

“@0”, “@1” etc. can be used in conjunction with the substitutions parameter to keep this query string more simple and reusable.

field order_by: Optional[str] = None: Gets or sets the order in which data returns.

field projection: Optional[str] = None: Gets or sets specifies the projection for resources. Use this field to receive specific properties of the model.

field skip: Optional[int] = None: Gets or sets the number of systems to skip.

field take: Optional[int] = None: Gets or sets number of systems to return maximum value is 1000.

pydantic model nisystemlink.clients.systems.models.QuerySystemsResponse[source]

Model for query systems request.

Show JSON schema

{
   "title": "QuerySystemsResponse",
   "description": "Model for query systems request.",
   "type": "object",
   "properties": {
      "count": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Count"
      },
      "data": {
         "anyOf": [
            {
               "items": {
                  "additionalProperties": true,
                  "type": "object"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data"
      }
   }
}

Fields

count
data

field count: Optional[int] = None: Number of systems match the query.

field data: Optional[List[Dict[str, Any]]] = None: Contains info of the queried systems.

pydantic model nisystemlink.clients.systems.models.RemoveSystemsResponse[source]

Model for remove systems response containing the IDs of the systems which were deleted.

Show JSON schema

{
   "title": "RemoveSystemsResponse",
   "description": "Model for remove systems response containing the IDs of the systems which were deleted.",
   "type": "object",
   "properties": {
      "jid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Jid"
      },
      "removedIds": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Removedids"
      },
      "failedIds": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Failedids"
      }
   }
}

Fields

failed_ids
jid
removed_ids

field failed_ids: Optional[List[str]] = None: The IDs of the systems that could not be removed.

field jid: Optional[str] = None: The job ID of the remove systems operation.

field removed_ids: Optional[List[str]] = None: The IDs of the systems that were successfully removed.