starred/proxmoxer
1
0
Fork 0
mirror of https://github.com/proxmoxer/proxmoxer.git synced 2026-04-25 07:06:00 +03:00
Code Issues 19 Projects Releases 10 Packages Wiki Activity

[GH-ISSUE #212] Example Docs not working #121

New issue
Closed
opened 2026-02-27 15:46:32 +03:00 by kerem · 2 comments
kerem commented 2026-02-27 15:46:32 +03:00
Owner
Copy link

Originally created by @YaBoiMax on GitHub (Jun 25, 2025).
Original GitHub issue: https://github.com/proxmoxer/proxmoxer/issues/212

According to https://proxmoxer.github.io/docs/2.0/basic_usage/#dotted-notation I should be able to get a list of containers on all nodes like so:

>>> # get the list of all the nodes available from the connected node
>>> print(proxmox.nodes.get())
[{'type': 'node', 'node': 'example-node', 'ssl_fingerprint': '63:80:22:...:0D:12', 'id': 'node/example-node', 'status': 'unknown'}]
>>> # use the list of nodes to iterate through each and print the containers and their status
>>> for pve_node in proxmox.nodes.get():
...     print("{0}:".format(pve_node['node']))
...     for container in proxmox.nodes(pve_node['node']).lxc.get():
...         print("\t{0}. {1} => {2}".format(container['vmid'], container['name'], container['status']))
... 
example-node:
        100. container-a => running
        101. container-b => running
        105. container-c => running

However if I run

from proxmoxer import ProxmoxAPI
proxmox = ProxmoxAPI("proxmox.internal", port="443", user="root@pam", token_name="ansible", token_value="redacted", verify_ssl=True)

proxmox.nodes("node1").lxc.get()
for pve_node in proxmox.nodes.get():
  print("{0}:".format(pve_node['node']))
  for container in proxmox.nodes(pve_node['node']).lxc.get():
    print("\t{0}. {1} => {2}".format(container['vmid'], container['name'], container['status']))

I get

>>> from proxmoxer import ProxmoxAPI
>>> proxmox = ProxmoxAPI("proxmox.internal", port="443", user="root@pam", token_name="ansible", token_value="redacted", verify_ssl=True)
>>>
>>> proxmox.nodes("node1").lxc.get()
[]
>>> for pve_node in proxmox.nodes.get():
...   print("{0}:".format(pve_node['node']))
...   for container in proxmox.nodes(pve_node['node']).lxc.get():
...     print("\t{0}. {1} => {2}".format(container['vmid'], container['name'], container['status']))
...
node1:
node3:
node2:

Python3 Version:
Python 3.12.3
Proxmoxer Version:

>>> import proxmoxer
>>> print(proxmoxer.__version__)
2.0.1
Originally created by @YaBoiMax on GitHub (Jun 25, 2025). Original GitHub issue: https://github.com/proxmoxer/proxmoxer/issues/212 According to https://proxmoxer.github.io/docs/2.0/basic_usage/#dotted-notation I should be able to get a list of containers on all nodes like so: ``` >>> # get the list of all the nodes available from the connected node >>> print(proxmox.nodes.get()) [{'type': 'node', 'node': 'example-node', 'ssl_fingerprint': '63:80:22:...:0D:12', 'id': 'node/example-node', 'status': 'unknown'}] >>> # use the list of nodes to iterate through each and print the containers and their status >>> for pve_node in proxmox.nodes.get(): ... print("{0}:".format(pve_node['node'])) ... for container in proxmox.nodes(pve_node['node']).lxc.get(): ... print("\t{0}. {1} => {2}".format(container['vmid'], container['name'], container['status'])) ... example-node: 100. container-a => running 101. container-b => running 105. container-c => running ``` However if I run ``` from proxmoxer import ProxmoxAPI proxmox = ProxmoxAPI("proxmox.internal", port="443", user="root@pam", token_name="ansible", token_value="redacted", verify_ssl=True) proxmox.nodes("node1").lxc.get() for pve_node in proxmox.nodes.get(): print("{0}:".format(pve_node['node'])) for container in proxmox.nodes(pve_node['node']).lxc.get(): print("\t{0}. {1} => {2}".format(container['vmid'], container['name'], container['status'])) ``` I get ``` >>> from proxmoxer import ProxmoxAPI >>> proxmox = ProxmoxAPI("proxmox.internal", port="443", user="root@pam", token_name="ansible", token_value="redacted", verify_ssl=True) >>> >>> proxmox.nodes("node1").lxc.get() [] >>> for pve_node in proxmox.nodes.get(): ... print("{0}:".format(pve_node['node'])) ... for container in proxmox.nodes(pve_node['node']).lxc.get(): ... print("\t{0}. {1} => {2}".format(container['vmid'], container['name'], container['status'])) ... node1: node3: node2: ``` Python3 Version: `Python 3.12.3` Proxmoxer Version: ``` >>> import proxmoxer >>> print(proxmoxer.__version__) 2.0.1 ```
kerem closed this issue 2026-02-27 15:46:32 +03:00
kerem commented 2026-02-27 15:46:33 +03:00
Author
Owner
Copy link

@YaBoiMax commented on GitHub (Jun 25, 2025):

Upon further testing, using the paramiko backend, it works without error

>>> from proxmoxer import ProxmoxAPI
>>> proxmox = ProxmoxAPI('proxmox.internal', user='root', private_key_file='/root/.ssh/id_rsa', backend='ssh_paramiko')
>>>
>>> for pve_node in proxmox.nodes.get():
...   print("{0}:".format(pve_node['node']))
...   for container in proxmox.nodes(pve_node['node']).lxc.get():
...     print("\t{0}. {1} => {2}".format(container['vmid'], container['name'], container['status']))
...
node2:
	127. redacted => running
	123. redacted => running
	132. redacted => running
	147. redacted => stopped
	116. redacted => running
	118. redacted => running
	108. redacted => running
	129. redacted => running
	110. redacted => stopped
	120. redacted => running
	152. redacted => running
	126. redacted => running
node3:
node1:
	111. redacted => running
	122. redacted => running
	119. redacted => running
	121. redacted => running
	130. redacted => running
	114. redacted => running
	102. redacted => running
	128. redacted => stopped
	125. redacted => running
	141. redacted => stopped
	124. redacted => running
	131. redacted => running
<!-- gh-comment-id:3004052469 --> @YaBoiMax commented on GitHub (Jun 25, 2025): Upon further testing, using the paramiko backend, it works without error ``` >>> from proxmoxer import ProxmoxAPI >>> proxmox = ProxmoxAPI('proxmox.internal', user='root', private_key_file='/root/.ssh/id_rsa', backend='ssh_paramiko') >>> >>> for pve_node in proxmox.nodes.get(): ... print("{0}:".format(pve_node['node'])) ... for container in proxmox.nodes(pve_node['node']).lxc.get(): ... print("\t{0}. {1} => {2}".format(container['vmid'], container['name'], container['status'])) ... node2: 127. redacted => running 123. redacted => running 132. redacted => running 147. redacted => stopped 116. redacted => running 118. redacted => running 108. redacted => running 129. redacted => running 110. redacted => stopped 120. redacted => running 152. redacted => running 126. redacted => running node3: node1: 111. redacted => running 122. redacted => running 119. redacted => running 121. redacted => running 130. redacted => running 114. redacted => running 102. redacted => running 128. redacted => stopped 125. redacted => running 141. redacted => stopped 124. redacted => running 131. redacted => running ```
kerem commented 2026-02-27 15:46:33 +03:00
Author
Owner
Copy link

@YaBoiMax commented on GitHub (Jun 25, 2025):

Upon even further testing it seems I oversaw that my API key had Privilege Separation enabled and I had no ACLs for it configured. Disabling the Privilege Separation or setting proper ACLs fixes the issue.

<!-- gh-comment-id:3004484140 --> @YaBoiMax commented on GitHub (Jun 25, 2025): Upon even further testing it seems I oversaw that my API key had Privilege Separation enabled and I had no ACLs for it configured. Disabling the Privilege Separation or setting proper ACLs fixes the issue.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
develop
master
release/2.3.0
develop-1.x
2.3.0
2.2.0
2.1.0
2.0.1
2.0.0
1.3.1
1.3.0
1.2.0
1.1.1
1.1.0
1.0.4
1.0.3
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
Labels
Clear labels   
backend:https

   
backend:local

   
backend:openssh

   
backend:ssh_paramiko

   
pull-request

Mirrored from GitHub Pull Request

  
status:ansible-issue

   
status:help-wanted

   
status:info-needed

   
status:proxmox-issue

   
status:review-needed

   
type:bug 🐞

   
type:dependency ⛓️

   
type:docs 📝

   
type:enhancement ⏫

   
type:maintenance 🛠️

   
type:meta

   
type:question ❓

   
type:request ✋

   
type:testing 🧪

   
version:1.x

   
version:latest

   
version:py2

   
version:py3
No labels
backend:https
backend:local
backend:openssh
backend:ssh_paramiko
pull-request
status:ansible-issue
status:help-wanted
status:info-needed
status:proxmox-issue
status:review-needed
type:bug 🐞
type:dependency ⛓️
type:docs 📝
type:enhancement ⏫
type:maintenance 🛠️
type:meta
type:question ❓
type:request ✋
type:testing 🧪
version:1.x
version:latest
version:py2
version:py3
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/proxmoxer#121
No description provided.