Skip to content

netorca_llm_model_info - Query the LLM models configured in NetOrca Pack

Part of the netautomate.netorca collection (version 2.0.0). Added in version 2.0.0.

Synopsis

  • Retrieve the LLM models a NetOrca platform administrator has configured for the Pack framework - the model catalogue AI processors run on.
  • Each entry names a provider (OpenAI, Anthropic, Gemini, ...), the provider-side model, a platform-level system prompt, per-million-token pricing used for pipeline cost accounting, and the provider credentials in extra_data.
  • The catalogue is platform-global, so this module takes no context parameter.
  • Listing is read-only by design. The platform accepts LLM model writes (create, update, delete, connection tests) only from superuser GUI sessions - never from API keys - so this collection intentionally ships no write module for LLM models.

Requirements

The below requirements are needed on the host that executes this module.

  • netorca-sdk >= 1.0.9, < 2.0.0

Parameters

Parameter Comments
id
int		 Return only the LLM model with this ID.
If the ID does not exist, an empty list is returned.

Common parameters

Connection and query parameters shared by every module in the collection. See Authentication for the environment-variable pattern.

Parameter Comments
limit
int		 Maximum number of results to return.
Results are auto-paginated, so by default all matching records are returned regardless of the API's page size.
ordering
str		 Server-side field to order results by, for example created or modified.
Prefix with - for descending order - -modified returns the most recently changed records first.
api_url
str
required		 Base URL of the NetOrca API, for example https://api.example.netorca.io.
The URL is normalised to end in a single /v1, so passing it with or without the suffix both work.
If not set, the value of the NETORCA_API_URL environment variable is used.
api_key
str
required		 API key of your NetOrca team. The NetOrca API supports API-key authentication only - there is no username/password mode.
Treat the key like a password - supply it via the NETORCA_API_KEY environment variable (for example from a CI/CD secret) or from Ansible Vault, never as a literal in a playbook.
If not set, the value of the NETORCA_API_KEY environment variable is used.
validate_certs
bool		 Whether to validate TLS certificates when talking to the API.
Only disable this for lab instances with self-signed certificates.
If not set, the value of the NETORCA_VALIDATE_CERTS environment variable is used.
Default: true

Attributes

Attribute Support Description
check_mode full This module is read-only and runs identically with and without check mode.
diff_mode N/A This module never changes anything, so there is nothing to diff.

Notes

  • Provider credentials never reach your playbook. Every value under extra_data is replaced with the string REDACTED in the results (the platform additionally masks api_key server-side); the keys stay visible so you can verify a model's configuration shape.
  • All modules talk to the NetOrca REST API and are typically executed on the controller (hosts=localhost with gather_facts=false, or delegate_to=localhost).
  • Module parameters take precedence over their NETORCA_* environment variable fallbacks.
  • Info modules never change anything and always return changed=false.
  • When nothing matches - including a lookup by ID that does not exist - info modules return an empty list rather than failing.
  • Filter options that accept a list match records with any of the given values (an OR filter, the platform's in lookup).

Examples

- name: The platform's LLM model catalogue
  netautomate.netorca.netorca_llm_model_info:
  register: models

- name: One model by ID
  netautomate.netorca.netorca_llm_model_info:
    id: 8
  register: model

- name: Which providers are available to processors?
  ansible.builtin.debug:
    msg: "{{ models.llm_models | selectattr('is_active') | map(attribute='provider') | unique | list }}"

Return values

count

Number of returned LLM models.

  • Returned: always
  • Type: int
  • Sample:
1

llm_models

List of matching LLM models as returned by the NetOrca API. Every extra_data value is replaced with REDACTED; keys are preserved.

  • Returned: always
  • Type: list / elements=dict
  • Sample:
[
  {
    "extra_data": {
      "api_key": "REDACTED"
    },
    "id": 8,
    "input_price_per_1m_tokens": 10.0,
    "is_active": true,
    "metadata": {},
    "model_name": "claude-4-6",
    "name": "Claude 4.6",
    "output_price_per_1m_tokens": 14.0,
    "prompt": "Refer to serviceowner prompt first",
    "provider": "anthropic",
    "timeout": 60
  }
]

See also

Authors

  • NetAutomate (@netautomate)