Houdini 17.5 Nodes TOP nodes

Shotgun Session TOP node

Start a session to connect to a Shotgun instance.

On this page

This node needs to be a parent node for all other Shotgun nodes, and sets up a connection to Shotgun for all of the other Shotgun nodes to use. It acts similarly to the command chain nodes.


Some minimal setup is required for using Shotgun. To use Shotgun, you must either have a Shotgun account on an active Shotgun instance and know the credentials, or have an active Shotgun API key and script name. You must also have the Shotgun Python API on your Houdini Python path.

Set the environment variables PDG_SHOTGUN_LOGIN to your Shotgun username and PDG_SHOTGUN_PASSWORD to your Shotgun password for user authentication. Set PDG_SHOTGUN_SCRIPT_NAME and PDG_SHOTGUN_API_KEY for API authentication. If both sets are provided, user authentication will take precedence.

This node requires the Shotgun Python API.



Shotgun URL

The URL at which you access your Shotgun instance.


These are advanced parameters that should only be changed if the defaults don’t work.

Use Custom Port

Enable the custom port for the internal Shotgun Session server.

Command Port

The Shotgun Session node starts a server under the hood to coordinate communication between all of the Shotgun nodes and Shotgun itself. Specify a custom port here for that server, in case of firewall restrictions or similar.

Work Item Generation

Whether this node generates static or dynamic work items. You should generally leave this set to "Automatic" unless you know the node’s work items can be computed statically, or that they need to be generated dynamically.


This node always creates dynamic work items: it waits until the upstream work items are known, and generates new work items from the upstream work items.


This node always creates static work items: it creates the number of work items it thinks it needs based on the parameters (and any upstream static items) before the network runs.


If the input is static (a static processor, or a partitioner with only static inputs, or a mapper), this node generates static work items, otherwise it generates dynamic work items.

See also

TOP nodes