Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Update Job.nodelist description #3155

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions reframe/core/schedulers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -512,22 +512,23 @@ def state(self):
def nodelist(self):
'''The list of node names assigned to this job.

This attribute is supported by the ``local``, ``pbs``, ``slurm``,
``squeue``, ``ssh``, and ``torque`` scheduler backends.

This attribute is :class:`None` if no nodes are assigned to the job
yet.
This attribute is set reliably only for the ``slurm`` backend, i.e.,
Slurm *with* accounting enabled.

The ``squeue`` scheduler backend, i.e., Slurm *without* accounting,
might not set this attribute for jobs that finish very quickly.
For the ``local`` scheduler backend, this returns an one-element list

For the ``local`` scheduler backend, this returns a one-element list
containing the hostname of the current host.

This attribute might be useful in a flexible regression test for
determining the actual nodes that were assigned to the test.
For more information on flexible node allocation, see the
:option:`--flex-alloc-nodes` command-line option.

This attribute is *not* supported by the ``pbs`` scheduler backend.

.. versionadded:: 2.17

:type: :class:`List[str]` or :class:`None`
Expand Down
Loading