topic Stopping and Starting Services in Portal via Python in ArcGIS API for Python Questions

Stopping and Starting Services in Portal via Python

Brian_McLeer — Sun, 12 Dec 2021 10:14:44 GMT

Trying to start/stop specific services. Using the article at How To: Stop GIS services using ArcGIS API for Python, I tried using the code but keep receiving an error message below posted code. I am running this script in IDLE (ArcGIS Pro). Using just IDLE for ArcGIS Desktop did not have the necessary modules.

from arcgis.gis import GIS
import arcgis.gis.admin
gis = GIS("https://url.to.com/portal", "Username", "Password", verify_cert=False)
services = gis_servers.services.list()
#To stop specific service(s)
for service in services:
 for service in server.services.list():
 if service.properties.serviceName == "SampleWorldCities":
 service.stop()‍‍‍‍‍‍‍‍‍

Error Message:

Traceback (most recent call last):
File "Z:\Temp\Brian\test.py", line 5, in <module>
services = gis_servers.services.list()
NameError: name 'gis_servers' is not defined

Re: Stopping and Starting Services in Portal via Python

JoshuaBixby — Wed, 08 Jan 2020 17:52:42 GMT

All your error message is stating is that you are using a variable, gis_servers, that has never been defined in your code. Look at the "full code" at the bottom on that page.

Re: Stopping and Starting Services in Portal via Python

Arne_Gelfert — Sun, 12 Dec 2021 10:14:47 GMT

Joshua is absolutely right. You need to get to the servers first.

If you don't use the Python API a lot, it can be a little confusing. I have to always refer to script I've used before. I had a snipped lying around... to turn on/off services.

from arcgis import gis

# I like this interactive way whenever possible instead of storing passwords
mygis = gis.GIS(<your_portal_path>, username='arcgis_python')

servers = mygis.admin.servers.list()
one_server = servers[0]

services_on_that_server = one_server.services.list()
one_of_those_services = services_on_that_server[0]

# provided your service is running to begin with
print(one_of_those_services.status)
one_of_those_services.stop()
print(one_of_those_services.status)
one_of_those_services.start()
print(one_of_those_services.status)‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

This gives me the following output:

{'configuredState': 'STARTED', 'realTimeState': 'STARTED'}
{'configuredState': 'STOPPED', 'realTimeState': 'STOPPED'}
{'configuredState': 'STARTED', 'realTimeState': 'STARTED'}‍‍‍

Re: Stopping and Starting Services in Portal via Python

MichaelVolz — Tue, 20 Apr 2021 17:08:58 GMT

Is the Portal path the portal home URL without the /home at the end?

Does the user specified need to be defined as an Administrator in your portal?

Did you need to clone your python environment and add a specific module to python to access the GIS module?

Re: Stopping and Starting Services in Portal via Python

Jen_Zumbado-Hannibal — Mon, 17 Oct 2022 21:49:53 GMT

Thanks @Arne_Gelfert this helped me more than: https://support.esri.com/en/technical-article/000019994

Re: Stopping and Starting Services in Portal via Python

AndresCastillo — Sat, 14 Dec 2024 08:05:51 GMT

These two articles also helped me accomplish stopping and starting services programatically:

https://developers.arcgis.com/python/latest/guide/managing-your-gis-servers/

https://developers.arcgis.com/rest/enterprise-administration/enterprise/service-status/

Re: Stopping and Starting Services in Portal via Python

AndreaB_ — Wed, 09 Apr 2025 15:58:13 GMT

@Arne_Gelfert do you know if you can query the realTimeState? something like

if one_of_those_services.status == "STARTED"

Thank you.

Re: Stopping and Starting Services in Portal via Python

AndreaB_ — Wed, 09 Apr 2025 19:08:54 GMT

Well, I was able to figure it out. I'll post here for others. Very helpful community post, thank you!

if one_of_those_services.status['realTimeState'] == "STARTED": print("yes")

Re: Stopping and Starting Services in Portal via Python

Arne_Gelfert — Wed, 09 Apr 2025 19:12:26 GMT

Good deal! 😀