okclient - the PowerShell module for the Landscape omnikeeper REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This PowerShell module is automatically generated by the OpenAPI Generator project:

• API version: v1
• SDK version: 30.5.4
• Generator version: 7.7.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PowerShellClientCodegen

Frameworks supported

• PowerShell 6.2 or later

Dependencies

Installation

To install from the source, run the following command to build and install the PowerShell module locally:

Build.ps1
Import-Module -Name '.\src\okclient' -Verbose

To avoid function name collision, one can use -Prefix, e.g. Import-Module -Name '.\src\okclient' -Prefix prefix

To uninstall the module, simply run:

Remove-Module -FullyQualifiedName @{ModuleName = "okclient"; ModuleVersion = "30.5.4"}

Tests

To install and run Pester, please execute the following commands in the terminal:

Install-module -name Pester -force

Invoke-Pester

For troubleshooting, please run $DebugPreference = 'Continue' to turn on debugging and disable it with $DebugPreference = 'SilentlyContinue' when done with the troubleshooting.

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
OKAnsibleInventoryScanIngestApi	Invoke-OKAnsibleInventoryScanIngestIngestAnsibleInventoryScan	POST /api/v{version}/Ingest/AnsibleInventoryScan
OKAttributeValueImageApi	Invoke-OKAttributeValueImageGet	GET /api/v{version}/AttributeValueImage
OKAttributeValueImageApi	Invoke-OKAttributeValueImagePost	POST /api/v{version}/AttributeValueImage
OKAuthRedirectApi	Invoke-OKAuthRedirectIndex	GET /.well-known/openid-configuration
OKCytoscapeApi	Invoke-OKCytoscapeTraitCentric	GET /api/v{version}/Cytoscape/traitCentric
OKGraphQLApi	Invoke-OKGraphQLDebug	POST /graphql-debug
OKGraphQLApi	Invoke-OKGraphQLGet	GET /graphql
OKGraphQLApi	Invoke-OKGraphQLIndex	POST /graphql
OKGraphvizDotApi	Invoke-OKGraphvizDotLayerCentric	GET /api/v{version}/GraphvizDot/layerCentric
OKGraphvizDotApi	Invoke-OKGraphvizDotTraitCentric	GET /api/v{version}/GraphvizDot/traitCentric
OKGridViewApi	Invoke-OKGridViewAddContext	POST /api/v{version}/GridView/context	Adds new context
OKGridViewApi	Invoke-OKGridViewChangeData	POST /api/v{version}/GridView/contexts/{context}/change	Saves grid view row changes and returns change results
OKGridViewApi	Invoke-OKGridViewDeleteContext	DELETE /api/v{version}/GridView/context/{name}	Deletes specific context
OKGridViewApi	Invoke-OKGridViewEditContext	PUT /api/v{version}/GridView/context/{name}	Edits specific context
OKGridViewApi	Invoke-OKGridViewGetData	GET /api/v{version}/GridView/contexts/{context}/data	Returns grid view data for specific context
OKGridViewApi	Invoke-OKGridViewGetGridViewContext	GET /api/v{version}/GridView/context/{name}	Returns a single context in full
OKGridViewApi	Invoke-OKGridViewGetGridViewContexts	GET /api/v{version}/GridView/contexts	Returns a list of contexts for grid view.
OKGridViewApi	Invoke-OKGridViewGetSchema	GET /api/v{version}/GridView/contexts/{context}/schema	Returns grid view schema for specific context
OKImportExportLayerApi	Import-OKExportLayerExportLayer	GET /api/v{version}/ImportExportLayer/exportLayer
OKImportExportLayerApi	Import-OKExportLayerImportLayer	POST /api/v{version}/ImportExportLayer/importLayer
OKMetadataApi	Invoke-OKMetadataGetMetadata	GET /api/odata/{context}/$metadata
OKMetadataApi	Invoke-OKMetadataGetServiceDocument	GET /api/odata/{context}
OKOKPluginGenericJSONIngestApi	Invoke-OKManageContextGetAllContexts	GET /api/v{version}/ingest/genericJSON/manage/context
OKOKPluginGenericJSONIngestApi	Invoke-OKManageContextGetContext	GET /api/v{version}/ingest/genericJSON/manage/context/{id}
OKOKPluginGenericJSONIngestApi	Invoke-OKManageContextRemoveContext	DELETE /api/v{version}/ingest/genericJSON/manage/context/{id}
OKOKPluginGenericJSONIngestApi	Invoke-OKManageContextUpsertContext	POST /api/v{version}/ingest/genericJSON/manage/context
OKOKPluginGenericJSONIngestApi	Invoke-OKPassiveDataIngest	POST /api/v{version}/ingest/genericJSON/data
OKOKPluginGenericJSONIngestApi	Invoke-OKPassiveFilesIngest	POST /api/v{version}/ingest/genericJSON/files
OKOKPluginInsightDiscoveryIngestApi	ConvertTo-OKgestFileIngest	POST /api/v{version}/ingest/insight-discovery/file
OKRestartApplicationApi	Restart-OKApplicationRestart	GET /api/v{version}/RestartApplication/restart
OKUsageStatsApi	Invoke-OKUsageStatsFetch	GET /api/v{version}/UsageStats/fetch

Documentation for Models

• okclient\Model.AbstractInboundIDMethod
• okclient\Model.AddContextRequest
• okclient\Model.AnsibleInventoryScanDTO
• okclient\Model.AttributeValueDTO
• okclient\Model.AttributeValueType
• okclient\Model.ChangeDataCell
• okclient\Model.ChangeDataRequest
• okclient\Model.EditContextRequest
• okclient\Model.EdmContainerElementKind
• okclient\Model.EdmExpressionKind
• okclient\Model.EdmSchemaElementKind
• okclient\Model.EdmTypeKind
• okclient\Model.GenericInboundAttribute
• okclient\Model.GenericInboundCI
• okclient\Model.GenericInboundCIIdMethod
• okclient\Model.GenericInboundData
• okclient\Model.GenericInboundRelation
• okclient\Model.GraphQLQuery
• okclient\Model.GridViewColumn
• okclient\Model.GridViewConfiguration
• okclient\Model.IEdmEntityContainer
• okclient\Model.IEdmEntityContainerElement
• okclient\Model.IEdmExpression
• okclient\Model.IEdmModel
• okclient\Model.IEdmSchemaElement
• okclient\Model.IEdmTerm
• okclient\Model.IEdmType
• okclient\Model.IEdmTypeReference
• okclient\Model.IEdmVocabularyAnnotation
• okclient\Model.InboundIDMethodByAttribute
• okclient\Model.InboundIDMethodByAttributeModifiers
• okclient\Model.InboundIDMethodByByUnion
• okclient\Model.InboundIDMethodByData
• okclient\Model.InboundIDMethodByIntersect
• okclient\Model.InboundIDMethodByRelatedTempID
• okclient\Model.InboundIDMethodByTemporaryCIID
• okclient\Model.NoFoundTargetCIHandling
• okclient\Model.ODataEntitySetInfo
• okclient\Model.ODataFunctionImportInfo
• okclient\Model.ODataServiceDocument
• okclient\Model.ODataSingletonInfo
• okclient\Model.ODataTypeAnnotation
• okclient\Model.ProblemDetails
• okclient\Model.SameTargetCIHandling
• okclient\Model.SameTempIDHandling
• okclient\Model.SparseRow

Documentation for Authorization

Authentication schemes defined for the API:

oauth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://[keycloak-url]/auth/realms/acme/protocol/openid-connect/auth
• Scopes: N/A