Skip to content

netorca_pack_profile_info - Query NetOrca Pack service profiles

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

Synopsis

  • Retrieve the pack profiles of your services - the per-service settings of the NetOrca Pack framework.
  • A pack profile carries the master switches (pack_enabled, universal_executor_enabled) and the knowledge-retrieval tuning that governs how the service's documents reach AI processor prompts - chunking, top_k, the cosine similarity threshold and the embedding model.
  • Each service has at most one profile; services without an explicit profile run on platform defaults, which resolved_for resolves for you.

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 pack profile with this ID.
If the ID does not exist, an empty list is returned.
resolved_for
int		 Return the effective profile of the service with this ID, with platform defaults applied.
This is the authoritative answer to "what settings does Pack actually run with for this service", whether or not a profile row was ever configured.
The platform materialises a default profile on first read of a service that has none, so this lookup can create the (default-valued) profile record server-side.
service_id
list / elements=int		 Filter by ID of the service the profiles belong to.

Common parameters

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

Parameter Comments
context
str		 Point of view for the request. The same query returns different data depending on which side of the service relationship your team is on.
serviceowner operates on the services your team offers - the requests made against them, their service items and deployed items. This is the side that validates, approves, deploys and completes changes.
consumer operates on what your team consumes - the service items your applications declared and the change instances tracking your own requests.
If not set, the value of the NETORCA_CONTEXT environment variable is used.
Choices: serviceowner, consumer
Default: serviceowner
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

  • 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: All pack profiles my team owns
  netautomate.netorca.netorca_pack_profile_info:
  register: profiles

- name: The effective Pack settings for one service (defaults applied)
  netautomate.netorca.netorca_pack_profile_info:
    resolved_for: 49
  register: effective

- name: Services with Pack switched on
  netautomate.netorca.netorca_pack_profile_info:
  register: profiles

- name: Report them
  ansible.builtin.debug:
    msg: >-
      pack runs on services
      {{ profiles.pack_profiles | selectattr('pack_enabled') | map(attribute='service') | list }}

Return values

count

Number of returned pack profiles.

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

pack_profiles

List of matching pack profiles as returned by the NetOrca API. service is the plain service ID.

  • Returned: always
  • Type: list / elements=dict
  • Sample:
[
  {
    "chunk_overlap": 0,
    "cosine_similarity_threshold": 0.8,
    "embedding_model": "all-MiniLM-L6-v2",
    "id": 22,
    "max_chars": 256,
    "max_lines": 10,
    "pack_enabled": true,
    "query_config": {},
    "return_all_documents": false,
    "service": 49,
    "top_k": 10,
    "universal_executor_enabled": false
  }
]

See also

Authors

  • NetAutomate (@netautomate)