List running servers

Lists all servers that are running for your app. You cannot modify servers directly using the CLI, but you can view information about them. To modify servers, you need to change the underlying deployment or configuration.

Usage#

odin fleet servers list

Examples#

List all servers in a table format:

odin fleet servers list

If you have defined an environment variable in the underlying configuration named SERVER_NAME you can use this command show a table of servers with the SERVER_NAME column:

odin fleet servers list --format="table(id,addr,env['SERVER_NAME'].value)"

Return a list of servers that are either ready and have a specific name, or have a specific ID:

odin fleet servers list --filter="(serverConfig.status = 'ready' AND serverConfig.name = 'Minecraft Production 2') OR id = 211"

Let’s create a CSV list with IP addresses, published game port (defined in the configuration with name Game Port), and the server name (defined in the configuration with name SERVER_NAME):

odin fleet servers list --format="value[separator=';'](addr,ports['Game Port'].publishedPort,env['SERVER_NAME'].value)"

This can be useful for creating a list of servers to use in a script or for monitoring.

Flags#

• --filter:
  An optional flag that filters the list of deployments. The filter expression follows a straightforward structure of <field> <operator> <value>. The field can be any property in the dataset, and operators include basic comparison operators such as =, !=, >, <, >=, and <=. Filters can also be combined using logical operators AND, OR, and negated with NOT. You can access nested fields using dot notation, and strings should be enclosed in quotes. Learn more about filters in our filters documentation.

Global Flags#